• 售前

  • 售后

热门帖子
入门百科

Vue.js项现在端多语言方案的思路与实践

[复制链接]
顺势而为47 显示全部楼层 发表于 2021-8-14 14:21:44 |阅读模式 打印 上一主题 下一主题
目次


  • 一、通常有哪些内容必要处理
  • 二、基本思路
  • 三、详细实践中的一些细节

    • 1、获取当前应该采用何种语言的getLang模块的实现
    • 2、Vux组件的多语言包的设置
    • 3、vux-loader的设置
    • 4、自定义组件表里文案的多语言化
    • 5、vuex-i18n的实现
    • 6、图片的多语言化
    • 7、在当前页面通过按钮切换当前语言后,怎样更新当前页面的内容?
    • 8、Yaml中特别字符的转义

  • 总结
前端的国际化是一个比力常见的需求。但网上关于这一方面的直接可用的方案却不多。最近刚做了一版基于Vue.js的多语言实现,在此简单作一小结。

一、通常有哪些内容必要处理


总的来说,一个Web应用中,必要做多语言切换的内容常见的包括如下方面:
1、模板中的内容,如Vue.js的<template>标签中的笔墨内容
2、JS代码中的笔墨内容
3、图片中的文案内容
4、页面title
5、第三方组件中的文案(比如,我的项目中用到了Vux的组件)
6、后端接口中必要展示到前端的数据内容
7、后端接口返回的错误提示

二、基本思路


1、起首,必要确定以什么样的方式来获取到当前应该展示何种语言
我采用的是用URL传递?lang=en大概?lang=zh-CN如许的传递参数的情势。如许做的好处在于可以通过链接指定用哪种语言。但是,只依赖于地点栏参数也是不方便的。比如,在页面跳转的时间,这个地点栏参数可能就丢失了。这会导致你在页面跳转之后就不知道该用哪种语言展示了。而抱负的的方式应该是,进入某个页面的时间带有这个参数(这个时间就获取到该利用何种语言了),等再跳转到其它页面的时间就不必再带这个lang参数了,因为此时你已经知道该用哪种语言了。所以,应该在一进入第一个页面的时间就把这个参数存下来,比如,存在localstorage中,存在vuex的state中。
这里,就引出来一个语言判定的优先级题目。
因为地点栏里可能有lang参数,localstorage中可能也有干系的存储字段(因为前次访问过本应用),你可能还想设置默认的降级语言,等等。其优先级应该如那里理呢?
精确的优先级应该是:
先看地点栏参数中有没有;
再看localstorage中有没有;
然后再通过navigator.language获取浏览器默认语言,看是否是你的应用所支持的语言,假如,则采用之;
末了才是利用回退语言(例如,比力通用的英语)。
固然,你可以根据你的需求来做一些简化。
2、其次,采用什么工具来解决语言转换和打包的题目?
(1)i18n干系工具的选择——由谁来提供多语言转换函数(通常是$t)?
目前国际化通用方式多数基于i18n,我们也无需再去造轮子了。但就i18n的详细利用上,有很多不同的NPM模块。比如vuex-i18n、vue-i18n、simplest-i18n等。因为多数复杂一点的项目都会上vuex,所以复杂一点的项目选择vuex-i18n会比vue-i18n更方便。
而simplest-i18n这个很小众的模块,其实也有它的好处。它支持下面如许的写法:
在模板中:
  1. <span>$t('真实姓名', 'Real Name')</span>
复制代码
大概在JS中:
  1. this.$t('真实姓名', 'Real Name')
复制代码
即将语言写在一起,$t函数的每一个参数都是一种语言,一清二楚,还是比力方便阅读的。对小项目来说,不失为一种选择。
其基本利用如下:
t.js文件:
  1. import i18n from 'simplest-i18n';
  2. import getLang from '../../getLang';
  3. const t = i18n({
  4.   locale: getLang.lang, // 当前语言
  5.   locales: getLang.langs // 支持的语言列表
  6. });
  7. export default t;
复制代码
然后在应用的入口文件中对Vue.js举行扩展:
  1. import t from './t';
  2. Vue.$t = Vue.prototype.$t = t;
复制代码
如许就把$t这个方法挂载到了Vue.js的全局。Vue实例中也可以通过this.$t访问到,利用上还是非常简单的。
但是,对于大项目来说,把语言包都写在代码里面,对维护并不友爱。而且,靠它也解决不了我所用到的Vux组件的多语言化的题目。
所以终极,我选择了vuex-i18n作为基础。
(2)组织和处理语言包的工具——语言包怎么组织,怎么打包处理?
对于这个题目,我起首必要解决Vux第三方组件的多语言化题目。
起首,在语言包的组织方面,比力常见的是写成JSON设置文件。不过,我终极采用了Yaml这种格式,它支持将多语言字段写在一起。比如:
config.yml
  1. confirm:
  2.   zh-CN: 确认
  3.   en: confirm
复制代码
而不是像下面那样将一个字段的多语言拆成几处,比如:
  1. confirm: 确认
复制代码
  1. confirm: confirm
复制代码
如许带来的好处就是,可以方便地对照一个字段的不同语言版本,而且要修改或删除某一个字段时,也可以在一处完成,无需切换。况且,Yaml文件的语法也更加简单明白,省去了JSON文件必须写双引号、不可以出现解释等诸多麻烦。
其次,在语言包的打包方面,我找到了vux-loader。它可以和现有的webpack设置团结,不但能完成Vux组件多语言设置的打包,还答应在自定义的Vue组件中利用<i18n>标签。比如,在自定义组件中我可以这么写:
  1. <i18n>confirm:
  2.   zh-CN: 确认
  3.   en: confirm<i18n>
复制代码
打包时,vux-loader会将<i18n>标签中的多语言设置信息导出至我们所设置的一个Yaml文件中,而把<i18n>标签从我们的自定义组件中移除。
那么,对于Yaml文件如那里理呢?可以用json-loader和yaml-loader。它们可以将Yaml文件转换成我们所必要的json格式,方便在JS函数中利用,就像如许:
const componentsLocales = require('json-loader!yaml-loader!../../locales/components.yml'); // 这就得到了一个语言包的json格式
3、怎样通知后端接口返回何种语言的数据?
因为涉及到很多接口都要通知后端采用哪种语言,所以,我选择了利用header头的方式。在axios的interceptor中给哀求同一添加了header头:Accept-Language, 并把这个值的内容设置成前端所获得应利用的语言(如,zh-CN 或 en 等)。如许,就会合在一处把这个题目处理掉了。

三、详细实践中的一些细节



1、获取当前应该采用何种语言的getLang模块的实现
  1. import { getQueryObj } from '../utils/url';
  2. import { setItem, getItem } from '../utils/storage';
  3. const langs = ['zh-CN', 'en']; // 支持哪些语言
  4. const defaultLang = 'en'; // 默认语言,暂时并没有对外抛出
  5. function getLang() {
  6.   let queries = getQueryObj();
  7.   let storeLang = getItem('lang');
  8.   let rawLang;
  9.   let flag = false;
  10.   if (queries && queries['lang']) {
  11.     rawLang = queries['lang'];
  12.     setItem('lang', rawLang);
  13.   } else {
  14.     rawLang = storeLang || navigator.language;
  15.   }
  16.   langs.map(item => {
  17.     if (item === rawLang) {
  18.       flag = true;
  19.     }
  20.   });
  21.   return flag ? rawLang : defaultLang;
  22. }
  23. const lang = getLang(langs, defaultLang);
  24. export default {
  25.     lang, // 获取到当前语言
  26.     langs // 所支持的语言列表
  27. }
复制代码
2、Vux组件的多语言包的设置

可以从Vux的官方github中找到src/locales/all.yml拷贝过来(同一目次下的src/locales/zh-CN.yml、src/locales/en.yml分别是此中文部分和英文部分),根据你自己的必要略作修改即可。
然后在你的应用的应用的入口文件中引入:
  1. const vuxLocales = require('json-loader!yaml-loader!../../locales/all.yml');
复制代码
3、vux-loader的设置

webpack.dev.conf.js中:
  1. resolve(vuxLoader.merge(devWebpackConfig, {
  2.     plugins_dir: [
  3.         'vux-ui',
  4.         {
  5.             name: 'i18n',
  6.             vuxStaticReplace: false,
  7.             staticReplace: false,
  8.             extractToFiles: 'src/locales/components.yml',
  9.             localeList: ['en','zh-CN']
  10.         }
  11.     ]
  12. }))
复制代码
webpack.prod.conf.js中:
  1. resolve(vuxLoader.merge(buildWebpackConfig, {
  2.     plugins_dir: [
  3.         'vux-ui',
  4.         {
  5.             name: 'i18n',
  6.             vuxStaticReplace: false,
  7.             staticReplace: false,
  8.             extractToFiles: 'src/locales/components.yml',
  9.             localeList: ['en','zh-CN']
  10.         }
  11.     ]
  12. }))
复制代码
此中的localeList: ['en','zh-CN']就是指定你的应用支持哪几种语言。
而extractToFiles: 'src/locales/components.yml'就是指定你的自定义组件中所用到的那些<i18n>标签中的语言包信息,应该导出到哪个Yaml文件中。也就是说,你在各个自定义组件中利用的<i18n>标签中的语言包信息都会被vux-loader会合抽取到这个文件中。
然后在应用的入口文件中引入这个语言包文件:
  1. const componentsLocales = require('json-loader!yaml-loader!../../locales/components.yml');
复制代码
4、自定义组件表里文案的多语言化

(1)对于自定义组件内部的文案的多语言化信息,写在组件的<i18n>标签中即可。同时,为了避免不同的自定义组件中多语言字段的命名冲突,在每个字段的名字前面加上以组件名-式的前缀。
(2)对于页面的标题、一些错误提示等文案,它们是出现在组件之外的,因此不适当写在组件的<i18n>标签中,所以我们单独新建一个global.yml来存放这些全局性的多语言信息。这些内容直接写在global.yml中即可,并且,为了外貌与其它的语言包字段相冲突,我们在每个字段的前面加上global-前缀。
然后在应用的入口文件中引入这个语言包文件:
  1. const componentsLocales = require('json-loader!yaml-loader!../../locales/global.yml');
复制代码
5、vuex-i18n的实现

在src/store/index.js文件中:
  1. import VuexI18n from 'vuex-i18n';
复制代码
export default new Vuex.Store中增长:
  1.     i18n: VuexI18n.store
复制代码
在应用的入口文件中:
  1. import VuexI18n from 'vuex-i18n';
  2. import getLang from '../../getLang';
  3. Vue.use(VuexI18n.plugin, store);
  4. const vuxLocales = require('json-loader!yaml-loader!../../locales/all.yml');
  5. const componentsLocales = require('json-loader!yaml-loader!../../locales/components.yml');
  6. const finalLocales = {
  7.   'en': Object.assign(vuxLocales['en'], componentsLocales['en']),
  8.   'zh-CN': Object.assign(vuxLocales['zh-CN'], componentsLocales['zh-CN'])
  9. }
  10. for (let i in finalLocales) {
  11.   Vue.i18n.add(i, finalLocales[i])
  12. }
  13. Vue.i18n.set(globalVars.lang);
复制代码
6、图片的多语言化

对于图片中的文案信息,多语言化主要有这么两种方式:一是根据不同的语言展示不同的图片;二是尽将笔墨从图片背景中分离出来,采用笔墨层加背景图片层的方式,如许笔墨层就可以作为平凡文原来实现多语言化了。都比力简单,不再赘述。

7、在当前页面通过按钮切换当前语言后,怎样更新当前页面的内容?


假如你的应用并不必要在页面内部切换语言版本,那么直接通过URL中传入不同的lang参数就可以了,并不涉及到此题目。
第一种方式:刷新页面
  1. <button @click="changeLang('zh-CN')">中文</button>
  2. <button @click="changeLang('en')">英文</button>
复制代码
  1. changeLang(lang){
  2.     location.href = this.$utils.url.replaceParam(this.$router.history.current.path, 'lang', lang);
  3. },
复制代码
第二种方式:watch当前页data中lang字段的变化,通过v-if局部刷新某些干系组件:
  1. data(){
  2.     return {
  3.         lang: this.$i18n.locale()
  4.     }
  5. }
  6. changeLang(lang){
  7.     this.$i18n.set(lang);
  8.     this.lang = this.$i18n.locale();
  9. },
  10. watch: {
  11.     lang(newVal, oldVal) {
  12.         if(newVal === oldVal) {
  13.             return;
  14.         }
  15.         // 在这里通过改变某个标志位 结合 v-if 来触发某个局部组件的重新渲染
  16.     }
  17. }
复制代码
第三种方式:团结vuex派发全局的语言状态,接收到状态变化时举行更新,大概自己简单地改写vuex-i18n的实现。这种方式相对复杂一些。
详细根据自己的业务需求选择。

8、Yaml中特别字符的转义

对于一些包含特别字符的yaml键值,比如[、]等,必要举行转义。转的方式是给键值加上单引号引起来。
假如你的语言包信息中有单引号,则必须一连利用两个单引号转义。例如:
str: 'labor''s day'

总结

到此这篇关于Vue.js项目前端多语言方案的思路与实践的文章就介绍到这了,更多干系Vue.js前端多语言内容请搜刮草根技术分享以前的文章或继续浏览下面的干系文章希望大家以后多多支持草根技术分享!

帖子地址: 

回复

使用道具 举报

分享
推广
火星云矿 | 预约S19Pro,享500抵1000!
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

草根技术分享(草根吧)是全球知名中文IT技术交流平台,创建于2021年,包含原创博客、精品问答、职业培训、技术社区、资源下载等产品服务,提供原创、优质、完整内容的专业IT技术开发社区。
  • 官方手机版

  • 微信公众号

  • 商务合作