使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
版本历史
- "更新 Solid useIntlayer API 用法以直接访问属性"v8.9.02026/5/4
- "添加 init 命令"v7.5.92025/12/30
- "初始化历史"v5.5.102025/6/29
此页面的内容已使用 AI 翻译。
查看英文原文的最新版本如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接复制文档 Markdown 到剪贴板
使用 Intlayer 翻译您的 Next.js 14 和 App Router 网站 | 国际化 (i18n)
目录
为什么选择 Inlayer 而不是替代品?
与“next-intl”或“i18next”等主要解决方案相比,Intlayer是一个具有集成优化的解决方案,例如:
不要将大量 JSON 文件加载到页面中,而只需加载必要的内容。 Intlayer 有助于将捆绑包和页面大小减少多达 50%。
确定应用程序内容的范围有利于大型应用程序的维护。您可以复制或删除单个功能文件夹,而无需承担检查整个内容代码库的精神负担。此外,Intlayer 具有完全类型化 (fully typed),以确保您的内容的准确性。
共置内容减少大型语言模型 (LLM) 所需的上下文。 Intlayer 还附带了一套工具,例如用于测试缺失翻译的 CLI、LSP、MCP 和 agent skills,使 AI 代理的开发者体验 (DX) 更加流畅。
使用您选择的法学硕士,通过自动化在 CI/CD 管道中进行翻译,而费用由您的 AI 提供商承担。 Intlayer 还提供了一个编译器来自动提取内容,以及一个网络平台来帮助在后台翻译。
将大量 JSON 文件连接到组件可能会导致性能和反应性问题。 Intlayer 可在构建时 (build time)优化您的内容加载。
在 Next.js 应用中逐步设置 Intlayer 的指南
配置您的项目
Here is the final structure that we will make:
bash复制代码复制代码到剪贴板
If you don't want locale routing, intlayer can be used as a simple provider / hook. See this guide for more details.
创建一个配置文件来配置您应用的语言:
intlayer.config.ts复制代码复制代码到剪贴板
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 日志等。有关可用参数的完整列表,请参阅配置文档。
配置中间件以检测语言环境
设置中间件以检测用户的首选语言环境:
src/middleware.ts复制代码复制代码到剪贴板
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中的所有内容,并替换为以下代码:src/app/layout.tsx复制代码复制代码到剪贴板
import type { PropsWithChildren, FC } from "react"; import "./globals.css"; const RootLayout: FC<PropsWithChildren> = ({ children }) => children; export default RootLayout;保持
RootLayout组件为空,允许将lang和dir属性设置到<html>标签上。要实现动态路由,通过在你的
[locale]目录中添加一个新的布局来提供 locale 的路径:src/app/[locale]/layout.tsx复制代码复制代码到剪贴板
import { type Next14LayoutIntlayer, IntlayerClientProvider, } 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}> <IntlayerClientProvider locale={locale}> {children} </IntlayerClientProvider> </body> </html> ); export default LocaleLayout;[locale]路径段用于定义语言环境。例如:/en-US/about将对应en-US,而/fr/about对应fr。在此阶段,您可能会遇到错误:
Error: Missing <html> and <body> tags in the root layout.。这是预期的,因为/app/page.tsx文件不再使用,可以删除。取而代之的是,[locale]路径段将激活/app/[locale]/page.tsx页面。因此,页面将通过浏览器中的路径如/en、/fr、/es访问。若要将默认语言环境设置为根页面,请参考第4步中的middleware配置。接下来,在您的应用布局中实现
generateStaticParams函数。src/app/[locale]/layout.tsx复制代码复制代码到剪贴板
export { generateStaticParams } from "next-intlayer"; // 插入的代码行 const LocaleLayout: Next14LayoutIntlayer = ({ children, params: { locale }, }) => { /*... 其余代码*/ }; export default LocaleLayout;generateStaticParams确保您的应用程序为所有语言预构建必要的页面,从而减少运行时计算并提升用户体验。更多详情,请参阅 Next.js 关于 generateStaticParams 的文档。声明您的内容
创建并管理您的内容声明以存储翻译:
src/app/[locale]/page.content.ts复制代码复制代码到剪贴板
import { t, type Dictionary } 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 Dictionary; export default pageContent;在代码中使用内容
在整个应用程序中访问您的内容字典:
src/app/[locale]/page.tsx复制代码复制代码到剪贴板
`
IntlayerClientProvider用于向客户端组件提供 locale。它可以放置在任何父组件中,包括布局组件中。然而,推荐将其放在布局中,因为 Next.js 会在页面间共享布局代码,这样更高效。通过在布局中使用IntlayerClientProvider,可以避免每个页面都重新初始化它,从而提升性能并在整个应用中保持一致的本地化上下文。IntlayerServerProvider用于向服务器端子组件提供 locale。它不能设置在布局中。
plaintext复制代码复制代码到剪贴板
src/components/ServerComponentExample.tsx复制代码复制代码到剪贴板
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> ); };如果您想在字符串属性中使用内容,例如
alt、title、href、aria-label等,必须调用函数的值,如:html复制代码复制代码到剪贴板
若要了解有关
useIntlayer钩子的更多信息,请参阅文档。元数据的国际化
如果您想对元数据进行国际化,例如页面标题,可以使用 Next.js 提供的
generateMetadata函数。在该函数内部,您可以通过getIntlayer函数获取内容,从而翻译您的元数据。src/app/[locale]/metadata.content.ts复制代码复制代码到剪贴板
import { type Dictionary, t } from "intlayer"; import { Metadata } from "next"; const metadataContent = { key: "page-metadata", content: { title: t({ en: "Create Next App", fr: "Créer une application Next.js", es: "Crear una aplicación Next.js", }), description: t({ en: "Generated by create next app", fr: "Généré par create next app", es: "Generado por create next app", }), }, } satisfies Dictionary<Metadata>; export default metadataContent;src/app/[locale]/layout.tsx or src/app/[locale]/page.tsx复制代码复制代码到剪贴板
注意,从
next-intlayer导入的getIntlayer函数会返回包装在IntlayerNode中的内容,允许与可视化编辑器集成。相比之下,从intlayer导入的getIntlayer函数直接返回内容,不带额外属性。或者,你也可以使用
getTranslation函数来声明你的元数据。不过,推荐使用内容声明文件,以便自动化你的元数据翻译并在某个阶段将内容外部化。src/app/[locale]/layout.tsx or src/app/[locale]/page.tsx复制代码复制代码到剪贴板
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); 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", }), }; }; // ... 代码的其余部分了解有关元数据优化的更多信息,请参阅 Next.js 官方文档。
国际化您的 sitemap.xml 和 robots.txt
要实现
sitemap.xml和robots.txt的国际化,您可以使用 Intlayer 提供的getMultilingualUrls函数。该函数允许您为站点地图生成多语言 URL。src/app/sitemap.ts复制代码复制代码到剪贴板
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;src/app/robots.ts复制代码复制代码到剪贴板
import type { MetadataRoute } from "next"; import { getMultilingualUrls } from "intlayer"; // 获取所有多语言 URL 的函数 const getAllMultilingualUrls = (urls: string[]) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]); // 定义 robots 配置,指定爬虫规则 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 文档。
更改内容语言
要在 Next.js 中更改内容的语言,推荐的方式是使用
Link组件将用户重定向到相应的本地化页面。Link组件支持页面预加载,这有助于避免完整的页面重新加载。src/components/LocaleSwitcher.tsx复制代码复制代码到剪贴板
"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={() => setLocale(localeItem)} > <span> {/* 语言区域 - 例如 FR */} {localeItem} </span> <span> {/* 该语言区域的语言名称 - 例如 Français */} {getLocaleName(localeItem, locale)} </span> <span dir={getHTMLTextDir(localeItem)} lang={localeItem}> {/* 当前语言环境中的语言名称 - 例如当前语言环境设置为 Locales.SPANISH 时显示 Francés */} {getLocaleName(localeItem)} </span> <span dir="ltr" lang={Locales.ENGLISH}> {/* 英语中的语言名称 - 例如 French */} {getLocaleName(localeItem, Locales.ENGLISH)} </span> </Link> ))} </div> </div> ); };另一种方式是使用
useLocale钩子提供的setLocale函数。该函数不支持页面预取,并且会重新加载页面。在这种情况下,不使用
router.push进行重定向,只有您的服务器端代码会更改内容的语言环境。src/components/LocaleSwitcher.tsx复制代码复制代码到剪贴板
文档参考:
创建本地化链接组件
为了确保您的应用导航遵循当前的语言环境,您可以创建一个自定义的
Link组件。该组件会自动在内部 URL 前添加当前语言的前缀。例如,当讲法语的用户点击“关于”页面的链接时,他们会被重定向到/fr/about,而不是/about。这种行为有几个好处:
- SEO 和用户体验:本地化的 URL 有助于搜索引擎正确索引特定语言的页面,并为用户提供其偏好的语言内容。
- 一致性:通过在整个应用中使用本地化链接,您可以确保导航保持在当前语言环境内,防止意外的语言切换。
- 可维护性:将本地化逻辑集中在单个组件中简化了 URL 的管理,使您的代码库更易于维护和扩展,随着应用的增长。
以下是在 TypeScript 中实现的本地化
Link组件示例:src/components/Link.tsx复制代码复制代码到剪贴板
"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钩子提供当前的语言环境(例如,法语为fr)。本地化 URL:
对于内部链接(即非外部链接),getLocalizedUrl用于自动在 URL 前添加当前语言环境的前缀。这意味着如果用户的语言环境是法语,传入的/about作为href会被转换为/fr/about。返回链接:
该组件返回带有本地化 URL 的<a>元素,确保导航与语言环境保持一致。
通过在整个应用中集成此
Link组件,您可以保持一致且具备语言感知的用户体验,同时还能提升 SEO 和可用性。优化您的Bundle 大小
使用
next-intlayer时,字典默认会包含在每个页面的打包文件中。为了优化打包体积,Intlayer 提供了一个可选的 SWC 插件,该插件通过宏智能替换useIntlayer调用。这确保了字典只会包含在实际使用它们的页面的打包文件中。要启用此优化,请安装
@intlayer/swc包。安装后,next-intlayer会自动检测并使用该插件:bash复制代码复制代码到剪贴板
注意:此优化仅适用于 Next.js 13 及以上版本。
注意:该包默认不安装,因为 SWC 插件在 Next.js 中仍处于实验阶段,未来可能会有所变化。
配置 TypeScript
Intlayer 使用模块增强来利用 TypeScript 的优势,使您的代码库更健壮。


确保您的 TypeScript 配置包含自动生成的类型。
复制代码到剪贴板
Git 配置
建议忽略 Intlayer 生成的文件。这样可以避免将它们提交到你的 Git 仓库中。
为此,你可以在 .gitignore 文件中添加以下内容:
复制代码到剪贴板
VS Code 扩展
为了提升你使用 Intlayer 的开发体验,你可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的 自动补全。
- 实时错误检测,用于缺失的翻译。
- 内联预览,显示翻译内容。
- 快速操作,轻松创建和更新翻译。
有关如何使用该扩展的更多详细信息,请参阅 Intlayer VS Code 扩展文档。
深入了解
要进一步使用,您可以实现可视化编辑器或使用内容管理系统(CMS)来外部化您的内容。