开始使用 Intlayer 和 Next.js 14 的 App Router 进行国际化 (i18n)
什么是 Intlayer？
Intlayer 是一个创新的开源国际化 (i18n) 库，旨在简化现代 Web 应用中的多语言支持。Intlayer 无缝集成了最新的 Next.js 14 框架，包括其强大的 App Router。它针对 服务器组件 的高效渲染进行了优化，并完全兼容 Turbopack（适用于 Next.js >= 15）。
使用 Intlayer，您可以：
- 轻松管理翻译，在组件级别使用声明式字典。
- 动态本地化元数据、路由和内容。
- 在客户端和服务端组件中访问翻译。
- 确保 TypeScript 支持，通过自动生成的类型提高自动补全和错误检测能力。
- 享受高级功能，如动态语言检测和切换。
Intlayer 兼容 Next.js 12、13、14 和 15。如果您使用的是 Next.js Page Router，可以参考此 指南。对于 Next.js 15（无论是否使用 turbopack），请参考此 指南。
在 Next.js 应用中设置 Intlayer 的分步指南
第一步：安装依赖
使用 npm 安装必要的包：
npm install intlayer next-intlayerintlayer
next-intlayer
将 Intlayer 与 Next.js 集成的包。它为 Next.js 国际化提供上下文提供器和钩子。此外，它还包括一个 Next.js 插件，用于将 Intlayer 集成到 Webpack 或 Turbopack 中，以及用于检测用户首选语言、管理 Cookie 和处理 URL 重定向的中间件。
第二步：配置您的项目
创建一个配置文件来配置您的应用语言：
// 配置文件示例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 日志等。有关可用参数的完整列表，请参考 配置文档。
第三步：在 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 环境变量。此外，它提供了别名以优化性能并确保与服务器组件的兼容性。
第四步：配置语言检测中间件
设置中间件以检测用户的首选语言：
// 中间件配置示例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 中。
根据您的应用路由调整 matcher 参数。有关更多详细信息，请参考 Next.js 文档中的 matcher 配置。
第五步：定义动态语言路由
清空 RootLayout 的内容，并替换为以下代码：
// 根布局示例import type { PropsWithChildren, FC } from "react";import "./globals.css";const RootLayout: FC<PropsWithChildren> = ({ children }) => children;export default RootLayout;要实现动态路由，请通过在 [locale] 目录中添加一个新布局来提供语言路径：
// 动态语言布局示例import type { Next14LayoutIntlayer } from "next-intlayer";import { Inter } from "next/font/google";import { getHTMLTextDir } from "intlayer";const inter = Inter({ subsets: ["latin"] });const LocaleLayout: Next14LayoutIntlayer = ({ children, params: { locale },}) => ( <html lang={locale} dir={getHTMLTextDir(locale)}> <body className={inter.className}>{children}</body> </html>);---import { Inter } from "next/font/google";import { getHTMLTextDir } from "intlayer";const inter = Inter({ subsets: ["latin"] });const LocaleLayout = ({ children, params: { locale } }) => ( <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: Next14LayoutIntlayer = ({ children, params: { locale },}) => { /*... 其余代码*/};export default LocaleLayout;generateStaticParams 确保您的应用程序为所有语言环境预构建必要的页面，从而减少运行时计算并改善用户体验。有关更多详细信息，请参阅 Next.js 关于 generateStaticParams 的文档。
第六步：声明您的内容
创建和管理您的内容声明以存储翻译：
import { t, type Dictionary } from "intlayer";const pageContent = { key: "page", content: { getStarted: { main: t({ zh: "通过编辑开始", en: "Get started by editing", fr: "Commencez par éditer", es: "Comience por editar", }), pageLink: "src/app/page.tsx", }, },} satisfies Dictionary;export default pageContent;您的内容声明可以在应用程序中的任何位置定义，只要它们包含在 contentDir 目录中（默认情况下为 ./src）。并匹配内容声明文件扩展名（默认情况下为 .content.{ts,tsx,js,jsx,mjs,cjs}）。
有关更多详细信息，请参阅 内容声明文档。
第七步：在代码中使用内容
在整个应用程序中访问您的内容字典：
import { ClientComponentExample } from "@components/ClientComponentExample";import { ServerComponentExample } from "@components/ServerComponentExample";import { type Next14PageIntlayer, IntlayerClientProvider } from "next-intlayer";import { IntlayerServerProvider, useIntlayer } from "next-intlayer/server";const Page: Next14PageIntlayer = ({ params: { locale } }) => { const content = useIntlayer("page", locale); return ( <> <p> {content.getStarted.main} <code>{content.getStarted.pageLink}</code> </p> <IntlayerServerProvider locale={locale}> <IntlayerClientProvider locale={locale}> <ServerComponentExample /> <ClientComponentExample /> </IntlayerClientProvider> </IntlayerServerProvider> </> );};export default Page;- IntlayerClientProvider 用于为客户端组件提供语言环境。它可以放置在任何父组件中，包括布局。然而，建议将其放置在布局中，因为 Next.js 在页面之间共享布局代码，这使其更高效。通过在布局中使用 IntlayerClientProvider，您可以避免为每个页面重新初始化它，从而提高性能并在整个应用程序中保持一致的本地化上下文。
- IntlayerServerProvider 用于为服务器子组件提供语言环境。它不能在布局中设置。
"use client";import type { FC } from "react";import { useIntlayer } from "next-intlayer";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";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 函数。在函数内部使用 getTranslation 函数来翻译您的元数据。
import { type IConfigLocales, getTranslation, getMultilingualUrls,} from "intlayer";import type { Metadata } from "next";import type { LocalParams } from "next-intlayer";export const generateMetadata = ({ params: { locale },}: LocalParams): Metadata => { const t = <T>(content: IConfigLocales<T>) => getTranslation(content, locale); /** * 生成一个包含每种语言的所有 URL 的对象。 * * 示例： * ```ts * getMultilingualUrls('/about'); * * // 返回 * // { * // en: '/about', * // fr: '/fr/about', * // es: '/es/about', * // } * ``` */ const multilingualUrls = getMultilingualUrls("/"); return { title: t<string>({ zh: "我的标题", en: "My title", fr: "Mon titre", es: "Mi título", }), description: t({ zh: "我的描述", 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 函数。此函数允许您为您的站点地图生成多语言 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 { getMultilingualUrls } from "intlayer";
const 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;
```jsx fileName="src/app/sitemap.csx" codeFormat="commonjs" const { getMultilingualUrls } = require("intlayer"); const 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"), }, }, ]; module.exports = 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;了解更多关于站点地图优化的信息，请访问 Next.js 官方文档。了解更多关于 robots.txt 优化的信息，请访问 Next.js 官方文档。
（可选）步骤 10：更改内容的语言
要更改内容的语言，可以使用 useLocale 钩子提供的 setLocale 函数。此函数允许您设置应用程序的语言环境并相应地更新内容。
"use client";import { Locales, getHTMLTextDir, getLocaleName, getLocalizedUrl,} from "intlayer";import { useLocale } from "next-intlayer";import { type FC } from "react";import Link from "next/link";const LocaleSwitcher: FC = () => { const { locale, pathWithoutLocale, availableLocales, setLocale } = useLocale(); return ( <div> <button popoverTarget="localePopover">{getLocaleName(locale)}</button> <div id="localePopover" popover="auto"> {availableLocales.map((localeItem) => ( <Link href={getLocalizedUrl(pathWithoutLocale, localeItem)} hrefLang={localeItem} key={localeItem} aria-current={locale === localeItem ? "page" : undefined} onClick={(e) => { e.preventDefault(); setLocale(localeItem); }} > <span> {/* 语言环境 - 例如 FR */} {localeItem} </span> <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> </Link> ))} </div> </div> );};文档参考:
（可选）步骤11：创建一个本地化的链接组件
为了确保您的应用程序导航符合当前语言环境，您可以创建一个自定义的 Link 组件。该组件会自动为内部URL添加当前语言前缀。例如，当一个讲法语的用户点击“关于”页面的链接时，他们会被重定向到 /fr/about 而不是 /about。
这种行为有以下几个好处：
- SEO和用户体验: 本地化的URL帮助搜索引擎正确索引语言特定的页面，并为用户提供他们偏好的语言内容。
- 一致性: 通过在整个应用程序中使用本地化链接，您可以保证导航保持在当前语言环境中，防止意外的语言切换。
- 可维护性: 将本地化逻辑集中在一个组件中简化了URL的管理，使您的代码库更易于维护和扩展。
以下是一个用TypeScript实现的本地化 Link 组件：
"use client";import { getLocalizedUrl } from "intlayer";import NextLink, { type LinkProps as NextLinkProps } from "next/link";import { useLocale } from "next-intlayer";import { forwardRef, PropsWithChildren, type ForwardedRef } from "react";/** * 检查给定URL是否为外部链接的工具函数。 * 如果URL以http://或https://开头，则被认为是外部链接。 */export const checkIsExternalLink = (href?: string): boolean => /^https?:///.test(href ?? "");/** * 一个自定义的Link组件，根据当前语言环境调整href属性。 * 对于内部链接，它使用`getLocalizedUrl`为URL添加语言前缀（例如，/fr/about）。 * 这确保了导航保持在相同的语言环境上下文中。 */export const Link = forwardRef< HTMLAnchorElement, PropsWithChildren<NextLinkProps>>(({ href, children, ...props }, ref: ForwardedRef<HTMLAnchorElement>) => { const { locale } = useLocale(); const isExternalLink = checkIsExternalLink(href.toString()); // 如果链接是内部链接并且提供了有效的href，则获取本地化URL。 const hrefI18n: NextLinkProps["href"] = href && !isExternalLink ? getLocalizedUrl(href.toString(), locale) : href; return ( <NextLink href={hrefI18n} ref={ref} {...props}> {children} </NextLink> );});Link.displayName = "Link";工作原理
检测外部链接:
辅助函数 checkIsExternalLink 用于判断URL是否为外部链接。外部链接保持不变，因为它们不需要本地化。获取当前语言环境:
useLocale hook 提供当前语言环境（例如，法语为 fr）。本地化URL:
对于内部链接（即非外部链接），使用 getLocalizedUrl 自动为URL添加当前语言前缀。这意味着如果用户使用法语，传递 /about 作为 href 会被转换为 /fr/about。返回链接:
组件返回一个带有本地化URL的 <a> 元素，确保导航与语言环境一致。
通过在整个应用程序中集成此 Link 组件，您可以维护一致的语言感知用户体验，同时受益于改进的SEO和可用性。
配置 TypeScript
Intlayer 使用模块增强来利用 TypeScript 的优势，使您的代码库更强大。
确保您的 TypeScript 配置包含自动生成的类型。
{ // ... 您现有的 TypeScript 配置 "include": [ // ... 您现有的 TypeScript 配置 ".intlayer/**/*.ts", // 包含自动生成的类型 ],}Git 配置
建议忽略由 Intlayer 生成的文件。这可以避免将它们提交到您的 Git 仓库中。
为此，您可以将以下指令添加到 .gitignore 文件中：
# 忽略由 Intlayer 生成的文件.intlayer更进一步
如果您有改善此文档的想法，请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接