开始使用 Intlayer 和 Next.js 进行国际化 (i18n)
什么是 Intlayer？
Intlayer 是一个创新的开源国际化 (i18n) 库，旨在简化现代 web 应用程序的多语言支持。Intlayer 无缝集成最新的 Next.js 框架，包括其传统的 Page Router。
使用 Intlayer，您可以：
- 轻松管理翻译，使用声明性字典在组件级别进行管理。
- 动态本地化元数据、路由和内容。
- 确保 TypeScript 支持，提供自动生成的类型，提高自动补全和错误检测能力。
- 享受高级功能，如动态语言检测和切换。
Intlayer 兼容 Next.js 12、13、14 和 15。如果您使用 Next.js App Router，请参阅 App Router 指南。对于 Next.js 15，请遵循本 指南。
在使用 Page Router 的 Next.js 应用程序中设置 Intlayer 的逐步指南
第 1 步：安装依赖项
使用您喜欢的包管理工具安装必需的包：
npm install intlayer next-intlayerintlayer
next-intlayer
将 Intlayer 与 Next.js 集成的包。它提供了用于 Next.js 国际化的上下文提供程序和钩子。此外，它还包括用于将 Intlayer 与 Webpack 或 Turbopack 集成的 Next.js 插件，以及用于检测用户的首选语言、管理 cookies 和处理 URL 重定向的中间件。
第 2 步：配置您的项目
创建一个配置文件来定义您的应用程序支持的语言：
import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { internationalization: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, // 在此处添加其他语言 ], defaultLocale: Locales.ENGLISH, },};export default config;通过此配置文件，您可以设置本地化 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表，请参阅 配置文档。
第 3 步：将 Intlayer 集成到 Next.js 配置中
修改您的 Next.js 配置以集成 Intlayer：
import { withIntlayer } from "next-intlayer/server";/** @type {import('next').NextConfig} */const nextConfig = { // 您现有的 Next.js 配置};export default withIntlayer(nextConfig);withIntlayer() Next.js 插件用于将 Intlayer 与 Next.js 集成。它确保构建内容声明文件并在开发模式下监控它们。它在 Webpack 或 Turbopack 环境中定义 Intlayer 环境变量。此外，它还提供别名以优化性能，并确保与服务器组件的兼容性。
第 4 步：配置中间件以检测语言
设置中间件以自动检测和处理用户的首选语言：
export { intlayerMiddleware as middleware } from "next-intlayer/middleware";export const config = { matcher: "/((?!api|static|assets|robots|sitemap|sw|service-worker|manifest|.*\\..*|_next).*)",};调整 matcher 参数以匹配您应用程序的路由。有关更多细节，请参阅 Next.js 文档关于配置匹配器。
第 5 步：定义动态语言路由
实现动态路由以根据用户的语言提供本地化内容。
创建特定于语言的页面：
将您的主页文件重命名为包含 [locale] 动态片段。
bashmv src/pages/index.tsx src/pages/[locale]/index.tsx更新 _app.tsx 以处理本地化：
修改您的 _app.tsx 以包括 Intlayer 提供程序。
src/pages/_app.tsximport type { FC } from "react";import type { AppProps } from "next/app";import { IntlayerClientProvider } from "next-intlayer";const App: FC<AppProps> = ({ Component, pageProps }) => { const { locale } = pageProps; return ( <IntlayerClientProvider locale={locale}> <Component {...pageProps} /> </IntlayerClientProvider> );};export default MyApp;设置 getStaticPaths 和 getStaticProps：
在您的 [locale]/index.tsx 中，定义路径和属性以处理不同的语言。
src/pages/[locale]/index.tsximport type { FC } from "react";import type { GetStaticPaths, GetStaticProps } from "next";import { type Locales, getConfiguration } from "intlayer";const HomePage: FC = () => <div>{/* 您的内容在这里 */}</div>;export const getStaticPaths: GetStaticPaths = () => { const { internationalization } = getConfiguration(); const { locales } = internationalization; const paths = locales.map((locale) => ({ params: { locale }, })); return { paths, fallback: false };};export const getStaticProps: GetStaticProps = ({ params }) => { const locale = params?.locale as string; return { props: { locale, }, };};export default HomePage;
getStaticPaths 和 getStaticProps 确保您的应用程序在 Next.js Page Router 中预构建所有语言所需的页面。这种方法减少了运行时计算，从而改善了用户体验。有关更多详细信息，请参阅 Next.js 文档关于 getStaticPaths 和 getStaticProps。
第 6 步：声明您的内容
创建和管理您的内容声明以存储翻译。
import { t, type DeclarationContent } from "intlayer";const homeContent = { key: "home", content: { title: t({ en: "Welcome to My Website", fr: "Bienvenue sur mon site Web", es: "Bienvenido a mi sitio web", }), description: t({ en: "Get started by editing this page.", fr: "Commencez par éditer cette page.", es: "Comience por editar esta página.", }), },} satisfies DeclarationContent;export default homeContent;有关声明内容的更多信息，请参阅 内容声明指南。
第 7 步：在您的代码中使用内容
在您的应用程序中访问内容字典以显示翻译的内容。
import type { FC } from "react";import { useIntlayer } from "next-intlayer";import { ComponentExample } from "@components/ComponentExample";const HomePage: FC = () => { const content = useIntlayer("home"); return ( <div> <h1>{content.title}</h1> <p>{content.description}</p> <ComponentExample /> {/* 额外组件 */} </div> );};// ... 其余代码，包括 getStaticPaths 和 getStaticPropsexport default HomePage;import type { FC } from "react";import { useIntlayer } from "next-intlayer";export const ComponentExample: FC = () => { const content = useIntlayer("component-example"); // 确保您有相应的内容声明 return ( <div> <h2>{content.title}</h2> <p>{content.content}</p> </div> );};在 string 属性中使用翻译时（例如 alt、title、href、aria-label），按以下方式调用函数值：
jsx<img src={content.image.src.value} alt={content.image.value} />
要了解更多关于 useIntlayer 钩子的内容，请参阅 文档。
（可选）第 8 步：国际化您的元数据
要国际化页面标题和描述等元数据，请在 getStaticProps 函数中结合使用 Intlayer 的 getTranslationContent 函数。
import { GetStaticPaths, GetStaticProps } from "next";import { type IConfigLocales, getTranslationContent, Locales } from "intlayer";import { useIntlayer } from "next-intlayer";interface HomePageProps { locale: string; metadata: Metadata;}const HomePage = ({ metadata }: HomePageProps) => { // 元数据可以在头部或其他组件中使用 return ( <div> <Head> <title>{metadata.title}</title> <meta name="description" content={metadata.description} /> </Head> {/* 额外内容 */} </div> );};export const getStaticProps: GetStaticProps = async ({ params }) => { const locale = params?.locale as string; const t = <T,>(content: IConfigLocales<T>) => getTranslationContent(content, locale); const metadata = { title: t({ en: "My Website", fr: "Mon Site Web", es: "Mi Sitio Web", }), description: t({ en: "Welcome to my website.", fr: "Bienvenue sur mon site Web.", es: "Bienvenido a mi sitio web.", }), }; return { props: { locale, metadata, }, };};export default HomePage;// ... 其余代码，包括 getStaticPaths（可选）第 9 步：更改内容的语言
为了允许用户动态切换语言，使用 useLocale 钩子提供的 setLocale 函数。
import { Locales, getHTMLTextDir, getLocaleName, getLocalizedUrl,} from "intlayer";import { useLocalePageRouter } from "next-intlayer";import { type FC } from "react";const LocaleSwitcher: FC = () => { const { locale, pathWithoutLocale, availableLocales, setLocale } = useLocalePageRouter(); return ( <ol> {availableLocales.map((localeItem) => ( <li key={localeItem}> <a href={getLocalizedUrl(pathWithoutLocale, localeItem)} hrefLang={localeItem} aria-current={locale === localeItem ? "page" : undefined} onClick={(e) => { e.preventDefault(); setLocale(localeItem); }} > <span> {/* 语言以其本地语言显示 - 例如 Français */} {getLocaleName(localeItem, locale)} </span> <span dir={getHTMLTextDir(localeItem)} lang={localeItem}> {/* 当前语言的名称 - 例如 Francés (当前语言设置为 Locales.SPANISH) */} {getLocaleName(localeItem)} </span> <span dir="ltr" lang={Locales.ENGLISH}> {/* 以英语显示的语言 - 例如 French */} {getLocaleName(localeItem, Locales.ENGLISH)} </span> <span> {/* 语言以其本地代码显示 - 例如 FR */} {localeItem} </span> </a> </li> ))} </ol> );};useLocalePageRouter API 与 useLocale 相同。要了解更多关于 useLocale 钩子的内容，请参阅 文档。
文档参考：
TypeScript 优势的示例：
Git 配置
为了保持您的代码库整洁并避免提交生成的文件，建议忽略 Intlayer 创建的文件。
将以下行添加到您的 .gitignore 文件中：
# 忽略 Intlayer 生成的文件.intlayer其他资源
通过遵循本指南，您可以有效地将 Intlayer 集成到您的 Next.js 应用程序中，使用 Page Router，为您的 web 项目启用强大且可扩展的国际化支持。
如果您有改善此文档的想法，请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接