logo
  • 指南
  • 配置
  • 插件
  • API
  • 示例
  • 社区
  • Modern.js 2.x 文档
  • 简体中文
    • 简体中文
    • English
    • 开始
      介绍
      快速上手
      版本升级
      名词解释
      技术栈
      核心概念
      页面入口
      构建工具
      Web 服务器
      基础功能
      路由
      路由基础
      配置式路由
      数据管理
      数据获取
      数据写入
      数据缓存
      渲染
      服务端渲染(SSR)
      服务端流式渲染(Streaming SSR)
      渲染缓存
      静态站点生成(SSG)
      渲染预处理 (Render Preprocessing)
      样式开发
      引入 CSS
      使用 CSS Modules
      使用 CSS-in-JS
      使用 Tailwind CSS
      HTML 模板
      引用静态资源
      引用 JSON 文件
      引用 SVG 资源
      引用 Wasm 资源
      调试
      数据模拟(Mock)
      网络代理
      使用 Rsdoctor
      使用 Storybook
      测试
      Playwright
      Vitest
      Jest
      Cypress
      路径别名
      环境变量
      构建产物目录
      部署应用
      进阶功能
      使用 Rspack
      使用 BFF
      基础用法
      运行时框架
      扩展 BFF Server
      扩展一体化调用 SDK
      文件上传
      跨项目调用
      优化页面性能
      代码分割
      静态资源内联
      产物体积优化
      React Compiler
      提升构建性能
      浏览器兼容性
      配置底层工具
      源码构建模式
      服务端监控
      Monitors
      日志事件
      指标事件
      国际化
      基础概念
      快速开始
      配置说明
      语言检测
      资源加载
      路由集成
      API 参考
      高级用法
      最佳实践
      自定义 Web Server
      专题详解
      模块联邦
      简介
      开始使用
      应用级别模块
      服务端渲染
      部署
      集成国际化能力
      常见问题
      依赖安装问题
      命令行问题
      构建相关问题
      热更新问题
      已下线功能
      📝 编辑此页面
      上一页高级用法下一页自定义 Web Server

      #最佳实践

      #资源文件组织

      建议按以下方式组织资源文件:

      locales/
      ├── en/
      │   ├── translation.json    # 默认命名空间
      │   ├── common.json         # 通用翻译
      │   └── errors.json         # 错误信息
      └── zh/
          ├── translation.json
          ├── common.json
          └── errors.json

      配置多个命名空间:

      export default defineRuntimeConfig({
        i18n: {
          initOptions: {
            ns: ['translation', 'common', 'errors'],
            defaultNS: 'translation',
          },
        },
      });

      使用命名空间:

      import { useTranslation } from 'react-i18next';
      
      function MyComponent() {
        const { t } = useTranslation('common');
      
        return <div>{t('welcome')}</div>;
      }

      #错误处理

      建议在资源加载失败时提供回退方案:

      #检查资源加载状态

      当使用 SDK 后端或需要确保资源已加载时,使用 useModernI18n 中的 isResourcesReady:

      import { useModernI18n } from '@modern-js/plugin-i18n/runtime';
      import { useTranslation } from 'react-i18next';
      
      function MyComponent() {
        const { isResourcesReady } = useModernI18n();
        const { t } = useTranslation();
      
        // 检查资源是否已加载并准备好
        if (!isResourcesReady) {
          return <div>正在加载翻译资源...</div>;
        }
      
        return <div>{t('content', { defaultValue: 'Default content' })}</div>;
      }

      #替代方案:检查 i18next 初始化状态

      对于简单场景,也可以检查 i18next 的初始化状态:

      import { useTranslation } from 'react-i18next';
      
      function MyComponent() {
        const { t, i18n } = useTranslation();
      
        // 检查 i18n 是否已初始化
        if (!i18n.isInitialized) {
          return <div>Loading...</div>;
        }
      
        return <div>{t('content', { defaultValue: 'Default content' })}</div>;
      }
      Tip

      对于 SDK 后端场景,isResourcesReady 更准确,因为它会检查所有必需的资源是否实际已加载,而不仅仅是检查实例是否已初始化。

      #类型安全

      为翻译键添加类型定义,提高开发体验:

      // types/i18n.d.ts
      import 'react-i18next';
      
      declare module 'react-i18next' {
        interface CustomTypeOptions {
          defaultNS: 'translation';
          resources: {
            translation: {
              hello: string;
              world: string;
              welcome: string;
            };
            common: {
              submit: string;
              cancel: string;
            };
          };
        }
      }

      使用类型安全的翻译:

      import { useTranslation } from 'react-i18next';
      
      function MyComponent() {
        const { t } = useTranslation();
      
        // TypeScript 会检查键是否存在
        return <div>{t('hello')}</div>; // ✅ 类型安全
        // return <div>{t('invalid')}</div>; // ❌ TypeScript 错误
      }