教程 框架 组件 接口 其他

多语言覆盖 1060+

快应用平台的能力会覆盖多个国家地区,平台支持多语言的能力后,可以做到让一个快应用产品(一个 RPK 文件)同时支持多个语言版本的切换,开发者无需开发多个不同语言的源码项目,避免给项目维护带来困难。

使用系统默认的语言,开发者配置多语言的方式非常简单,只需要定义资源引用资源两个步骤即可;如果允许用户在快应用中修改地区语言,请参考第三步获取更新语言

定义资源文件

资源文件用于存放多个语言的业务信息定义,与其它技术平台类似(它们使用properties文件或者xml文件的格式),快应用平台使用JSON文件保存资源定义;

在项目源码src目录下定义i18n文件夹,内部放置每个语言地区下的资源定义文件即可;其中文件名定义为:zh-CN.jsonzh.json

如果开发者当前产品仅计划支持一种语言,同时还希望用到多语言能力,那么仅声明一个名称为defaults.json的文件即可;

每个 JSON 文件的内容格式如下:

{
  "message": {
    "pageA": {
      "text": "pure-text-content",
      "format": {
        "object": "type-{name}",
        "array": "type-{0}"
      },
      "array": [
        "item-type-string",
        {
          "key": "item-type-object-attribute"
        },
        ["item-type-array"]
      ],
      "plurals": {
        "double": "car | cars",
        "three": "no apples | one apple | {count} apples",
        "format": {
          "object": "type-{name}",
          "array": "type-{0}"
        }
      }
    }
  }
}

页面中通过message.pageA.text类似的path引用对应内容"pure-text-content"

页面中引用资源

页面中多语言的使用语法,主要体现在 ViewModel 的几个函数上,如:$t,这些方法可以在<template<script>中使用;

如下代码所示:

<template>
  <div>
    <text>{{ $t('message.pageA.text') }}</text>
    <text>{{ $t('message.pageA.format.object', { name: 'arg-object' }) }}</text>
    <text>{{ $t('message.pageA.format.array', ['arg-array']) }}</text>
  </div>
</template>

<script>
  export default {
    onInit () {
      // 简单格式化:
      this.$t('message.pageA.text')
      this.$t('message.pageA.format.object', { name: 'arg-object' })
      this.$t('message.pageA.format.array', ['arg-array'])
    }
  }
</script>

简单格式化方法

属性类型参数描述
$tFunctionpath: String 资源路径
arg0: object
array 格式化参数,非必要参数,根据系统语言完成简单的替换:this.$t('message.pageA.text')

比如:

// 示例:无额外参数的格式化
// 输出:"pure-text-content"
this.$t('message.pageA.text')
// 示例:额外参数为对象,替换引用内容中的绑定
// 输出:"type-arg-object"
this.$t('message.pageA.format.object', { name: 'arg-object' })
// 示例:额外参数为数组,替换引用内容中的绑定
// 输出:"type-arg-array"
this.$t('message.pageA.format.array', ['arg-array'])

单复数格式化方法

属性类型参数描述
$tcFunctionpath: String 资源路径
count: number 要表达的值
根据系统语言完成单复数替换:this.$tc('message.plurals.double'),注意:定义资源的内容通过 | 分隔为多个选项

比如:

// 示例:message的值为两个选项时,传递数值不为单数
// 输出:"cars"
this.$tc('message.pageA.plurals.double', 0)
// 示例:message的值为两个选项时,传递数值为单数
// 输出:"car"
this.$tc('message.pageA.plurals.double', 1)
// 示例:message的值为两个选项时,传递数值不为单数
// 输出:"cars"
this.$tc('message.pageA.plurals.double', 2)

// 示例:message的值为三个及以上的选项时,传递数值不为单数
// 输出:"no apples"
this.$tc('message.pageA.plurals.three', 0)
// 示例:message的值为三个及以上的选项时,传递数值为单数
// 输出:"one apple"
this.$tc('message.pageA.plurals.three', 1)
// 示例:message的值为三个及以上的选项时,传递数值不为单数
// 输出:"10 apples"
this.$tc('message.pageA.plurals.three', 10)

获取更新语言

上面的能力用于资源内容的格式化,在某些场景下开发者可能需要获取当前系统的地区语言locale并进行更改,来完成不同的逻辑处理:

  • 比如:不同的 locale 对应的页面布局不同;
  • 比如:开发者为用户提供设置某种语言的能力;

此时开发者,可以通过system.configuration接口来完成,详见:系统配置

比如:

import configuration from '@system.configuration'

// 获取locale,后续开发者可以将locale设置为VM中的data属性,并在模板中判断以区分不同的布局
const localeObject = configuration.getLocale()
// 转换为字符串格式,如:'zh'或者'zh-CN'
const locale = [localeObject.language, localeObject.countryOrRegion]
  .filter(n => !!n)
  .join('-')

console.info(`获取当前locale:${locale}`)
import configuration from '@system.configuration'

// 设置locale成功后,通过VM的生命周期函数 onConfigurationChanged 触发
configuration.setLocale({
  language: 'zh',
  countryOrRegion: 'CN'
})

修改地区语言后的回调

当用户在系统设置或者通过 configuration.setLocale 切换地区语言,都会触发 onConfigurationChanged 回调,且返回来的 event.type 值为locale

详情可参考文档

示例代码

// 监听语言、地区变化
onConfigurationChanged(event) {
  if (event && event.type && event.type === 'locale') {
    console.log('locale or language changed!')
  }
}

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容