开始使用 Intlayer 和 Next.js 15 应用程序路由进行国际化 (i18n)
什么是 Intlayer？
Intlayer 是一个创新的开源国际化 (i18n) 库，旨在简化现代网页应用程序中的多语言支持。Intlayer 与最新的 Next.js 15 框架无缝集成，包括其强大的 App Router。它经过优化以支持 Server Components 进行高效渲染，并与 Turbopack 完全兼容。
使用 Intlayer，您可以：
- 轻松管理翻译，使用声明式字典在组件级别。
- 动态本地化元数据、路由和内容。
- 在客户端和服务器组件中访问翻译。
- 确保 TypeScript 支持，提供自动生成的类型，改善自动补全和错误检测。
- 享受高级功能，如动态语言检测和切换。
Intlayer 与 Next.js 12、13、14 和 15 兼容。如果您正在使用 Next.js 页面路由，可以参考此 指南。对于 Next.js 12、13、14 以及 App Router，请参考此 指南。
在 Next.js 应用程序中设置 Intlayer 的逐步指南
第 1 步：安装依赖
使用 npm 安装必要的包：
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 步：在您的 Next.js 配置中集成 Intlayer
配置您的 Next.js 设置以使用 Intlayer：
import { withIntlayer } from "next-intlayer/server";/** @type {import('next').NextConfig} */const nextConfig = {};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).*)",};intlayerMiddleware 用于检测用户的首选语言，并根据 配置 将用户重定向到相应的 URL。此外，它还能够将用户的首选语言保存在 cookie 中。
第 5 步：定义动态语言路由
将 RootLayout 中的所有内容删除，并用以下代码替换：
import type { PropsWithChildren, FC } from "react";import "./globals.css";const RootLayout: FC<PropsWithChildren> = ({ children }) => children;export default RootLayout;要实现动态路由，通过在您的 [locale] 目录中添加新的布局来提供语言路径：
import type { NextLayoutIntlayer } from "next-intlayer";import { Inter } from "next/font/google";import { getHTMLTextDir } from "intlayer";const inter = Inter({ subsets: ["latin"] });const LocaleLayout: NextLayoutIntlayer = async ({ children, params }) => { const { locale } = await params; return ( <html lang={locale} dir={getHTMLTextDir(locale)}> <body className={inter.className}>{children}</body> </html> );};export default LocaleLayout;[locale] 路径段用于定义语言。例如：/en-US/about 将引用 en-US，/fr/about 将引用 fr。
然后，在您的应用程序布局中实现 generateStaticParams 功能。
export { generateStaticParams } from "next-intlayer"; // 插入的行const LocaleLayout: NextLayoutIntlayer = async ({ children, params }) => { /*... 其余代码*/};export default LocaleLayout;generateStaticParams 确保您的应用程序为所有语言预生成必要的页面，减少运行时计算，提高用户体验。有关详细信息，请参阅 Next.js 的 generateStaticParams 文档。
第 6 步：声明您的内容
创建和管理您的内容声明以存储翻译：
import { t, type DeclarationContent } from "intlayer";const pageContent = { key: "page", content: { getStarted: { main: t({ en: "Get started by editing", fr: "Commencez par éditer", es: "Comience por editar", }), pageLink: "src/app/page.tsx", }, },} satisfies DeclarationContent;export default pageContent;您的内容声明可以在应用程序中的任何位置定义，只要它们包含在 contentDir 目录中（默认情况下为 ./src）。并且与内容声明文件扩展名匹配（默认情况下为 .content.{ts,tsx,js,jsx,mjs,cjs}）。 有关更多详细信息，请参考 内容声明文档。
第 7 步：在代码中使用内容
在您的应用程序中访问内容字典：
import type { FC } from "react";import { ClientComponentExample } from "@components/ClientComponentExample";import { ServerComponentExample } from "@components/ServerComponentExample";import { type NextPageIntlayer, IntlayerClientProvider } from "next-intlayer";import { IntlayerServerProvider, useIntlayer } from "next-intlayer/server";const PageContent: FC = () => { const { title, content } = useIntlayer("page"); return ( <> <p>{content.getStarted.main}</p> <code>{content.getStarted.pageLink}</code> </> );};const Page: NextPageIntlayer = async ({ params }) => { const { locale } = await params; return ( <> <IntlayerServerProvider locale={locale}> <PageContent /> <ServerComponentExample /> <IntlayerClientProvider locale={locale}> <ClientComponentExample /> </IntlayerClientProvider> </IntlayerServerProvider> </> );};export default Page;- IntlayerClientProvider 用于为客户端组件提供语言。它可以放置在任何父组件中，包括布局。然而，建议将其放在布局中，因为 Next.js 在页面之间共享布局代码，从而提高效率。通过在布局中使用 IntlayerClientProvider，您可以避免为每个页面重新初始化它，从而提高性能并在整个应用程序中保持一致的本地化上下文。
- IntlayerServerProvider 用于为服务器子组件提供语言。它不能在布局中设置。
布局和页面不能共享相同的服务器上下文，因为服务器上下文系统是基于每请求数据存储（通过 React 的缓存 机制），导致每个"上下文"在应用程序不同部分被重新创建。将提供者放在共享布局中会破坏这种隔离，阻止服务器上下文值正确传播到您的服务器组件。
"use client";import type { FC } from "react";import { useIntlayer } from "next-intlayer";export const ClientComponentExample: FC = () => { const content = useIntlayer("client-component-example"); // 创建相关的内容声明 return ( <div> <h2>{content.title} </h2> <p>{content.content}</p> </div> );};import type { FC } from "react";import { useIntlayer } from "next-intlayer/server";export const ServerComponentExample: FC = () => { const content = useIntlayer("server-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 步：国际化您的元数据
如果您想要国际化您的元数据，例如页面的标题，可以使用 Next.js 提供的 generateMetadata 函数。在函数内部使用 getTranslationContent 函数翻译您的元数据。
import { type IConfigLocales, getTranslationContent, getMultilingualUrls,} from "intlayer";import type { Metadata } from "next";import type { LocalPromiseParams } from "next-intlayer";export const generateMetadata = async ({ params: { locale },}: LocalPromiseParams): Metadata => { const { locale } = await params; const t = <T>(content: IConfigLocales<T>) => getTranslationContent(content, locale); /** * 生成一个对象，包含每个语言的所有网址。 * * 示例： * ```ts * getMultilingualUrls('/about'); * * // 返回 * // { * // en: '/about', * // fr: '/fr/about', * // es: '/es/about', * // } * ``` */ const multilingualUrls = getMultilingualUrls("/"); return { title: t<string>({ en: "My title", fr: "Mon titre", es: "Mi título", }), description: t({ en: "My description", fr: "Ma description", es: "Mi descripción", }), alternates: { canonical: "/", languages: { ...multilingualUrls, "x-default": "/" }, }, openGraph: { url: multilingualUrls[locale], }, };};// ... 其余代码要了解有关元数据优化的更多信息，请参考 Next.js 官方文档。
（可选）第 9 步：国际化您的 sitemap.xml 和 robots.txt
要国际化您的 sitemap.xml 和 robots.txt，您可以使用 Intlayer 提供的 getMultilingualUrls 函数。此函数允许您为您的 sitemap 生成多语言 URL。
import { getMultilingualUrls } from "intlayer";import type { MetadataRoute } from "next";const sitemap = (): MetadataRoute.Sitemap => [ { url: "https://example.com", alternates: { languages: getMultilingualUrls("https://example.com"), }, }, { url: "https://example.com/login", alternates: { languages: getMultilingualUrls("https://example.com/login"), }, }, { url: "https://example.com/register", alternates: { languages: getMultilingualUrls("https://example.com/register"), }, },];export default sitemap;import type { MetadataRoute } from "next";import { getMultilingualUrls } from "intlayer";const getAllMultilingualUrls = (urls: string[]) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]);const robots = (): MetadataRoute.Robots => ({ rules: { userAgent: "*", allow: ["/"], disallow: getAllMultilingualUrls(["/login", "/register"]), }, host: "https://example.com", sitemap: `https://example.com/sitemap.xml`,});export default robots;要了解有关 sitemap 优化的更多信息，请参阅 Next.js 官方文档。要了解有关 robots.txt 优化的更多信息，请参阅 Next.js 官方文档。
（可选）第 10 步：更改内容的语言
要更改内容的语言，您可以使用 useLocale 钩子提供的 setLocale 函数。此函数允许您设置应用程序的语言并相应更新内容。
"use client";import type { FC } from "react";import { Locales, getHTMLTextDir, getLocaleName, getLocalizedUrl,} from "intlayer";import { useLocale } from "next-intlayer";import Link from "next/link";export const LocaleSwitcher: FC = () => { const { locale, pathWithoutLocale, availableLocales, setLocale } = useLocale(); return ( <ol> {availableLocales.map((localeItem) => ( <li key={localeItem}> <Link href={getLocalizedUrl(pathWithoutLocale, localeItem)} hrefLang={localeItem} aria-current={locale === localeItem ? "page" : undefined} onClick={(e) => { e.preventDefault(); setLocale(localeItem); }} > <span> {/* 语言在其本地语言中 - 例如法语 */} {getLocaleName(localeItem, locale)} </span> <span dir={getHTMLTextDir(localeItem)} lang={localeItem}> {/* 当前语言的语言 - 例如西班牙语，当当前语言设置为 Locales.SPANISH */} {getLocaleName(localeItem)} </span> <span dir="ltr" lang={Locales.ENGLISH}> {/* 英文中的语言 - 例如法语 */} {getLocaleName(localeItem, Locales.ENGLISH)} </span> <span> {/* 语言在其本地语言中 - 例如法语缩写 */} {localeItem} </span> </Link> </li> ))} </ol> );};文档参考：
配置 TypeScript
Intlayer 使用模块扩展来利用 TypeScript 的优势，使您的代码库更强大。
确保您的 TypeScript 配置包含自动生成的类型。
{ // ... 您现有的 TypeScript 配置 "include": [ // ... 您现有的 TypeScript 配置 "types", // 包括自动生成的类型 ],}Git 配置
建议忽略 Intlayer 生成的文件。这允许您避免将其提交到 Git 存储库。
为此，您可以将以下说明添加到您的 .gitignore 文件中：
# 忽略 Intlayer 生成的文件.intlayer如果您有改善此文档的想法，请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接