Vue3 如何接入 i18n 實現國際化多語言

‍ 寫在開頭點贊 + 收藏學會理解 forEach JavaScript 的forEach方法是一種流行的數組迭代工具。它為每個數組元素執行一次提供的函數。但是，與傳統的for 和 while迴圈不同，forEach它被設計為對每個元素執行該函數，沒有內置機制來提前停止或中 ...

1. 基本方法

在 Vue.js 3 中實現網頁的國際化多語言，最常用的包是 vue-i18n，通常我們會與 vue-i18n-routing 一起使用。

vue-i18n 負責根據當前頁面的語言渲染文本占位符，例如：

<span>{{ t('Login') }}</span>

當語言設置為中文時，會將 Login 渲染為“登錄”。

vue-i18n-routing 負責將頁面語言與 URL 綁定，例如：

https://githubstar.pro/zh-CN/repo

表示訪問中文版的 /repo 路徑。

將不同語言的網頁放在不同的 URL 下有助於 SEO，因為可以在 <head> 部分添加語言信息，增加不同語言被搜索引擎索引的概率。

Google 對於多語言 Vue 站點的爬取機制如下：

類似 Vue 站點的 JS 動態頁面是可以被爬取的，不影響權重 (參見 Google SEO)。
與用戶首選語言匹配的頁面將優先展示 (參見 Google SEO)。

2. 基礎實現

第一步，安裝一個 Vite 下使用 <i18n> 標簽的插件：unplugin-vue-i18n。

然後調整 vite.config.js：

import { fileURLToPath, URL } from 'node:url';
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import VueDevTools from 'vite-plugin-vue-devtools';
import VueI18nPlugin from '@intlify/unplugin-vue-i18n/vite';

export default defineConfig({
  plugins: [
    vue(),
    VueDevTools(),
    VueI18nPlugin({}),
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url)),
    },
  },
});

添加插件後，我們可以在組件內使用 <i18n> 塊：

<script setup lang="ts">
import { useI18n } from 'vue-i18n';

const { t, locale } = useI18n({ inheritLocale: true, useScope: 'local' });
</script>

<template>
  <span>{{ t('Login') }}</span>
</template>

<i18n lang="yaml">
en:
  Login: 'Login to web'
zh-CN:
  Login: '登錄'
</i18n>

這裡我們定義了兩種不同的語言。

3. 路徑綁定

接下來，我們需要定義使用 URL 作為當前語言，編輯 router/index.ts：

import { createRouter as _createRouter, type RouteLocationNormalized } from 'vue-i18n-routing';
import { createWebHistory } from 'vue-router';
import HomeView from '@/views/HomeView.vue';

const locales = [
  {
    code: 'en',
    iso: 'en-US',
    name: 'English',
  },
  {
    code: 'zh-CN',
    iso: 'zh-CN',
    name: '中文',
  },
];

export function createRouter(i18n: any) {
  const router = _createRouter(i18n, {
    version: 4,
    locales: locales,
    defaultLocale: 'zh-CN',
    history: createWebHistory(import.meta.env.BASE_URL),
    routes: [
      {
        path: '/home',
        name: 'home',
        component: HomeView,
      },
    ],
  });
  return router;
}

我們定義了支持的語言種類，並將原來的 routes 包裝起來，vue-i18n-routing 會自動生成所有支持語言的 routes：

/home = 中文
/en/home = 英文

由於我們設置了 defaultLocale: 'zh-CN'，預設路徑為中文。

然後，我們需要將源代碼中涉及跳轉的部分，例如：

router.push({ name: 'home' });

全部加上 localePath，表示是當前語言的 URL 路徑下：

import { useLocalePath } from 'vue-i18n-routing';

const localePath = useLocalePath();

router.push(localePath({ name: 'home' }));

這樣就完成了路徑綁定。

4. 自動切換

有時，我們希望沒有預設語言，而是根據用戶的瀏覽器語言自動選擇：

/zh-CN/home = 中文
/en/home = 英文
/home -> 重定向 (瀏覽器偏好中文) -> /zh-CN/home = 中文
/home -> 重定向 (瀏覽器偏好英文) -> /en/home = 英文

這時我們需要定義一個 store，這裡使用 Pinia store，Vuex 同理。

import { usePreferredLanguages, useStorage } from '@vueuse/core';
import { defineStore } from 'pinia';

export const useLangStore = defineStore('lang', {
  state: () => {
    const savedLang = useStorage<string | null>('lang', null, undefined);
    const systemLang = usePreferredLanguages();
    return { savedLang, systemLang };
  },
  getters: {
    lang: (state) => {
      const lang = state.savedLang || state.systemLang[0];
      if (lang.startsWith('zh')) {
        return 'zh-CN';
      } else {
        return 'en';
      }
    },
  },
  actions: {
    setLang(l?: string) {
      if (!l) {
        this.savedLang = null;
      } else {
        this.savedLang = l;
      }
    },
  }
});

這段代碼使用了 VueUse 中的 usePreferredLanguages 來獲得用戶偏好的瀏覽器語言，並用 useStorage 添加了一個 LocalStorage 中的存儲項。

邏輯是：如果用戶手動設定了語言（savedLang），則使用之；如果沒有，則使用系統偏好的第一個語言。這樣，我們只要取 lang 的值就可以得到最終的偏好語言是中文還是英文。

然後，我們需要定義一個路徑守衛，以自動處理 URL 中沒有語言的情況。

import { createRouter as _createRouter, type RouteLocationNormalized } from 'vue-i18n-routing';
import { createWebHistory } from 'vue-router';
import HomeView from '@/views/HomeView.vue';

const locales = [
  {
    code: 'en',
    iso: 'en-US',
    name: 'English',
  },
  {
    code: 'zh-CN',
    iso: 'zh-CN',
    name: '中文',
  },
  {
    code: '',
    iso: '',
    name: '',
  }
];

export function createRouter(i18n: any) {
  const router = _createRouter(i18n, {
    version: 4,
    locales: locales,
    history: createWebHistory(import.meta.env.BASE_URL),
    routes: [
      {
        path: '/home',
        name: 'home',
        component: HomeView,
      },
    ],
  });
  router.beforeEach((to: RouteLocationNormalized, from: RouteLocationNormalized) => {
    const lang = useLangStore();
    const pathLocale = to.path.split('/')[1];
    if ((!pathLocale) || (!locales.some(locale => locale.code === pathLocale))) {
      return `/${lang.lang}${to.path}`;
    }
  });
  return router;
}

這裡需要註意三點：

我們增加了一個新的空 locales，這樣請求才能到達 router.beforeEach。
我們去掉了 defaultLocale。
使用剛纔定義的 store：useLangStore() 這行代碼必須放在 router.beforeEach 中，而不能放在模塊頂端，因為載入模塊時 Pinia 還沒有啟動。

這樣，就實現了無語言路徑自動跳轉到當前偏好語言路徑。

5. 導航欄切換按鈕

然後，可以在導航欄增加一個按鈕，來手動切換語言，例如：

<script setup lang="ts">
import { useLocalePath, useSwitchLocalePath } from 'vue-i18n-routing';
import { useLangStore } from '@/stores/lang';

const lang = useLangStore();
const { t, locale } = useI18n({ inheritLocale: true, useScope: 'local' });
</script>

<template>
<div
  @click="
    lang.setLang('en');
    router.push(switchLocalePath('en'));
    menuShown = '';
  "
  class="py-2 px-2 gap-2 flex items-center cursor-pointer hover:bg-slate-400/10"
  :class="{ 'text-sky-300': locale == 'en' }"
  role="option"
  tabindex="-1"
  :aria-selected="locale == 'en'"
>
  <IconEnglish class="w-5 h-5 text-slate-400 dark:text-slate-200" />
  English
</div>
<div
  @click="
    lang.setLang('zh-CN');
    router.push(switchLocalePath('zh-CN'));
    menuShown = '';
  "
  class="py-2 px-2 gap-2 flex items-center cursor-pointer hover:bg-slate-400/10"
  :class="{ 'text-sky-300': locale == 'zh-CN' }"
  role="option"
  tabindex="-1"
  :aria-selected="locale == 'zh-CN'"
>
  <IconChinese class="w-5 h-5 text-slate-400 dark:text-slate-200" />
  中文
</div>
</template>

這裡，我們在剛纔定義的 store 中存儲當前手動設定的語言，同時使用 switchLocalePath 來實現路徑和語言的切換。

6. SEO 和 Head Meta

同一內容的不同語言版本應該在 head 中進行標註，並指向所有其他替代頁面（參見 Google SEO）。這裡我們可以在 App.vue 中用 useLocaleHead 和來自 @unhead/vue 包的 useHead 進行設置：

import { useLocaleHead } from 'vue-i18n-routing';
import { useHead } from '@unhead/vue';

const i18nHead = useLocaleHead({ addSeoAttributes: true, defaultLocale: null, strategy: null });

onMounted(() => {
  useHead({
    htmlAttrs: computed(() => ({
      lang: i18nHead.value.htmlAttrs!.lang,
    })),
    link: computed(() => [...(i18nHead.value.link || [])]),
    meta: computed(() => [...(i18nHead.value.meta || [])]),
  });
});

這樣就基本實現了一個多語言的國際化站點。可能在進行前端翻譯的同時，後端也需要進行翻譯，請期待下一期：Python Flask 後端如何接入 i18n 實現國際化多語言！

6. 案例分析

案例：GithubStar.Pro 的前端界面國際化多語言，是使用本文所述的方法實現的，各位可以看看效果。

也歡迎各位使用 GithubStar.Pro 互贊平臺，提高您的開源項目知名度，收穫更多用戶。