Vue3 + element-plus 国际化

前言

本案适用于 Vue3+ element-plus 项目国际化的实现，支持多种语言，其中包括了常规内容的国际化和 element-plus 的国际化

插件：i18n 、vue-i18n

官方案例：https://element-plus.gitee.io/zh-CN/guide/i18n.html

1.安装插件

安装 i18n

npm install i18n

安装 vue-i18n

npm install vue-i18n

2.文件配置

当前案例实现的是中文和英文两种语言的切换，以下文件只配置两种语言，你可以根据自己实际情况配置更多语种

2.1 新建 lang 文件夹 和 watch-local-storage.js 语言持久化函数工具文件

在 src 文件夹在新建  lang 文件夹，文件夹内分别新建 i18n.js 、 index.js、 en.js、 zh-cn.js 四个 js 文件，如下

├── src                                   
│   │── lang  [国际化文件夹]                          
│   │   │── index.js  [输出文件]               
│   │   │── i18n.js   [国际化配置]                                
│   │   │── zh-cn.js  [中文]                                          
│   │   │── en.js     [英文]
|   |——util [工具库文件]
|   |   |——watch-local-storage.js      

2.2 文件夹配置

在 zh-cn.js  文件中写入

const zhCN = {
  message: {
    Hello: "您好",
    WelcomeToSiipAdmin: "欢迎来到钢构管家运营大厅",
  },
};
export default zhCN;

 在 en.js 文件中写入

const en = {
  message: {
    Hello: "Hello",
    WelcomeToSiipAdmin: "Welcome to the steel structure butler operation hall",
  },
};
export default en;

 在 index.js 文件中写入

import en from "./en";
import zhCN from "./zh-cn";
export default {
  en,
  zhCN,
};

 在 i18n.js 文件中写入

import { createApp } from "vue";
import App from "../App.vue";
import { createI18n } from "vue-i18n";
import messages from "./index";
const app = createApp(App);
/**
 * locale  持久化配置
 */
const locale = localStorage.getItem("locale")
  ? localStorage.getItem("locale") === "zh-cn"
    ? "zhCN"
    : "en"
  : "zhCN";
const i18n = createI18n({
  legacy: false,
  locale,
  messages,
});
export default function (app) {
  app.use(i18n);
}

在 watch-local-storage.js 文件中写入

/* 监听localStorage 变化 */
export const dispatchEventStorage = () => {
  const signSetItem = localStorage.setItem;
  localStorage.setItem = function (key, val) {
    let setEvent = new Event("setItemEvent");
    setEvent.key = key;
    setEvent.newValue = val;
    window.dispatchEvent(setEvent);
    signSetItem.apply(this, arguments);
  };
};
/* 设置localStorage locale 语言版本  */
export const languageSet = () => {
  if (localStorage.getItem("locale")) {
    return localStorage.getItem("locale");
  }
  return localStorage.setItem("locale", "zhCN");
};

2.3 全局注册

在 main.ts  文件中

import App from "./App.vue";
import { createApp } from "vue";
import ElementPlus from "element-plus";
import locale from "element-plus/dist/locale/zh-cn.mjs";
import I18n from "@/lang/i18n.js"; // 引入
const app = createApp(App);
app.use(ElementPlus, {
  locale,
});
app.use(I18n); //挂载
app.mount("#app");

到这里，国际化 `i18n` 的基本配置已经完成了，但是这不包括 `element-plus` 的国际化，而 `element-plus` 的国际化是要引入对应语言包，然后修改 `locale` 的值即可，后面详细讲

3.使用方法

如以上的配置你准确无误的配置好了，那么你可以在你的 `vue` 文件的 `template` 标签中使用 `$t()` 了

{{ $t('message.Hello') }}，{{ $t('message.WelcomeToSiipAdmin') }}

4.语言切换

语言切换包括两点:

一、我们自己配置的语言切换

二、element-plus 组件语言的切换

4.1 在切换语言的 vue 文件的 template 标签内

 此处可根据实际 ui 自定义你自己的标签

  {{ locale === 'en' ? '英文' : '中文' }}
  

4.2 在切换语言的 vue 文件的 script 标签内

5.持久化配置

以上步骤你会发现一些持久化配置代码已经有在写了，但是切换的时候好像 element-plus 组件的语言没有跟随切换，我们还缺少这一步

在 app.vue 文件中写入以下代码

结语

前端国际化已经是很常见的开发需求了，所以也是作为一个前端开发工程师应有的必备技能。而项目完整的国际化是涉及常规内容的国际化和组件的国际化的，并且有持久化的应用场景需求的。

如果你能跟着步骤实现项目的持久化功能，请为我点赞

欢迎大家的及时指正，共同进步