前端国际化全流程解决方案

背景

进入项目组,接到的需求是vue框架的项目实现国际化,实现中英文版本的切换。
目前常用的前端国际化实现方式是使用配置文件的方式,使用的是同一套界面,根据语言的不同加载对应的配置文件。

而实现这一功能,面对的问题是需要将项目中的中文抽离出中文的语言包,并将其翻译输出英文语言包,以及项目中中文替换成语言包中的变量,工作量大且容易出错。
因此,我们需要一种更智能、更高效的解决方案来应对这一挑战,经过深入研究各种技术方案,是不是可以通过插件实现自动识别代码中的可翻译字符串、生成翻译文件并同步不同语言这一繁琐的过程呢 -- 于是一个搞定项目国际化的插件就此诞生。

image.png

方案选择

常用项目使用的技术栈相匹配的国际化的插件工具:

  • vue 使用插件:vue-i18n
  • angular使用插件:angular-translate
  • react使用插件:react-intl
  • jquery 使用插件: jquery.i18n.property

这些插件的解决方案都是基于多个国家配置不同的语言文案,将所有的语言资源放在独立的文件夹下,以每个字段唯一标识(通过对应key动态渲染),去找到不同语言相对应的字段,以显示来完成前端国际化。 这样在html我们只需要输出标识符,在js中配置好功能、路径,我们就可以让它自行去语言资源包中找到对应语言字段以显示。

由于是vue框架的项目,所以插件也是基于vue+vue-i18n的基础下进行设计和开发的。

实现过程

为了简化国际化过程,我们开发了一个一键式解决方案插件。该插件可以自动识别代码中的可翻译字符串,生成对应的翻译文件,并实现不同语言之间的同步。webpack-in-loader:该Loader通过集成到构建流程,实现了以下功能:

  1. 自动识别 :深潜Vue、JavaScript、TypeScript及其衍生(JSX,
    TSX)等源码海洋,精准捕捉每一处待译字符串,无遗漏,高效率。
  2. 翻译文件生成 :基于识别到的字符串自动生成或更新语言资源文件,如使用MD5码作为键值,确保唯一性。
  3. 同步不同语言 :支持自动翻译(通过集成翻译API如百度翻译)和手动翻译,确保翻译内容与源语言的同步更新。
  4. 集成便利性 :作为Webpack构建流程中的隐形助手,只需简单配置,无需触动原始代码,即可轻松开启国际化旅程。开发者坐享其成,国际化部署,一触即发。
image2222.png

实现步骤

1.安装与配置:通过npm或yarn安装webpack-in-loader,并按照说明配置Loader规则,指定语言文件路径。

npm i webpack-in-loader --save-dev

yarn add webpack-in-loader --dev

2.中文字符串提取:使用CLI命令npx i18n generate从源代码中提取中文字符串并生成初始的zh.js资源文件。

npx i18n generate [src]
#对src目录下的vue/js/ts/tsx/jsx文件进行中文提取并生成国际化资源文件
#默认src目录   src  默认值为src

3.翻译管理:通过npx i18n init初始化翻译配置,选择翻译模式(如百度翻译或ChatGPT),并配置相应的API密钥。执行npx i18n translate启动翻译流程。

npx i18n init 
#初始化翻译配置项(如已有配置项,不要重复执行,不然会覆盖)

npx i18n translate
#开始翻译文件

初始化项目,生成的配置文件 i18n-config.json

module.exports = {
    dir: "./src/locale/", // 目标目录
    file: 'zh.js', // 翻译的文件
    distLangs: ['en'], // 要翻译的语言,必须为百度翻译文档上的code值
    open: true, // leader是否启用 默认true
    mode:'Baidu', //翻译方式: 1.Baidu:百度翻译 2:chatGPT:openai翻译
    appId:'', // 百度翻译appid
    secret:'', // 百度翻译密钥
    openAiKey: '', // chatGPT key
    singleNum: 3000, //百度翻译单次请求最长次数 可配置范围(3900 - 600)不填则为默认值 1500(百度账号不同等级最长次数不同)
};

4.人工校验与调整:提供命令npx i18n transform以手动校正翻译错误,确保翻译质量。
5.国际化配置整合:在Vue项目中正确配置Vue-i18n,确保语言包能够被正确载入,并在应用启动时生效。

注:目前,该插件稳定版已经在公司的研发协同平台中接入,得到各部门同事的认可,可放心使用。

优势与亮点

  • 自动化程度高:显著减少手动编写与维护语言包的工作量,提高开发效率。
  • 灵活性强:支持自动与手动翻译模式,适应不同场景需求。
  • 易于集成:作为Webpack Loader无缝融入现有构建流程,降低技术门槛。
  • 质量可控:结合自动翻译与人工校对,保证翻译质量。

结语

通过使用该一键式国际化解决方案插件,我们大大简化了项目的国际化过程,提高了开发效率和代码质量。开发人员可以更专注于业务逻辑的实现,而无需花费大量时间和精力在翻译和替换上。这一智能化的国际化方案为多语言版本的开发提供了便利,也为项目的国际化需求提供了更好的解决方案。
朋友们,如果您觉得这款插件对您有帮助,欢迎访问我的 GitHub 项目页:
https://github.com/hujinbin/webpack-i18n-loader
您可以在该地址找到插件的详细文档、使用示例以及源代码。我会持续追加新特性和改进已有功能,让插件变得更加优质。 不知是否有兴趣帮我们点个 Star 支持一下呢?

原文链接: 前端国际化全流程解决方案

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,324评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,356评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,328评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,147评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,160评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,115评论 1 296
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,025评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,867评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,307评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,528评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,688评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,409评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,001评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,657评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,811评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,685评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,573评论 2 353

推荐阅读更多精彩内容