如何在使用 Pages Router 的 Next.js 應用程式中實作國際化
讓您的 React 應用程式更易於使用,並透過國際化 (i18n) 開拓新市場。
隨著世界日益全球化,對於網頁開發者而言,開發能夠滿足來自不同國家和文化使用者需求的應用程式變得越來越重要。實現這一目標的主要方法之一是國際化(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
為了將 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
。
把 client 放在單獨的檔案中,之後要再使用時會更方便。現在,使用自訂的 /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!"/>;
}
您現在應該可以使用 Translate
元件,在所有 React 元件中翻譯字串。
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 種語言之間進行本地化。 立即開始!