前端国际化之痛点(一):让人头疼的词条Key

2024-01-09 19:12

本文主要是介绍前端国际化之痛点(一):让人头疼的词条Key,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

VoerkaI18n是一款非常优秀的前端国际化解决方案,其开发的出发点是为了解决现存多语言的一些痛点,接下来几篇文章将分别进行分析。

  • 前端国际化之痛点(一):让人头疼的词条Key
  • 前端国际化之痛点(二):多包多库场景下联动多语言
  • 前端国际化之痛点(三):上线后修改翻译内容

现有方案痛点

前端国际化的方案非常多,绝大多数多语言方案均采用对要翻译的词条key的方式。

Vue-i18n为例,大体如下:

  • Vue-i18n
const messages = {en: {message: {hello: 'hello world'}},ja: {message: {hello: 'こんにちは、世界'}}
}
const i18n = new VueI18n({locale: 'ja', // 设置地区messages, // 设置地区信息
})

我们需要为每一个要翻译的词指定一个英文Key,这个英文Key一般需要具备一定的语义,如果要翻译的内容比较复杂,则这个英文key就不那么好翻译了。最终形成的多语言文件可能是这样的:

// en.json
{noAccess: {accessTitle: 'You are not authorized to operate~',accessMsg: 'Contact information: add QQ group discussion 665452019',},layout: {configTitle: 'Layout configuration',twoColumnsMenuBarColor: 'Default font color bar menu',twoIsColumnsMenuBarColorGradual: 'Column gradient',twoIsColumnsMenuHoverPreload: 'Column Menu Hover Preload',threeTitle: 'Interface settings',threeIsCollapse: 'Menu horizontal collapse',threeIsUniqueOpened: 'Menu accordion',threeIsFixedHeader: 'Fixed header.ts',threeIsClassicSplitMenu: 'Classic layout split menu',threeIsLockScreen: 'Open the lock screen',threeLockScreenTime: 'screen locking(s/s)',fourTitle: 'Interface display',fourIsShowLogo: 'Sidebar logo',fourIsBreadcrumb: 'Open breadcrumb',fourIsBreadcrumbIcon: 'Open breadcrumb icon',fourIsTagsview: 'Open tagsview',tipText: 'Click the button below to copy the layout configuration to `/src/stores/themeConfig.ts` It has been modified in.',},upgrade: {title: 'New version',msg: 'The new version is available, please update it now! Dont worry, the update is fast!',desc: 'Prompt: Update will restore the default configuration',}
}

然后在组件源码中可能是这样的:


<p>{{ $t('message.hello', { msg: 'hello' }) }}</p>
<p>{{ $t('layout.twoColumnsMenuBarColor' }}</p> 
<p>{{ $t('layout.threeIsLockScreen' }}</p> 
<p>{{ $t('layout.fourIsBreadcrumbIcon' }}</p> 
<p>{{ $t('layout.tipText' }}</p> 
<p>{{ $t('upgrade.msg' }}</p> 

这样问题就来了,在源代码中充斥了大量的如layout.tipText,layout.threeIsClassicSplitMenu这样的英文词条,这带来以下痛点问题

  • 无法在源码中从诸如layout.tipText,layout.threeIsClassicSplitMenu这样的英文Key中推断出原文的内容,需要反向查询才能知道。
  • 如何为要翻译的词条取一个适合语义的英文Key是比较难的,特别是比较长的词条。
  • 在开发过程中不符合直觉,不方便进行调整。
  • 调整修改流程比较麻烦

如何解决这些痛点呢?

业界已经存在的方案有:

  • 提供VSCODE插件,能解析语言文件(如en.json),然后在源码编辑时提供代码提示功能。如下例中,当输入layout.时列出备选的key让你选。
  • 有一个很有名的VSCODE插件i18n-ally,能自动解析语言文件,在源码中显示出原文。

解决痛点

针对这个痛点,VoerkaI18n则直接废弃了在源码中使用Key的方式,解决了些问题。

VoerkaI18n推荐在源代码中使用中文,不需要用到英文Key来标识词条。

其大概思路是这样的。

接下来在源码文件中,将所有需要翻译的内容使用t翻译函数进行包装,例如下:

  1. 在源代码中直接使用中文
import { t } from "./languages"
// 不含插值变量
t("中华人民共和国")
// 位置插值变量
t("中华人民共和国{}","万岁")
t("中华人民共和国成立于{}年,首都{}",1949,"北京")
  1. 提取需要的翻译的文本信息

接下来我们使用voerkai18n extract命令来自动扫描工程源码文件中的需要的翻译的文本信息。 voerkai18n extract命令会使用正则表达式来提取t("需要的翻译的文本")包装的文本。

  1. 编译语句包
voerkai18n compile

使用voerkai18n compile命令将翻译后的语言包编译成代码。编译过程中进行了去重、关联等处理。

小结

使用VoerkaI18n进行国际化完全摒弃了传统的使用英文Key来标识待翻译词条的方案,另外符合直觉,也更加容易进行修改调整。完整的例子可以参考:

VoerkaI18n入门示例

VoerkaI18n文本映射过程说明

后续

  • 前端国际化之痛点(一):让人头疼的词条Key
  • 前端国际化之痛点(二):多包多库场景下联动多语言
  • 前端国际化之痛点(三):上线后修改翻译内容

这篇关于前端国际化之痛点(一):让人头疼的词条Key的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/588138

相关文章

Nginx实现前端灰度发布

《Nginx实现前端灰度发布》灰度发布是一种重要的策略,它允许我们在不影响所有用户的情况下,逐步推出新功能或更新,通过灰度发布,我们可以测试新版本的稳定性和性能,下面就来介绍一下前端灰度发布的使用,感... 目录前言一、基于权重的流量分配二、基于 Cookie 的分流三、基于请求头的分流四、基于请求参数的分

MySQL中Next-Key Lock底层原理实现

《MySQL中Next-KeyLock底层原理实现》Next-KeyLock是MySQLInnoDB存储引擎中的一种锁机制,结合记录锁和间隙锁,用于高效并发控制并避免幻读,本文主要介绍了MySQL中... 目录一、Next-Key Lock 的定义与作用二、底层原理三、源代码解析四、总结Next-Key L

基于Canvas的Html5多时区动态时钟实战代码

《基于Canvas的Html5多时区动态时钟实战代码》:本文主要介绍了如何使用Canvas在HTML5上实现一个多时区动态时钟的web展示,通过Canvas的API,可以绘制出6个不同城市的时钟,并且这些时钟可以动态转动,每个时钟上都会标注出对应的24小时制时间,详细内容请阅读本文,希望能对你有所帮助...

HTML5 data-*自定义数据属性的示例代码

《HTML5data-*自定义数据属性的示例代码》HTML5的自定义数据属性(data-*)提供了一种标准化的方法在HTML元素上存储额外信息,可以通过JavaScript访问、修改和在CSS中使用... 目录引言基本概念使用自定义数据属性1. 在 html 中定义2. 通过 JavaScript 访问3.

CSS模拟 html 的 title 属性(鼠标悬浮显示提示文字效果)

《CSS模拟html的title属性(鼠标悬浮显示提示文字效果)》:本文主要介绍了如何使用CSS模拟HTML的title属性,通过鼠标悬浮显示提示文字效果,通过设置`.tipBox`和`.tipBox.tipContent`的样式,实现了提示内容的隐藏和显示,详细内容请阅读本文,希望能对你有所帮助... 效

前端bug调试的方法技巧及常见错误

《前端bug调试的方法技巧及常见错误》:本文主要介绍编程中常见的报错和Bug,以及调试的重要性,调试的基本流程是通过缩小范围来定位问题,并给出了推测法、删除代码法、console调试和debugg... 目录调试基本流程调试方法排查bug的两大技巧如何看控制台报错前端常见错误取值调用报错资源引入错误解析错误

Vue中动态权限到按钮的完整实现方案详解

《Vue中动态权限到按钮的完整实现方案详解》这篇文章主要为大家详细介绍了Vue如何在现有方案的基础上加入对路由的增、删、改、查权限控制,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、数据库设计扩展1.1 修改路由表(routes)1.2 修改角色与路由权限表(role_routes)二、后端接口设计

Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)

《Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)》文章介绍了如何使用dhtmlx-gantt组件来实现公司的甘特图需求,并提供了一个简单的Vue组件示例,文章还分享了一... 目录一、首先 npm 安装插件二、创建一个vue组件三、业务页面内 引用自定义组件:四、dhtmlx

Vue ElementUI中Upload组件批量上传的实现代码

《VueElementUI中Upload组件批量上传的实现代码》ElementUI中Upload组件批量上传通过获取upload组件的DOM、文件、上传地址和数据,封装uploadFiles方法,使... ElementUI中Upload组件如何批量上传首先就是upload组件 <el-upl

前端知识点之Javascript选择输入框confirm用法

《前端知识点之Javascript选择输入框confirm用法》:本文主要介绍JavaScript中的confirm方法的基本用法、功能特点、注意事项及常见用途,文中通过代码介绍的非常详细,对大家... 目录1. 基本用法2. 功能特点①阻塞行为:confirm 对话框会阻塞脚本的执行,直到用户作出选择。②