---
url: /zh-CN/core/i18n.md
---
# 国际化（I18n）

为了方便开发多语言应用，框架内置了国际化（I18n）支持，由 [@eggjs/i18n](https://github.com/eggjs/egg/tree/next/plugins/i18n) 插件提供。

## 默认语言

默认语言是 `en-US`。如果我们想修改默认语言为简体中文，可以进行以下设置：

```js
// config/config.default.js
exports.i18n = {
  defaultLocale: 'zh-CN',
};
```

## 切换语言

我们可以通过下面几种方式修改应用的当前语言（修改后会记录到 `locale` 这个 Cookie），下次请求会直接使用设定好的语言。优先级从高到低依次是：

1. query: `/?locale=en-US`
2. cookie: `locale=zh-TW`
3. header: `Accept-Language: zh-CN,zh;q=0.5`

如果需要修改 query 或 Cookie 参数名称，可以按照如下方式配置：

```js
// config/config.default.js
exports.i18n = {
  queryField: 'locale',
  cookieField: 'locale',
  // Cookie 默认一年后过期, 如果设置为 Number，则单位为 ms
  cookieMaxAge: '1y',
};
```

## 编写 I18n 多语言文件

不同语言的配置文件是独立存放的，统一放置在 `config/locale/*.js` 目录下。例如：

```
- config/locale/
  - en-US.js
  - zh-CN.js
  - zh-TW.js
```

无论是在应用目录、框架还是插件的 `config/locale` 目录下，设置都是同样生效的。注意单词的拼写应该是 locale，而不是 locals。

例如，可以这样配置中文语言文件：

```js
// config/locale/zh-CN.js
module.exports = {
  Email: '邮箱',
};
```

也可以使用 JSON 格式的语言文件：

```json
// config/locale/zh-CN.json
{
  "Email": "邮箱"
}
```

## 获取多语言文本

我们可以使用 `__`（别名：`gettext`）函数获取 locale 文件夹下面的多语言文本。

**注意：`__` 是两个下划线。**

以上面配置过的多语言为例：

```js
ctx.__('Email');
// zh-CN => 邮箱
// en-US => Email
```

如果文本中含有 `%s`、`%j` 等 format 函数，可以按照 [`util.format()`](https://nodejs.org/api/util.html#util_util_format_format_args) 类似的方式调用：

```js
// config/locale/zh-CN.js
module.exports = {
  'Welcome back, %s!': '欢迎回来，%s！',
};

ctx.__('Welcome back, %s!', 'Shawn');
// zh-CN => 欢迎回来，Shawn！
// en-US => Welcome back, Shawn!
```

同时支持数组下标占位符方式，例如：

```js
// config/locale/zh-CN.js
module.exports = {
  'Hello {0}! My name is {1}.': '你好 {0}！我的名字叫 {1}。',
};

ctx.__('Hello {0}! My name is {1}.', ['foo', 'bar']);
// zh-CN => 你好 foo！我的名字叫 bar。
// en-US => Hello foo! My name is bar.
```

### Controller 中使用

```js
class HomeController extends Controller {
  async index() {
    const ctx = this.ctx;
    ctx.body = {
      message: ctx.__('Welcome back, %s!', ctx.user.name),
      // 或者使用 gettext，gettext 是 `__` 函数的别名
      // message: ctx.gettext('Welcome back', ctx.user.name)
      user: ctx.user,
    };
  }
}
```

### View 中使用

假设我们使用的模板引擎是 [Nunjucks](https://github.com/eggjs/egg-view-nunjucks)。

```html
<li>{{ __('Email') }}：{{ user.email }}</li>
<li>{{ __('Welcome back, %s!', user.name) }}</li>
<li>{{ __('Hello {0}! My name is {1}.', ['foo', 'bar']) }}</li>
```