@eggjs/i18n

@eggjs/i18n

可以为你的应用提供多语言的特性

功能

• 支持多种语言独立配置，统一存放在 config/locale/*.js 下（ 兼容 config/locales/*.js ）；
• 提供 Middleware 为 View 提供 \_\_, gettext 函数获取多语言文案；
• 基于 URL 参数 locale 修改语言显示，同时会记录到 Cookie，下次请求会用 Cookie 里面的语言方案。

配置

egg 内置插件 i18n 默认开启。

你可以修改 config/config.default.ts 来设定 i18n 的配置项：

// config/config.default.ts
export default {
  i18n: {
    // 默认语言，默认 "en_US"
    defaultLocale: 'zh_CN',
    // URL 参数，默认 "locale"
    queryField: 'locale',
    // Cookie 记录的 key, 默认："locale"
    cookieField: 'locale',
    // Cookie 的 domain 配置，默认为空，代表当前域名有效
    cookieDomain: '',
    // Cookie 默认 `1y` 一年后过期， 如果设置为 Number，则单位为 ms
    cookieMaxAge: '1y',
  },
};

其实大部分时候，你只需要修改一下 defaultLocale 设定默认的语言。

编写你的 I18n 多语言文件

// config/locale/zh-CN.ts
export default {
  Email: '邮箱',
  'Welcome back, %s!': '欢迎回来，%s!',
  'Hello %s, how are you today?': '你好 %s, 今天过得咋样？',
};

// config/locale/en-US.ts
export default {
  Email: 'Email',
};

或者也可以用 JSON 格式的文件：

// config/locale/zh-CN.json
{
  "email": "邮箱",
  "login": "帐号",
  "createdAt": "注册时间"
}

使用 I18n 函数获取语言文本

I18n 为你提供 __ (Alias: gettext) 函数，让你可以轻松获得 locale 文件夹下面的多语言文本。

NOTE: __ 是两个下划线哦！

• ctx.__ = function (key, value[, value2, ...]): 类似 util.format 接口
• ctx.__ = function (key, values): 支持数组下标占位符方式，如

ctx.__('{0} {0} {1} {1}', ['foo', 'bar']);
ctx.gettext('{0} {0} {1} {1}', ['foo', 'bar']);

=>
foo foo bar bar

Controllers 下的使用示例

export default ctx => {
  ctx.body = {
    message: ctx.__('Welcome back, %s!', ctx.user.name)
    // 或者使用 gettext，如果觉得 __ 不好看的话
    // message: this.gettext('Welcome back, %s!', ctx.user.name)
    user: ctx.user,
  };
};

HttpController 下的使用示例

import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPContext, Context } from 'egg';

@HTTPController()
export default class I18nController {
  @HTTPMethod({ method: HTTPMethodEnum.GET, path: '/i18n' })
  async getI18n(@HTTPContext() ctx: Context) {
    return { message: ctx.__('Welcome back, %s!', ctx.user.name) };
  }
}

View 文件下的使用示例

<li>{{ __('Email') }}: {{ user.email }}</li>
<li>{{ __('Hello %s, how are you today?', user.name) }}</li>
<li>{{ __('{0} {0} {1} {1}', ['foo', 'bar']) }}</li>

修改应用的默认语言

你可以用下面几种方式修改应用的当前语言（修改或会记录到 Cookie），下次请求直接用设定好的语言。

优先级从上到下：

• query: /?locale=en-US
• cookie: locale=zh-TW
• header: Accept-Language: zh-CN,zh;q=0.5

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

Made with contributors-img.