Skip to content

6. 国际化

6.1. 示例 16:双语应用

在 [NestJS] 课程中,服务器在发送页面之前就把它们翻译好了。这里,翻译在 浏览器中 使用 [vue-i18n] 库完成,切换语言不再需要与服务器进行任何交互。

6.1.1. 词典

每种语言一个词典,采用 JSON 格式。每段文本都有一个 键 ([HOME.HELLO]):

{
  "APP": {
    "TITLE": "Exemple 16 - une application en deux langues",
    "LANGUAGE": "Langue"
  },
  "HOME": {
    "HELLO": "Bonjour {name} !",
    "TODAY": "Nous sommes le {date}.",
    "PRICE": "Une consultation coûte {price}.",
    "APPOINTMENTS": "aucun rendez-vous | un rendez-vous | {n} rendez-vous",
    "ADD": "Ajouter un rendez-vous",
    "REMOVE": "En retirer un"
  },
  "ERRORS": {
    "LOGIN_TAKEN": "Ce login est déjà utilisé par un autre compte.",
    "TOO_MANY_ATTEMPTS": "Trop de tentatives infructueuses. Réessayez dans {minutes} minute(s)."
  },
  "SERVER": {
    "TITLE": "Traduire une réponse du serveur",
    "EXPLANATION": "Le serveur RdvMedecins ne renvoie que des clés. C'est le client qui les traduit :"
  }
}
{
  "APP": {
    "TITLE": "Example 16 - a two-language application",
    "LANGUAGE": "Language"
  },
  "HOME": {
    "HELLO": "Hello {name}!",
    "TODAY": "Today is {date}.",
    "PRICE": "A consultation costs {price}.",
    "APPOINTMENTS": "no appointment | one appointment | {n} appointments",
    "ADD": "Add an appointment",
    "REMOVE": "Remove one"
  },
  "ERRORS": {
    "LOGIN_TAKEN": "This login is already used by another account.",
    "TOO_MANY_ATTEMPTS": "Too many failed attempts. Try again in {minutes} minute(s)."
  },
  "SERVER": {
    "TITLE": "Translating a server response",
    "EXPLANATION": "The RdvMedecins server only sends keys. The client translates them:"
  }
}
  • 第 7 行:[{name}] 是消息的 参数;
  • 第 10 行:一条 复数消息:它的各种形式用 [|] 分隔(零个、一个、多个);[{n}] 是数量;
  • 第 14–17 行:这些是 服务器在其错误响应中返回的相同的键(见下一章)。

6.1.2. 配置

// =========================================================================
// 16-i18n/src/i18n.ts - vue-i18n 的配置
// -------------------------------------------------------------------------
// vue-i18n 是 Vue.js 的翻译库。我们向它提供:
//   - 每种语言一个词典(文件 locales/fr.json、locales/en.json),
//     其中每段文本都有一个键("HOME.HELLO");
//   - 起始语言(这里是:存储在 localStorage 中的语言,否则是
//     浏览器的语言,再否则是英语);
//   - 每种语言特有的日期和数字格式。
// 在组件中,t('HOME.HELLO', { name: 'Marie' }) 返回
// 当前语言的文本;切换语言会更新整个页面。
//
// 这在客户端与 NestJS 课程是同一个原理(词典
// i18n/*.json + 辅助函数 {{t}})——但现在翻译在
// 浏览器中完成,切换语言不再需要服务器做任何事。
// =========================================================================

import { createI18n } from 'vue-i18n';
import fr from './locales/fr.json';
import en from './locales/en.json';

export type Language = 'fr' | 'en';
export const LANGUAGE_KEY = 'example16.language';

function initialLanguage(): Language {
  const stored = localStorage.getItem(LANGUAGE_KEY);
  if (stored === 'fr' || stored === 'en') {
    return stored;
  }
  return navigator.language.startsWith('fr') ? 'fr' : 'en';
}

// 消息的类型:取自英语词典(“模型”)
type Messages = typeof en;

export const i18n = createI18n<[Messages], Language>({
  legacy: false, // “组合式” API(useI18n),即 <script setup> 所用的 API
  locale: initialLanguage(),
  fallbackLocale: 'en', // 法语中缺少的键:使用英语的那个
  messages: { fr, en },
  // d(date, 'long') 和 n(number, 'euros'):每种语言特有的格式
  datetimeFormats: {
    fr: { long: { dateStyle: 'full' } },
    en: { long: { dateStyle: 'full' } },
  },
  numberFormats: {
    fr: { euros: { style: 'currency', currency: 'EUR' } },
    en: { euros: { style: 'currency', currency: 'EUR' } },
  },
});
  • 第 19 行:[Vite] 可以导入 JSON 文件:得到的是一个对象;
  • 第 25–31 行:存储在 [localStorage] 中的语言,否则使用浏览器的语言([navigator.language]),再否则使用英语;
  • 第 36–50 行:配置对象:
    • [legacy: false]:组合式 API([useI18n]),即 [<script setup>] 所用的 API;
    • [fallbackLocale: 'en']:法语词典中缺少的键会取自英语词典;
    • [datetimeFormats]、[numberFormats]:每种语言特有的日期和数字格式。
1
2
3
4
5
6
7
import { createApp } from 'vue';
import 'bootstrap/dist/css/bootstrap.min.css';
import App from './App.vue';
import { i18n } from './i18n';

// app.use(i18n):t()、d()、n() 在所有组件中都可用
createApp(App).use(i18n).mount('#app');

6.1.3. 页面

<!--
  =========================================================================
  16-i18n/src/App.vue - a translated page
  -------------------------------------------------------------------------
    - t('KEY')                  a text;
    - t('KEY', { name: ... })   a text with parameters ({name} in the dictionary);
    - t('KEY', n)               a plural: "none | one | {n}" depending on n;
    - d(date, 'long')           a date, in the format of the language;
    - n(number, 'euros')        a number, in the format of the language;
    - locale                    the current language: modifying it translates everything again.
  =========================================================================
-->
<script setup lang="ts">
import { ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { LANGUAGE_KEY, type Language } from './i18n';

const { t, d, n, locale } = useI18n();
const count = ref(2);

// 每次切换语言时:它会被保存,并且页面的 lang 属性会
// 被更新(这对屏幕阅读器、拼写检查器很有用)
watch(
  locale,
  (language) => {
    localStorage.setItem(LANGUAGE_KEY, language);
    document.documentElement.lang = language;
    document.title = t('APP.TITLE');
  },
  { immediate: true },
);

function choose(language: Language): void {
  locale.value = language;
}

// RdvMedecins 服务器将返回的内容(见黑盒一章)
const serverResponses = [
  { statusCode: 409, key: 'ERRORS.LOGIN_TAKEN' },
  { statusCode: 429, key: 'ERRORS.TOO_MANY_ATTEMPTS', params: { minutes: '15' } },
];
</script>

<template>
  <div class="container py-4" style="max-width: 720px">
    <div class="d-flex justify-content-between align-items-center mb-3">
      <h1 class="h3 mb-0">{{ t('APP.TITLE') }}</h1>
      <div class="btn-group btn-group-sm" role="group" :aria-label="t('APP.LANGUAGE')">
        <button class="btn" :class="locale === 'fr' ? 'btn-primary' : 'btn-outline-primary'" @click="choose('fr')">FR</button>
        <button class="btn" :class="locale === 'en' ? 'btn-primary' : 'btn-outline-primary'" @click="choose('en')">EN</button>
      </div>
    </div>

    <div class="card p-3 mb-3">
      <p>{{ t('HOME.HELLO', { name: 'Marie' }) }}</p>
      <p>{{ t('HOME.TODAY', { date: d(new Date(), 'long') }) }}</p>
      <p>{{ t('HOME.PRICE', { price: n(1234.5, 'euros') }) }}</p>
      <!-- t(key, number) 选择正确的复数形式 -->
      <p class="fw-bold">{{ t('HOME.APPOINTMENTS', count) }}</p>
      <div class="d-flex gap-2">
        <button class="btn btn-sm btn-outline-success" @click="count++">{{ t('HOME.ADD') }}</button>
        <button class="btn btn-sm btn-outline-secondary" :disabled="count === 0" @click="count--">{{ t('HOME.REMOVE') }}</button>
      </div>
    </div>

    <div class="card p-3">
      <h2 class="h6">{{ t('SERVER.TITLE') }}</h2>
      <p>{{ t('SERVER.EXPLANATION') }}</p>
      <ul class="mb-0">
        <li v-for="r in serverResponses" :key="r.key">
          <code>{{ JSON.stringify(r) }}</code><br>
          <!-- 服务器的键就是词典中的键;params 提供它的参数 -->
          &rarr; {{ t(r.key, r.params ?? {}) }}
        </li>
      </ul>
    </div>
  </div>
</template>
  • 第 18 行:翻译工具:
    • [t(key, params)]:一段文本;
    • [t(key, n)]:一个复数形式;
    • [d(date, 'long')]:一个日期,采用该语言的格式;
    • [n(number, 'euros')]:一个数字,采用该语言的格式;
    • [locale]:当前语言,一个 [ref]。更改它会让整个页面重新翻译;
  • 第 23–30 行:每次切换语言时,所选语言会被保存,并且页面的 [lang] 属性会被更新(这对屏幕阅读器和拼写检查器很有用);
  • 第 38–41 行:两个错误响应,与 [RdvMedecins] 服务器返回的一致;
  • 第 73 行:服务器发送的键就是词典中的键;它的参数就是消息的参数。

法语(法语浏览器):

Image

英语,点击“Add an appointment”之后:

Image