如何在使用 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 keys 分頁。建立一個 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 屬性。請注意,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 步: 部署並測試!
我們完成了!你的 React 應用程式現在會在你將任何字串加入到 Translate
元件時自動翻譯。請注意,只有擁有 API 金鑰 read/write
權限的環境才能建立要翻譯的新字串。我們建議設置一個封閉且安全的暫存環境,在那裡使用這類 API 金鑰來測試你的生產應用程式,並在上線前先新增字串。這樣可以防止任何人任何人竊取你的秘密 API 金鑰,並避免透過新增不相關的字串讓你的翻譯專案膨脹。
務必在我們的 GitHub 頁面上查看完整範例。在那裡,你也會找到一個使用 App Router 的範例!如果遇到任何問題,歡迎與我們聯絡,我們會很樂意協助你。
TacoTranslate 可自動將你的 React 應用程式快速地在超過 75 種語言之間進行本地化。 立即開始!