使用您最喜欢的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翻译您的Vite and Vue | 国际化(i18n)
目录
为什么选择 Inlayer 而不是替代品?
与“vue-i18n”或“i18next”等主要解决方案相比,Intlayer是一个具有集成优化的解决方案,例如:
Intlayer 经过优化,可与 Vue 完美配合,提供组件级内容范围、反应式翻译以及扩展国际化 (i18n) 所需的所有功能。
不要将大量 JSON 文件加载到页面中,而只需加载必要的内容。 Intlayer 有助于将捆绑包和页面大小减少多达 50%。
确定应用程序内容的范围有利于大型应用程序的维护。您可以复制或删除单个功能文件夹,而无需承担检查整个内容代码库的精神负担。此外,Intlayer 具有完全类型化 (fully typed),以确保您的内容的准确性。
共置内容减少大型语言模型 (LLM) 所需的上下文。 Intlayer 还附带了一套工具,例如用于测试缺失翻译的 CLI、LSP、MCP 和 agent skills,使 AI 代理的开发者体验 (DX) 更加流畅。
使用您选择的法学硕士,通过自动化在 CI/CD 管道中进行翻译,而费用由您的 AI 提供商承担。 Intlayer 还提供了一个编译器来自动提取内容,以及一个网络平台来帮助在后台翻译。
将大量 JSON 文件连接到组件可能会导致性能和反应性问题。 Intlayer 可在构建时 (build time)优化您的内容加载。
在 Vite 和 Vue 应用中设置 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, // 您的其他语言环境 ], defaultLocale: Locales.ENGLISH, }, }; export default config;通过此配置文件,您可以设置本地化的 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名,禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表,请参阅配置文档。
在您的 Vite 配置中集成 Intlayer
将 intlayer 插件添加到您的配置中。
vite.config.ts复制代码复制代码到剪贴板
import { defineConfig } from "vite"; import vue from "@vitejs/plugin-vue"; import { intlayer } from "vite-intlayer"; // https://vitejs.dev/config/ export default defineConfig({ plugins: [vue(), intlayer()], });intlayer()Vite 插件用于将 Intlayer 集成到 Vite 中。它确保构建内容声明文件并在开发模式下监视这些文件。在 Vite 应用中定义了 Intlayer 环境变量。此外,它还提供别名以优化性能。声明您的内容
创建并管理您的内容声明以存储翻译:
src/helloWorld.content.ts复制代码复制代码到剪贴板
import { t, type Dictionary } from "intlayer"; const helloWorldContent = { key: "helloworld", content: { count: t({ en: "count is ", fr: "le compte est ", es: "el recuento es " }), edit: t({ en: "Edit <code>components/HelloWorld.vue</code> and save to test HMR", fr: "Éditez <code>components/HelloWorld.vue</code> et enregistrez pour tester HMR", es: "Edita <code>components/HelloWorld.vue</code> y guarda para probar HMR", }), checkOut: t({ en: "Check out ", fr: "Vérifiez ", es: "Compruebe " }), officialStarter: t({ en: ", the official Vue + Vite starter", fr: ", le starter officiel Vue + Vite", es: ", el starter oficial Vue + Vite", }), learnMore: t({ zh: "了解更多关于 Vue 的 IDE 支持,详见 ", en: "Learn more about IDE Support for Vue in the ", fr: "En savoir plus sur le support IDE pour Vue dans le ", es: "Aprenda más sobre el soporte IDE para Vue en el ", }), vueDocs: t({ zh: "Vue 文档扩展指南", en: "Vue Docs Scaling up Guide", fr: "Vue Docs Scaling up Guide", es: "Vue Docs Scaling up Guide", }), readTheDocs: t({ en: "Click on the Vite and Vue logos to learn more", fr: "Cliquez sur les logos Vite et Vue pour en savoir plus", es: "Haga clic en los logotipos de Vite y Vue para obtener más información", zh: "点击 Vite 和 Vue 标志以了解更多信息", }), }, } satisfies Dictionary; export default helloWorldContent;您的内容声明可以定义在应用程序中的任何位置,只要它们被包含在
contentDir目录中(默认是./src)。并且文件扩展名需匹配内容声明的文件扩展名(默认是.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml})。更多详情,请参阅内容声明文档。
在代码中使用 Intlayer
要在整个 Vue 应用中使用 Intlayer 的国际化功能,首先需要在主文件中注册 Intlayer 单例实例。这一步非常关键,因为它为应用中的所有组件提供了国际化上下文,使得翻译内容可以在组件树中的任何位置访问。
复制代码复制代码到剪贴板
你也可以根据偏好直接调用
installIntlayer(app)作为一个函数:javascript复制代码复制代码到剪贴板
通过创建主 Vue 组件并使用
useIntlayer组合函数,可以在整个应用中访问内容字典:src/HelloWord.vue复制代码复制代码到剪贴板
如果你的应用已经存在,你可以使用 Intlayer Compiler 以及 extract 命令,在几秒钟内转换数千个组件。
在 Intlayer 中访问内容
Intlayer 提供了多种 API 来访问您的内容:
基于组件的语法(推荐): 使用
<myContent />或<Component :is="myContent" />语法将内容渲染为 Intlayer 节点。这与可视化编辑器和内容管理系统无缝集成。基于字符串的语法: 使用
{{ 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函数。该函数允许你设置应用的语言环境,并相应地更新内容。创建一个组件以切换语言:
src/components/LocaleSwitcher.vue复制代码复制代码到剪贴板
然后,在你的 App.vue 中使用该组件:
src/App.vue复制代码复制代码到剪贴板
为您的应用添加本地化路由
在 Vue 应用中添加本地化路由通常涉及使用带有语言前缀的 Vue Router。这为每种语言创建唯一的路由,有助于 SEO 和 SEO 友好的 URL。
示例:
plaintext复制代码复制代码到剪贴板
首先,安装 Vue Router:
bash复制代码复制代码到剪贴板
然后,创建一个处理基于语言环境路由的路由配置:
src/router/index.ts复制代码复制代码到剪贴板
名称用于在路由器中识别路由。它应在所有路由中唯一,以避免冲突并确保正确的导航和链接。
然后,在你的 main.js 文件中注册路由器:
src/main.ts复制代码复制代码到剪贴板
然后更新你的
App.vue文件以渲染 RouterView 组件。该组件将显示当前路由匹配的组件。src/App.vue复制代码复制代码到剪贴板
同时,你也可以使用
intlayerProxy为你的应用程序添加服务器端路由。这个插件将根据 URL 自动检测当前语言环境并设置相应的语言环境 cookie。如果没有指定语言环境,该插件将根据用户的浏览器语言偏好确定最合适的语言环境。如果未检测到语言环境,它将重定向到默认语言环境。同时,你也可以使用
intlayerProxy为你的应用添加服务器端路由。该插件会根据 URL 自动检测当前语言环境并设置相应的语言环境 cookie。如果未指定语言环境,插件将根据用户浏览器的语言偏好确定最合适的语言环境。如果仍未检测到语言环境,则会重定向到默认语言环境。自 Intlayer v9 起,
intlayerProxy()已直接打包到intlayer()插件中,并通过routing.enableProxy选项默认启用(默认为true)。如下所示单独注册它现在是可选的 — 它被保留用于向后兼容性以及需要控制插件顺序的设置。设置routing.enableProxy: false可退出。查看 v9 发布说明。vite.config.ts复制代码复制代码到剪贴板
import { defineConfig } from "vite"; import vue from "@vitejs/plugin-vue"; import { intlayer } from "vite-intlayer"; // https://vitejs.dev/config/ export default defineConfig({ plugins: [ vue(), intlayer({ proxy: { ignore: (req) => req.url?.startsWith("/api"), }, }), ], });当语言环境变化时更改 URL
为了在用户更改语言时自动更新 URL,您可以修改
LocaleSwitcher组件以使用 Vue Router:src/components/LocaleSwitcher.vue复制代码复制代码到剪贴板
提示:为了更好的 SEO 和可访问性,使用如
<a href="/fr/home" hreflang="fr">这样的标签来链接到本地化页面,如步骤10所示。这允许搜索引擎正确发现和索引特定语言的 URL。为了保持 SPA 行为,可以通过 @click.prevent 阻止默认导航,使用 useLocale 更改语言环境,并通过 Vue Router 编程式导航。html复制代码复制代码到剪贴板
切换HTML的语言和方向属性
当您的应用支持多种语言时,更新
<html>标签的lang和dir属性以匹配当前语言环境至关重要。这样做可以确保:- 无障碍访问:屏幕阅读器和辅助技术依赖正确的
lang属性来准确发音和解释内容。 - 文本渲染:
dir(方向)属性确保文本以正确的顺序呈现(例如,英语为从左到右,阿拉伯语或希伯来语为从右到左),这对于可读性至关重要。 - 搜索引擎优化(SEO):搜索引擎使用
lang属性来确定页面的语言,有助于在搜索结果中提供正确的本地化内容。
通过在语言环境变化时动态更新这些属性,您可以确保所有支持语言的用户都获得一致且无障碍的体验。
src/composables/useI18nHTMLAttributes.ts复制代码复制代码到剪贴板
在你的
App.vue或全局组件中使用此组合函数:src/App.vue复制代码复制代码到剪贴板
- 无障碍访问:屏幕阅读器和辅助技术依赖正确的
创建本地化链接组件
为了确保您的应用程序导航遵循当前的语言环境,您可以创建一个自定义的
Link组件。该组件会自动在内部 URL 前添加当前语言的前缀。例如,当讲法语的用户点击“关于”页面的链接时,他们会被重定向到/fr/about,而不是/about。这种行为有几个好处:
- SEO 和用户体验:本地化的 URL 有助于搜索引擎正确索引特定语言的页面,并为用户提供其偏好的语言内容。
- 一致性:通过在整个应用中使用本地化链接,您可以确保导航保持在当前语言环境内,避免意外的语言切换。
- 可维护性:将本地化逻辑集中在单个组件中简化了 URL 的管理,使您的代码库更易于维护和扩展,随着应用程序的增长。
src/components/Link.vue复制代码复制代码到剪贴板
用于 Vue Router,创建一个路由专用版本:
src/components/RouterLink.vue复制代码复制代码到剪贴板
在您的应用程序中使用这些组件:
src/App.vue复制代码复制代码到剪贴板
提取组件内容
可选如果您有现有的代码库,转换数千个文件可能会非常耗时。
为了简化此过程,Intlayer 提出了 编译器 / 提取器 来转换您的组件并提取内容。
要进行设置,您可以在
intlayer.config.ts文件中添加compiler部分:intlayer.config.ts复制代码复制代码到剪贴板
import { type IntlayerConfig } from "intlayer"; const config: IntlayerConfig = { // ... 您的其他配置 compiler: { /** * 指示是否应启用编译器。 */ enabled: true, /** * 定义输出文件路径 */ output: ({ fileName, extension }) => `./${fileName}${extension}`, /** * 指示在转换后是否应保存组件。这样,编译器只需运行一次即可转换应用程序,然后即可将其删除。 */ saveComponents: false, /** * 字典键前缀 */ dictionaryKeyPrefix: "", }, }; export default config;运行提取器以转换组件并提取内容
bash复制代码复制代码到剪贴板
Since v9, the
intlayerCompileris included in theintlayerplugin. So you don't need to add it manually.更新您的
vite.config.ts以包含intlayerCompiler插件:vite.config.ts复制代码复制代码到剪贴板
bash复制代码复制代码到剪贴板
(可选)站点地图与 robots.txt(构建时生成)
Intlayer 提供 generateSitemap 与 getMultilingualUrls,可将面向爬虫的多语言 sitemap.xml 和 robots.txt 格式化并自动写入 public/。实践中在 Vite 之前运行小型 Node 脚本(例如 npm 的 predev / prebuild)即可在构建或开发时生成这些文件。
站点地图
Intlayer 的站点地图生成会尊重你的语言配置,并包含爬虫所需的元数据。
生成的站点地图支持xhtml:link(hreflang)。与只列出扁平 URL 不同,Intlayer 会在各语言版本之间建立双向关联(例如/about、/fr/about或/about?lang=fr,取决于路由模式)。
Robots.txt
使用 getMultilingualUrls,使 Disallow 覆盖敏感路径的每一种本地化写法。
1. 在项目根目录添加 generate-seo.mjs
复制代码到剪贴板
需已安装 intlayer 以便脚本导入。生产环境请设置环境变量 SITE_URL(例如在 CI 中)。
建议在 Node 中使用generate-seo.mjs(ESM)。若使用generate-seo.js,请在package.json中设置"type": "module"或以其他方式启用 ESM。
2. 在运行 Vite 之前执行脚本
复制代码到剪贴板
若使用 pnpm 或 yarn,请相应调整命令;也可在 CI 或其他步骤中调用该脚本。
配置 TypeScript
Intlayer 使用模块扩展 (module augmentation) 来利用 TypeScript 的优势,并使你的 codebase 更强大。


确保你的 TypeScript 配置包含了自动生成的类型。
复制代码到剪贴板
Git 配置
建议忽略由 Intlayer 生成的文件。这可以让你避免将它们提交到你的 Git 仓库。
为此,你可以将以下指令添加到你的 .gitignore 文件中:
复制代码到剪贴板
VS Code 扩展
为了提升使用 Intlayer 的开发体验,你可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的自动补全。
- 针对缺失翻译的实时错误检测。
- 已翻译内容的行内预览。
- 轻松创建和更新翻译的快速操作。
有关如何使用该扩展的更多详细信息,请参阅 Intlayer VS Code 扩展文档。
深入了解
要进一步使用,您可以实现可视化编辑器或使用内容管理系统(CMS)将内容外部化。
Once you provide these blocks, I'll perform a complete audit and return the fully updated Chinese translation following all the guidelines you've specified.---
