使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
版本历史
- "比较路由 head 函数中元数据字典的静态解析、动态解析与带缓存的动态解析"v9.4.02026/8/25
- "更新 Solid useIntlayer API 用法以直接访问属性"v8.9.02026/5/4
- "添加 init 命令"v7.5.92025/12/30
- "引入 validatePrefix 并添加步骤 14: 处理带有本地化路由的 404 页面。"v7.4.02025/12/11
- "添加步骤 13: 在您的 server actions 中获取 locale (可选)"v7.3.92025/12/5
- "添加步骤 13: 适配 Nitro"v7.2.32025/11/18
- "通过添加 getPrefix 函数修复 useLocalizedNavigate、LocaleSwitcher 和 LocalizedLink 的前缀默认值。"v7.1.02025/11/17
- "更新文档"v6.5.22025/10/3
- "为 Tanstack Start 添加支持"v5.8.12025/9/9
此页面的内容已使用 AI 翻译。
查看英文原文的最新版本如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接复制文档 Markdown 到剪贴板
使用Intlayer翻译您的Tanstack Start | 国际化(i18n)
目录
本指南演示如何在 Tanstack Start 项目中集成 Intlayer,实现无缝国际化,支持基于区域设置的路由、TypeScript 支持以及现代开发实践。
为什么选择 Inlayer 而不是替代品?
与“react-i18next”或“use-intl”或“paraglide”等主要解决方案相比,Intlayer是一个具有集成优化的解决方案,例如:
完整的 TanStack Start 覆盖
Intlayer 针对 TanStack Start 进行了全面优化,提供多语言路由、cookie 管理、站点地图生成、动态内容加载以及扩展国际化 (i18n) 工作所需的所有功能。
</Accordion>
捆绑尺寸
不要将大量 JSON 文件加载到页面中,而只需加载必要的内容。 Intlayer 有助于将捆绑包和页面大小减少多达 50%。
</Accordion>
可维护性
确定应用程序内容的范围有利于大型应用程序的维护。您可以复制或删除单个功能文件夹,而无需承担检查整个内容代码库的精神负担。此外,Intlayer 具有完全类型化 (fully typed),以确保您的内容的准确性。
人工智能代理
共置内容减少大型语言模型 (LLM) 所需的上下文。 Intlayer 还附带了一套工具,例如用于测试缺失翻译的 CLI、LSP、MCP 和 agent skills,使 AI 代理的开发者体验 (DX) 更加流畅。
自动化
使用您选择的法学硕士,通过自动化在 CI/CD 管道中进行翻译,而费用由您的 AI 提供商承担。 Intlayer 还提供了一个编译器来自动提取内容,以及一个网络平台来帮助在后台翻译。
</Accordion>
表现
将大量 JSON 文件连接到组件可能会导致性能和反应性问题。 Intlayer 可在构建时 (build time)优化您的内容加载。
无需开发即可扩展
在 Tanstack Start 应用程序中设置 Intlayer 的分步指南
在 GitHub 上查看 应用程序模板。
创建项目
首先,按照 TanStack Start 网站上的 开始新项目 指南创建一个新的 TanStack Start 项目。
安装 Intlayer 包
使用您首选的包管理器安装必要的包:
复制代码到剪贴板
--interactive标志是可选的。如果您是 AI 代理,请使用intlayer-cli init。
此命令将检测您的环境并安装所需的包。例如:
复制代码到剪贴板
intlayer
react-intlayer 将 Intlayer 与 React 应用程序集成的包。为 React 国际化提供上下文提供程序和 hooks。
vite-intlayer 包含用于将 Intlayer 与 Vite bundler 集成的 Vite 插件,以及用于检测用户首选语言、管理 cookies 和处理 URL 重定向的 middleware。
配置您的项目
创建一个配置文件来配置您应用程序的语言:
复制代码到剪贴板
通过此配置文件,您可以设置本地化 URL、middleware 重定向、cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表,请参考 配置文档。
在 Vite 配置中集成 Intlayer
将 intlayer 插件添加到您的配置中:
复制代码到剪贴板
intlayer() Vite 插件用于将 Intlayer 与 Vite 集成。它确保构建内容声明文件并在开发模式下监视它们。它在 Vite 应用程序中定义 Intlayer 环境变量。此外,它提供别名来优化性能。
创建根布局
配置您的根布局以支持国际化,使用 useParams 检测当前语言,并在 html 标签上设置 lang 和 dir 属性。
复制代码到剪贴板
创建语言布局
创建一个处理语言前缀并执行验证的布局。
复制代码到剪贴板
在这里,{-$locale}是一个动态路由参数,被替换为当前语言。这种符号使该插槽可选,允许它与路由模式(如'prefix-no-default'等)一起工作。
请注意,如果您在同一路由中使用多个动态段(例如
/{-$locale}/other-path/$anotherDynamicPath/...),此插槽可能会导致问题。 对于'prefix-all'模式,您可能更喜欢将插槽切换为$locale。 对于'no-prefix'或'search-params'模式,您可以完全移除该插槽。
声明您的内容
创建和管理您的内容声明以存储翻译:
复制代码到剪贴板
您的内容声明可以在应用程序中的任何位置定义,只要它们包含在contentDir目录中(默认为./app)。并匹配内容声明文件扩展名(默认为.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml})。
有关更多详情,请参考 内容声明文档。
创建语言感知组件和 Hooks
为语言感知导航创建一个 LocalizedLink 组件:
复制代码到剪贴板
此组件有两个目标:
- 从 URL 中删除不必要的
{-$locale}前缀。 - 将语言参数注入到 URL 中,以确保用户直接重定向到本地化路由。
然后我们可以创建一个 useLocalizedNavigate hook 来进行编程导航:
复制代码到剪贴板
在您的页面中使用 Intlayer
在组件中请默认使用useIntlayer:这是读取内容的推荐方式,编译器会把它解析为当前渲染的语言环境。仅在 React 树之外(路由head、loader 和服务端函数)才使用getIntlayer/getIntlayerAsync。
在整个应用程序中访问您的内容字典:
本地化主页
复制代码到剪贴板
如果您想在
string属性中使用您的内容,例如alt、title、href、aria-label等,您可以使用函数的值,如:html复制代码复制代码到剪贴板
要了解更多关于 useIntlayer hook 的信息,请参考文档。
创建语言切换器组件
创建一个组件来允许用户更改语言:
复制代码到剪贴板
要了解更多关于 useLocale hook 的信息,请参考文档。
HTML 属性管理
如第 5 步所述,您可以在根组件中使用 useParams 来管理 html 标签的 lang 和 dir 属性。这确保在服务器和客户端上设置正确的属性。
复制代码到剪贴板
添加中间件
您也可以使用 intlayerProxy 为您的应用程序添加服务器端路由。该插件将根据 URL 自动检测当前区域设置并设置适当的区域设置 cookie。如果未指定任何区域设置,该插件将根据用户的浏览器语言偏好确定最合适的区域设置。如果未检测到任何区域设置,它将重定向到默认区域设置。
注意,要在生产环境中使用intlayerProxy,您需要将vite-intlayer软件包从devDependencies切换到dependencies。
从 Intlayer v9 开始,intlayerProxy()直接捆绑在intlayer()插件中,并通过routing.enableProxy选项(默认为true)默认启用。如下所示分别注册它现在是可选的:为了向后兼容性和需要控制插件顺序的设置而保留。设置routing.enableProxy: false以选择退出。请参考 v9 发行说明。
复制代码到剪贴板
国际化您的元数据
getIntlayer 针对合并的字典(包含每个声明的区域设置的字典)进行同步解析。head 保持同步,不会等待任何内容,但整个多语言字典被拉入发送到浏览器的路由块中。
复制代码到剪贴板
最适合小型元数据字典、少数几个区域设置或原型设计时使用。
getIntlayerAsync(从 v9.4 开始可用)的行为类似于 getIntlayer,但构建插件将其指向 .intlayer/dynamic_dictionaries/ 中的按区域设置块,而不是合并字典。因此,页面仅发送它呈现的区域设置。由于该块是按需加载的,head 变为 async:
复制代码到剪贴板
如果head读取多个字典,请使用Promise.all解析它们:在自己的行上等待每个getIntlayerAsync会链接请求,而不是并行运行它们。
权衡:动态导入在 head 运行时解析,在文档呈现的关键路径上。在冷路由上,这会将 head 延迟几毫秒,可能会略微降低 LCP。
在路由 loader 中解析字典,然后在 head 中从 loaderData 读取。匹配路由的加载程序并行运行,staleTime: Infinity 告诉 TanStack Router 结果永不过期,因此按区域设置块被解析一次,随后从路由器缓存提供,使 head 保持同步。
复制代码到剪贴板
head可能在加载程序解决之前被调用,因此loaderData的类型可能为undefined。保持可选链接,或返回回退标题。
您保持按区域设置块而不在 head 关键路径上支付其成本。代价是开发者体验:内容必须通过 loaderData 从加载程序显式线程化到 head。
我应该选择哪种解析方式?
在弹窗中打开表格以清晰地查看所有数据
| 静态解析 | 动态解析 | 缓存动态解析 | |
|---|---|---|---|
| API | getIntlayer | getIntlayerAsync (v9.4+) | getIntlayerAsync in loader (v9.4+) |
head 签名 | synchronous | async | synchronous, reads loaderData |
| 传送的语言版本 | every declared locale | requested locale only | requested locale only |
| 客户端导航 | nothing to resolve | re-entered on every match | served from the router cache |
| 开发者体验 | simplest | one await | content threaded through loaderData |
在服务器操作中检索语言
您可能希望从服务器操作或 API 端点内访问当前语言。
您可以使用 intlayer 中的 getLocale 帮助器来实现此目的。
以下是使用 TanStack Start 服务器函数的示例:
复制代码到剪贴板
管理未找到页面
当用户访问不存在的页面时,您可以显示自定义的未找到页面,语言前缀可能会影响未找到页面的触发方式。
本地化首页
如果你想在
string属性中使用你的内容,例如alt、title、href、aria-label等,你可以使用函数的值,如:html复制代码复制代码到剪贴板
要了解更多关于 useIntlayer hook 的信息,请参考文档。
复制代码到剪贴板
要了解更多关于 useLocale hook 的信息,请参考文档。
</Step>
HTML 属性管理
return ( {/* ... _/} ); } {/_ ... */} </html> ); }
export const Route = createFileRoute("/{-$locale}/")({ component: RouteComponent, head: async ({ params }) => { const { locale = defaultLocale } = params; const path = "/"; // The path for this route
复制代码到剪贴板
复制代码到剪贴板
在服务器操作中检索区域设置
你可能想要从服务器操作或 API 端点内访问当前的区域设置。
你可以使用来自 intlayer 的 getLocale helper。
以下是使用 TanStack Start 的服务器函数的示例:
复制代码到剪贴板
`
管理未找到页面
当用户访问不存在的页面时,你可以显示自定义的未找到页面,语言区域前缀可能会影响未找到页面的触发方式。
理解 TanStack Router 的 404 处理与 Locale 前缀
在 TanStack Router 中,处理带本地化路由的 404 页面需要采用多层方法:
- 专用 404 路由:用于显示 404 UI 的特定路由
- 路由级验证:验证 locale 前缀并将无效的前缀重定向到 404
- 捕获所有路由:捕获 locale 段内任何不匹配的路径
复制代码到剪贴板
复制代码到剪贴板
复制代码到剪贴板
提取组件内容
可选如果你有现有的 codebase,转换数千个文件可能会很耗时。
为了简化此过程,Intlayer 提供了一个 compiler / extractor 来转换你的组件并提取内容。
要设置它,你可以在 intlayer.config.ts 文件中添加 compiler 部分:
复制代码到剪贴板
import { type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
// ... 配置的其余部分
compiler: {
/**
* 表示编译器是否应启用。
*/
enabled: true,
/**
* 定义输出文件路径
*/
output: ({ fileName, extension }) => `./${fileName}${extension}`,
/**
* 表示转换后是否应保存组件。
*
* - 如果为 `true`,编译器将在磁盘中重写组件文件。因此转换将是永久的,编译器将在下一个过程中跳过转换。这样,编译器可以转换应用程序,然后可以将其删除。
*
* - 如果为 `false`,编译器将仅在构建输出中注入 `useIntlayer()` 函数调用,并保持 base codebase 完整。转换将仅在内存中完成。
*/
saveComponents: false,
运行提取器以转换组件并提取内容
复制代码到剪贴板
bun x intlayer extract import { defineConfig } from "vite"; import { intlayer, intlayerCompiler } from "vite-intlayer";
export default defineConfig({ plugins: [
复制代码到剪贴板
], });
复制代码到剪贴板
bash packageManager="npm" npm run build # 或 npm run dev
复制代码到剪贴板
bash packageManager="pnpm" pnpm run build # 或 pnpm run dev
复制代码到剪贴板
bash packageManager="yarn" yarn build # 或 yarn dev
复制代码到剪贴板
bash packageManager="bun"
- BLOCK 2 of 3(英文参考):为空
- BLOCK 2 of 3(中文待审核):为空
请提供:
- 英文源文件内容(需要审核的参考版本)
- 中文现有翻译内容(需要更新/修正的版本)
bun run build # 或 bun run dev import { localeFlatMap } from "intlayer"; // ... 其他导入
export default defineConfig({ plugins: [
复制代码到剪贴板
], });
复制代码到剪贴板
`typescript fileName="src/routes/sitemap[.]xml.ts"
export const Route = createFileRoute("/sitemap.xml")({ server: {
复制代码到剪贴板
}, }); { // ... 你现有的配置 include: [
复制代码到剪贴板
], }
Git 配置
建议忽略由 Intlayer 生成的文件。这样可以避免将它们提交到 Git 仓库。
为此,您可以将以下指令添加到您的 .gitignore 文件中:
复制代码到剪贴板
`
VS Code 扩展
为了改进你使用 Intlayer 的开发体验,你可以安装官方的 Intlayer VS Code 扩展。
此扩展提供以下功能:
- 自动完成翻译密钥。
- 实时错误检测缺失的翻译。
- 内联预览已翻译的内容。
- 快速操作轻松创建和更新翻译。
有关如何使用扩展的更多详细信息,请参阅 Intlayer VS Code 扩展文档。
更进一步
要更进一步,您可以实现可视化编辑器或使用CMS外部化您的内容。
