如何在使用 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 使用最先进的人工智能将你的字符串自动翻译为任意语言,免去了繁琐的 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。 在此处了解有关来源的更多信息。
TACOTRANSLATE_DEFAULT_LOCALE=en
TACOTRANSLATE_ORIGIN=your-website-url.com
第 3 步: 设置 TacoTranslate
要将 TacoTranslate 集成到您的应用程序中,您需要使用之前的 API 密钥创建一个客户端。例如,创建一个名为 /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
检查以适配您的设置。If true
, TacoTranslate 将公开公共 API 密钥。如果我们处于本地、测试或预发布环境(isProduction
is false
),我们将使用秘密 read/write
API 密钥以确保新的字符串被发送进行翻译。
到目前为止,我们只是为 Next.js 应用程序设置了受支持语言的列表。接下来我们要为所有页面获取翻译。为此,你将根据需求使用 getTacoTranslateStaticProps
或 getTacoTranslateServerSideProps
。
这些函数接受三个参数:一个 Next.js Static Props Context 对象,用于 TacoTranslate 的配置,以及可选的 Next.js 属性。请注意, revalidate
在 getTacoTranslateStaticProps
上默认设置为 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 应用现在将自动进行翻译。请注意,只有在 API 密钥上具有 read/write
权限的环境才能创建新的待翻译字符串。我们建议准备一个封闭且安全的预发布(staging)环境,在那里使用这样的 API 密钥测试你的生产应用,并在上线前添加新的字符串。这将防止任何人任何人窃取你的秘密 API 密钥,并可能通过添加新的、不相关的字符串而使你的翻译项目膨胀。
务必 查看完整示例,就在我们的 GitHub 资料页。那里,你还能找到一个使用 App Router 完成此操作的示例!如果遇到任何问题,请随时 联系我们,我们将非常乐意提供帮助。
TacoTranslate 可让您自动将 React 应用快速本地化到 75 多种语言并进行双向翻译。 立即开始!