使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
版本历史
- "更新 Solid useIntlayer API 用法以直接访问属性"v8.9.02026/5/4
- "更新 LocaleSwitcher、SEO、元数据"v7.3.112025/12/7
- "初始化历史记录"v5.5.102025/6/29
此页面的内容已使用 AI 翻译。
查看英文原文的最新版本如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接复制文档 Markdown 到剪贴板
使用 Intlayer 翻译您的 Nuxt 和 Vue 网站 | 国际化 (i18n)
目录
为什么选择 Inlayer 而不是替代品?
与“@nuxtjs/i18n”或“i18next”等主要解决方案相比,Intlayer是一个具有集成优化的解决方案,例如:
Intlayer 经过优化,可与 Nuxt 完美配合,提供多语言路由、用于区域设置检测的中间件、站点地图以及扩展国际化 (i18n) 所需的所有功能。
不要将大量 JSON 文件加载到页面中,而只需加载必要的内容。 Intlayer 有助于将捆绑包和页面大小减少多达 50%。
确定应用程序内容的范围有利于大型应用程序的维护。您可以复制或删除单个功能文件夹,而无需承担检查整个内容代码库的精神负担。此外,Intlayer 具有完全类型化 (fully typed),以确保您的内容的准确性。
共置内容减少大型语言模型 (LLM) 所需的上下文。 Intlayer 还附带了一套工具,例如用于测试缺失翻译的 CLI、LSP、MCP 和 agent skills,使 AI 代理的开发者体验 (DX) 更加流畅。
使用您选择的法学硕士,通过自动化在 CI/CD 管道中进行翻译,而费用由您的 AI 提供商承担。 Intlayer 还提供了一个编译器来自动提取内容,以及一个网络平台来帮助在后台翻译。
将大量 JSON 文件连接到组件可能会导致性能和反应性问题。 Intlayer 可在构建时 (build time)优化您的内容加载。
在 Nuxt 应用中设置 Intlayer 的分步指南
查看 GitHub 上的应用模板。
安装依赖
使用 npm 安装必要的包:
bash复制代码复制代码到剪贴板
--interactive标志是可选的。如果您是 AI 代理,请使用intlayer-cli init。此命令将检测您的环境并安装所需的包。例如:
bash复制代码复制代码到剪贴板
配置您的项目
创建一个配置文件来配置您的应用程序的语言:
intlayer.config.ts复制代码复制代码到剪贴板
import { Locales, type IntlayerConfig } from "intlayer"; const config: IntlayerConfig = { internationalization: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, // 您的其他 locales ], defaultLocale: Locales.ENGLISH, }, }; export default config;通过此配置文件,您可以设置本地化 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表,请参阅配置文档。
在您的 Nuxt 配置中集成 Intlayer
将 intlayer 模块添加到您的 Nuxt 配置中:
nuxt.config.ts复制代码复制代码到剪贴板
nuxt-intlayer模块自动处理 Intlayer 与 Nuxt 的集成。它设置内容声明构建、在开发模式下监视文件、提供 locale 检测中间件,并管理本地化路由。声明您的内容
创建并管理您的内容声明以存储翻译:
您的内容声明可以定义在应用程序中的任何位置,只要它们包含在
contentDir目录中(默认情况下为./src)。并匹配内容声明文件扩展名(默认情况下为.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml})。有关更多详细信息,请参阅内容声明文档。
在您的代码中使用 Intlayer
使用
useIntlayercomposable 在整个 Nuxt 应用中访问您的内容字典:components/HelloWorld.vue复制代码复制代码到剪贴板
访问 Intlayer 中的内容
Intlayer 提供了多种 API 来访问您的内容:
基于组件的语法(推荐): 使用
<myContent />或<Component :is="myContent" />语法将内容渲染为 Intlayer 节点。这与可视化编辑器和CMS无缝集成。基于字符串的语法: 使用
{{ myContent }}将内容渲染为纯文本,不支持可视化编辑器。原始 HTML 语法: 使用
<div v-html="myContent" />将内容渲染为原始 HTML,不支持可视化编辑器。解构语法:
useIntlayer组合函数返回一个包含内容的 Proxy。该 Proxy 可以被解构以访问内容,同时保持响应性。- 使用
const content = useIntlayer("myContent");以及{{ content.myContent }}/<content.myContent />。 - 或者使用
const { myContent } = useIntlayer("myContent");以及{{ myContent}}/<myContent/>来解构内容。
- 使用
更改内容语言
要更改内容的语言,可以使用
useLocale组合函数提供的setLocale函数。该函数允许您设置应用程序的语言环境并相应地更新内容。创建一个组件,使用
NuxtLink在语言之间切换。使用链接而非按钮进行语言切换是 SEO 和页面可发现性的最佳实践,因为这允许搜索引擎抓取并索引页面的所有本地化版本:components/LocaleSwitcher.vue复制代码复制代码到剪贴板
使用带有正确
href属性(通过getLocalizedUrl)的NuxtLink确保搜索引擎能够发现您页面的所有语言版本。这比仅使用 JavaScript 的语言切换更优,因为搜索引擎爬虫可能无法跟踪后者。然后,设置您的
app.vue以使用布局:app.vue复制代码复制代码到剪贴板
为您的应用添加本地化路由
当使用
nuxt-intlayer模块时,Nuxt 会自动处理本地化路由。它会根据您的页面目录结构自动为每种语言创建路由。示例:
plaintext复制代码复制代码到剪贴板
要创建本地化页面,只需在
pages/目录中创建您的 Vue 文件。以下是两个示例页面:主页 (
pages/index.vue):pages/index.vue复制代码复制代码到剪贴板
关于页面 (
pages/about.vue):pages/about.vue复制代码复制代码到剪贴板
注意:
useHead在 Nuxt 中是自动导入的。你可以根据需要使用.value(响应式)或.raw(原始字符串)来访问内容值。nuxt-intlayer模块将自动:- 检测用户的首选语言环境
- 通过 URL 处理语言切换
- 设置适当的
<html lang="">属性 - 管理语言环境 Cookie
- 将用户重定向到相应的本地化 URL
创建本地化链接组件
为了确保您的应用程序导航遵循当前的语言环境,您可以创建一个自定义的
Links组件。该组件会自动为内部 URL 添加当前语言前缀,这对于 SEO 和页面可发现性 至关重要。components/Links.vue复制代码复制代码到剪贴板
然后在整个应用中使用此组件:
layouts/default.vue复制代码复制代码到剪贴板
通过使用带有本地化路径的
NuxtLink,您可以确保:- 搜索引擎能够抓取并索引您页面的所有语言版本
- 用户可以直接分享本地化的 URL
- 浏览器历史记录能正确处理带有语言前缀的 URL
处理元数据和 SEO
Nuxt 通过
useHead组合式函数(自动导入)提供了出色的 SEO 功能。您可以使用 Intlayer 处理本地化的元数据,使用.raw或.value访问器获取原始字符串值:pages/about.vue复制代码复制代码到剪贴板
或者,你可以使用
import { getIntlayer } from "intlayer"函数来获取内容,且不带 Vue 响应性。访问内容值:
- 使用
.raw获取原始字符串值(非响应式) - 使用
.value获取响应式值 - 使用
<content.key />组件语法以支持可视化编辑器
创建对应的内容声明:
pages/about-page.content.ts复制代码复制代码到剪贴板
import { t, type Dictionary } from "intlayer"; const aboutPageContent = { key: "about-page", content: { metaTitle: t({ en: "关于我们 - 我的公司", fr: "À Propos - Ma Société", es: "Acerca de Nosotros - Mi Empresa", }), metaDescription: t({ en: "了解更多关于我们公司及我们的使命", fr: "En savoir plus sur notre société et notre mission", es: "Conozca más sobre nuestra empresa y nuestra misión", }), title: t({ en: "关于我们", fr: "À Propos", es: "Acerca de Nosotros", }), }, } satisfies Dictionary; export default aboutPageContent;- 使用
创建带导航的布局
可选Nuxt 布局允许您为页面定义一个通用结构。创建一个包含语言切换器和导航的默认布局:
layouts/default.vue复制代码复制代码到剪贴板
Links组件(如下所示)确保内部导航链接会自动本地化。
Git 配置
建议忽略 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库中。
为此,您可以将以下指令添加到您的 .gitignore 文件中:
复制代码到剪贴板
VS Code 扩展
为了提升您使用 Intlayer 的开发体验,您可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的 自动补全。
- 缺失翻译的 实时错误检测。
- 翻译内容的 内联预览。
- 轻松创建和更新翻译的 快速操作。
有关如何使用该扩展的更多详细信息,请参阅 Intlayer VS Code 扩展文档。
更进一步
要进一步提升,您可以实现可视化编辑器或使用CMS将内容外部化。
常见问题
两个切合实际的选择:
@nuxtjs/i18n:成熟的官方模块,基于vue-i18n构建,按页面加载语言文件,配置项庞大。但vue-i18n无法实现消息的命名空间隔离,导致每个页面都会打包所有其他页面的消息,随着页面增多,bundle 体积不断膨胀。Intlayer:最先进的解决方案。内容可以在代码库中的任何位置声明(靠近每个组件或集中管理),并在构建时进行编译,全链路类型安全,提供支持语言环境的路由、AI 翻译、可视化编辑器和 CMS。
核心区别在于内容的存放位置。@nuxtjs/i18n 将内容集中在 locales/*.json 文件中,而 Intlayer 将内容与渲染它的组件放置在同一目录下,因此页面仅输出其实际使用的条目,且功能模块目录可以整体移动或删除。请参阅 为什么选择 Intlayer 和 Vue i18n 性能基准。
远少于基于命名空间的方案,因为页面永远不会下载它不渲染的语言目录。服务端渲染的标记在服务端直接解析内容,构建时编译器将 useIntlayer 调用替换为组件使用的确切字典条目,因此未使用的键和未使用的语言都会被自动丢弃,并且 动态字典 会按语言环境拆分剩余内容。与常规替代方案相比,Intlayer 可将 bundle 和页面体积减少高达 50%。请参阅 Bundle 体积优化 和 性能基准。
可以,有两条迁移路径。您可以使用 @nuxtjs/i18n 迁移指南 逐步迁移内容。或者,您可以完全保留当前的 API:兼容性适配器 公开与 vue-i18n 完全相同的 API,但底层由 Intlayer 字典驱动,因此只需更改导入语句,组件代码完全无需修改。
可以。JSON 同步插件 将您的 /messages/{locale}/{namespace}.json 文件作为单一真实来源(source of truth),并双向生成 Intlayer 字典。PO 同步插件 对 gettext 目录执行相同的操作,而 按语言环境组织的文件 允许您按语言拆分内容,而不是将所有语言打包到一个文件中。
不需要。运行 npx intlayer extract,Intlayer 会读取您的源码文件,提取面向用户的字符串,并在每个组件旁边生成 .content 文件,这样您只需审查 diff,而无需手动逐一复制字符串到语言目录中。请参阅 extract 命令。
如需全自动流程,Intlayer Compiler 可以在构建时对 JSX、TSX、Vue 和 Svelte 源码执行相同操作,在每次更改时自动生成字典,完全无需手动维护键名。它通过静态分析工作,因此仅在运行时存在的字符串无法被捕获,并且需要少量注解以区分用户文本和应用程序逻辑。
共有 5 个工具,均为可选:
- VS Code 扩展:从
useIntlayer键跳转到声明它的内容文件,从组件中提取内容,并从命令面板或专属的 Intlayer 选项卡运行 build、fill、test、push 和 pull。 - LSP 服务器:在任何支持 LSP 的编辑器中提供相同的感知能力,支持跳转到定义、查找所有引用、悬停预览翻译值、键和字段的自动补全,以及在键未声明时发出警告。它还可以解析
i18next、react-i18next、next-intl和use-intl调用,助力平滑迁移。 - MCP 服务器:向 Cursor、VS Code、Claude Desktop、Claude Code 和 ChatGPT 公开 Intlayer 文档与 CLI,使 AI 助手能够基于最新文档进行准确回答,并能自行运行
intlayer fill等命令。 - Agent Skills:针对特定领域的技能(如
intlayer-config、intlayer-cli和intlayer-content,以及每个框架对应的专属技能),教导 AI 代理您的路由配置和内容节点类型。 - ESLint 插件:
no-raw-text规则标记硬编码字符串,并提供针对静态字典键和未使用内容的额外规则。
