如何在使用 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: 用於儲存字串的「資料夾」,例如你網站的網址。 在此閱讀更多關於 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。
將客戶端放在獨立的檔案中會讓日後更容易重複使用。現在,我們將在自訂的 /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 應用程式就會自動被翻譯。請注意,只有在 API 金鑰上具有 read/write 權限的環境才能建立新的字串以供翻譯。我們建議設置一個封閉且安全的暫存環境,在那裡使用類似的 API 金鑰測試您的生產應用程式,並在上線前新增字串。這能防止任何人竊取您的祕密 API 金鑰,並避免有人新增不相關的字串而可能使您的翻譯專案膨脹。
務必到我們的 GitHub 範例中查看完整範例。在那裡,你還會找到使用 App Router 的範例!如果遇到任何問題,歡迎隨時聯絡我們,我們會很樂意協助。
TacoTranslate 讓你自動快速地將 React 應用程式在超過 75 種語言之間進行本地化。 立即開始!