前端国际化之痛点(一):让人头疼的词条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访问本地端口》:本文主要介绍前端如何通过nginx访问本地端口的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、nginx安装1、下载(1)下载地址(2)系统选择(3)版本选择2、安装部署(1)解压(2)配置文件修改(3)启动(4)

HTML中meta标签的常见使用案例(示例详解)

《HTML中meta标签的常见使用案例(示例详解)》HTMLmeta标签用于提供文档元数据,涵盖字符编码、SEO优化、社交媒体集成、移动设备适配、浏览器控制及安全隐私设置,优化页面显示与搜索引擎索引... 目录html中meta标签的常见使用案例一、基础功能二、搜索引擎优化(seo)三、社交媒体集成四、移动

HTML input 标签示例详解

《HTMLinput标签示例详解》input标签主要用于接收用户的输入,随type属性值的不同,变换其具体功能,本文通过实例图文并茂的形式给大家介绍HTMLinput标签,感兴趣的朋友一... 目录通用属性输入框单行文本输入框 text密码输入框 password数字输入框 number电子邮件输入编程框

HTML img标签和超链接标签详细介绍

《HTMLimg标签和超链接标签详细介绍》:本文主要介绍了HTML中img标签的使用,包括src属性(指定图片路径)、相对/绝对路径区别、alt替代文本、title提示、宽高控制及边框设置等,详细内容请阅读本文,希望能对你有所帮助... 目录img 标签src 属性alt 属性title 属性width/h

CSS3打造的现代交互式登录界面详细实现过程

《CSS3打造的现代交互式登录界面详细实现过程》本文介绍CSS3和jQuery在登录界面设计中的应用,涵盖动画、选择器、自定义字体及盒模型技术,提升界面美观与交互性,同时优化性能和可访问性,感兴趣的朋... 目录1. css3用户登录界面设计概述1.1 用户界面设计的重要性1.2 CSS3的新特性与优势1.

HTML5 中的<button>标签用法和特征

《HTML5中的<button>标签用法和特征》在HTML5中,button标签用于定义一个可点击的按钮,它是创建交互式网页的重要元素之一,本文将深入解析HTML5中的button标签,详细介绍其属... 目录引言<button> 标签的基本用法<button> 标签的属性typevaluedisabled

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,

CSS place-items: center解析与用法详解

《CSSplace-items:center解析与用法详解》place-items:center;是一个强大的CSS简写属性,用于同时控制网格(Grid)和弹性盒(Flexbox)... place-items: center; 是一个强大的 css 简写属性,用于同时控制 网格(Grid) 和 弹性盒(F

CSS实现元素撑满剩余空间的五种方法

《CSS实现元素撑满剩余空间的五种方法》在日常开发中,我们经常需要让某个元素占据容器的剩余空间,本文将介绍5种不同的方法来实现这个需求,并分析各种方法的优缺点,感兴趣的朋友一起看看吧... css实现元素撑满剩余空间的5种方法 在日常开发中,我们经常需要让某个元素占据容器的剩余空间。这是一个常见的布局需求