如何在使用 Pages Router 的 Next.js 应用程序中实现国际化
通过国际化(i18n)让您的 React 应用更易访问,并开拓新市场。
随着世界变得越来越全球化,网络开发者构建能够满足来自不同国家和文化的用户需求的应用程序变得越来越重要。实现这一目标的关键方法之一是国际化(i18n),它允许您将应用程序适配到不同的语言、货币和日期格式。
在本教程中,我们将探讨如何为您的 React Next.js 应用程序添加国际化功能,并支持服务器端渲染。 TL;DR: 在这里查看完整示例。
本指南适用于使用 Pages Router 的 Next.js 应用程序。
如果您使用的是 App Router,请参阅此指南。
步骤 1: 安装一个 i18n 库
要在您的 Next.js 应用中实现国际化,首先我们将选择一个 i18n 库。有几个流行的库,包括 next-intl。然而,在本示例中,我们将使用 TacoTranslate。
TacoTranslate 使用最先进的 AI 自动将您的字符串翻译成任何语言,解放您摆脱繁琐的 JSON 文件管理。
让我们在终端中使用 npm 进行安装:
npm install tacotranslate
步骤 2: 创建一个免费的 TacoTranslate 账户
现在您已经安装了该模块,是时候创建您的 TacoTranslate 账户、翻译项目和相关的 API 密钥了。在这里创建账户。 免费注册,且 无需添加信用卡。
在 TacoTranslate 应用程序的用户界面中,创建一个项目,导航到其 API 密钥标签。创建一个 read
密钥和一个 read/write
密钥。我们将它们保存为环境变量。 read
密钥称为 public
密钥,而 read/write
密钥称为 secret
密钥。例如,你可以将它们添加到项目根目录下的 .env
文件中。
TACOTRANSLATE_PUBLIC_API_KEY=123456
TACOTRANSLATE_SECRET_API_KEY=789010
务必绝不将秘密 read/write
API 密钥泄露到客户端生产环境。
我们还将添加两个环境变量:TACOTRANSLATE_DEFAULT_LOCALE
和 TACOTRANSLATE_ORIGIN
。
TACOTRANSLATE_DEFAULT_LOCALE
:默认的回退语言代码。在此示例中,我们将其设置为en
代表英语。TACOTRANSLATE_ORIGIN
:存储您的字符串的“文件夹”,例如您网站的 URL。在这里了解有关 origins 的更多信息。
TACOTRANSLATE_DEFAULT_LOCALE=en
TACOTRANSLATE_ORIGIN=your-website-url.com
步骤 3: 设置 TacoTranslate
To integrate TacoTranslate with your application, you’ll need to create a client using the API keys from earlier. For example, create a file named /tacotranslate-client.js
.
const {default: createTacoTranslateClient} = require('tacotranslate');
const tacoTranslate = createTacoTranslateClient({
apiKey:
process.env.TACOTRANSLATE_SECRET_API_KEY ??
process.env.TACOTRANSLATE_PUBLIC_API_KEY ??
process.env.TACOTRANSLATE_API_KEY ??
'',
projectLocale: process.env.TACOTRANSLATE_DEFAULT_LOCALE ?? '',
});
module.exports = tacoTranslate;
我们将很快自动定义 TACOTRANSLATE_API_KEY
。
在一个单独的文件中创建客户端,使得以后更容易再次使用。现在,使用自定义的 /pages/_app.tsx
,我们将添加 TacoTranslate
提供器。
import React from 'react';
import {type AppProps} from 'next/app';
import {type Origin, type Locale, type Localizations} from 'tacotranslate';
import TacoTranslate from 'tacotranslate/react';
import TacoTranslateHead from 'tacotranslate/next/head';
import tacoTranslate from '../tacotranslate-client';
type PageProperties = {
origin: Origin;
locale: Locale;
locales: Locale[];
localizations: Localizations;
};
export default function App({Component, pageProps}: AppProps<PageProperties>) {
const {origin, locale, locales, localizations} = pageProps;
return (
<TacoTranslate
client={tacoTranslate}
origin={origin}
locale={locale}
localizations={localizations}
>
<TacoTranslateHead rootUrl="https://your-website.com" locales={locales} />
<Component {...pageProps} />
</TacoTranslate>
);
}
如果您已经有自定义的 pageProps
和 _app.tsx
,请根据上述内容扩展它们的定义和代码。
步骤 4: 实现服务器端渲染
TacoTranslate 支持对您的翻译进行服务器端渲染。这大大提升了用户体验,因为它能立即显示翻译后的内容,而不是先显示一闪而过的未翻译内容。此外,我们还能跳过客户端的网络请求,因为我们已经拥有了所需的所有翻译内容。
我们将从创建或修改 /next.config.js
开始。
const withTacoTranslate = require('tacotranslate/next/config').default;
const tacoTranslateClient = require('./tacotranslate-client');
module.exports = async () => {
const config = {};
return withTacoTranslate(config, {
client: tacoTranslateClient,
isProduction:
process.env.TACOTRANSLATE_ENV === 'production' ||
process.env.VERCEL_ENV === 'production' ||
(!(process.env.TACOTRANSLATE_ENV || process.env.VERCEL_ENV) &&
process.env.NODE_ENV === 'production'),
});
};
修改 isProduction
检查以适合您的设置。如果 true
,TacoTranslate 将显示公有 API 密钥。如果我们在本地、测试或暂存环境 (isProduction
is false
) 中,我们将使用密钥 read/write
API 密钥来确保发送新字符串进行翻译。
到目前为止,我们只为Next.js应用程序设置了支持的语言列表。接下来我们要做的是获取所有页面的翻译。为此,您将根据您的要求使用 getTacoTranslateStaticProps
或 getTacoTranslateServerSideProps
。
这些函数采用三个参数:一个 Next.js Static Props Context 对象、TacoTranslate 的配置和可选的 Next.js 属性。请注意,getTacoTranslateStaticProps
revalidate
默认设置为 60,以便您的翻译保持最新。
要在页面中使用任一函数,假设您有一个类似于 /pages/hello-world.tsx
的页面文件。
import {Translate} from 'tacotranslate/react';
import getTacoTranslateStaticProps from 'tacotranslate/next/get-static-props';
import tacoTranslateClient from '../tacotranslate-client';
export async function getStaticProps(context) {
return getTacoTranslateStaticProps(context, {client: tacoTranslateClient});
}
export default function Page() {
return <Translate string="Hello, world!"/>;
}
您现在应该能够在所有 React 组件中使用 Translate
组件来翻译字符串。
import {Translate} from 'tacotranslate/react';
function Component() {
return <Translate string="Hello, world!"/>
}
第5步: 部署并测试!
我们完成了!当你在 Translate
组件中添加任何字符串时,你的 React 应用将自动进行翻译。请注意,只有拥有 read/write
权限的 API 密钥环境才能创建新的待翻译字符串。我们建议你拥有一个封闭且安全的预发布环境,在那里可以使用这样的 API 密钥测试你的生产应用,并在上线前添加新的字符串。这样可以防止任何人窃取你的秘密 API 密钥,并避免通过添加新的无关字符串而使翻译项目膨胀。
务必查看我们 GitHub 资料中的完整示例。在那里,您还会找到使用 App Router 的示例!如果遇到任何问题,欢迎随时联系我们,我们将非常乐意为您提供帮助。
TacoTranslate 让您能够快速自动地将 React 应用程序本地化到任何语言并从任何语言本地化。今天就开始吧!