/weapp-i18n

Primary LanguageJavaScript

微信小程序国际化

现状

小程序国际化官方没有支持,也没有现成的插件。

网上有人做了国际化的尝试。但是只能替换静态文本,就是简单的键值匹配。

vue-i18n 由于是基于 htmlvue, 不同于wxml(尤其是不能修改dom),估计进行hack调研可能要花很多时间。

方案

本项目是一个可以直接运行的国际化的小程序 quickstart 项目。 下载后可以直接在 微信开发者工具中运行。

介绍

如果想让翻译的内容渲染在页面中,需要把翻译的数据放在 Page 的 data 中,对于动态渲染带可变参数的数据, 在 setData 的时候加个尾巴(在其后面set 带参数的翻译的 data)。 目前基本方案是自己开发一套翻译工具:

  • 功能:
    1. 翻译静态文案
    2. 翻译带参数的文案 *缺陷 1.由于只能返回字符串,没有类似vue 通过 v-html 进行标签替换的能力,所以对带标签(样式)的翻译无能为力。

总结: 优先保证中文用户的使用体验,对于不带标签的类型的翻译,中英文没有区别,对于带标签的类型的翻译,将中文翻译直接放在 wxml 中,只是在中文的情况下显示,在非中文时直接隐藏。

代码

// i18n.js
module.exports = {
  locale: 'en',
  locales: {},
  registerLocale (locales) {
    this.locales = locales
  },
  setLocale (code) {
    this.locale = code
  },
  /**
   * 返回带(或不带)参数的类型的翻译结果
   * @param {string} key, /util/language/en.js 中的键名,如 "curslide"
   * @param {object} data, 传入的参数,如 {num: 123}
   * @returns {string}
   *
   * @desc 如:"activeno": "当前学生{activeno}位",
   *       activeno 为 key,可以输入data {activeno: 15}
   *       返回:"当前学生15位"
   */
  _ (key, data) {
    let locale = this.locale
    let locales = this.locales
    let hasKey = locale && locales[locale] && locales[locale][key]
    
    if (hasKey) {
      key = locales[locale][key]

      let res = key.replace(/\{[\s\w]+\}/g, x => {
        x = x.substring(1, x.length-1).trim()
        return data[x];
      })

      return res
    }

    throw new Error(`语言处理错误${key}`)
  },
  /**
   * 返回二选一类型的翻译结果
   * @param {string} key, /util/language/en.js 中的键名,如 "curslide"
   * @param {object} data, 传入的参数,如 {first: true} 选择前面的
   * @returns {string}
   *
   * @desc 如:"sendprob": "Send | Check",
   *       sendprob 为 key,可以输入data {first: true}
   *       返回:"Send"
   */
  _b (key, data) {
    let locale = this.locale
    let locales = this.locales
    let hasKey = locale && locales[locale] && locales[locale][key]
    
    if (hasKey) {
      key = locales[locale][key]

      let res = key.split('|')[data.first ? 0 : 1].trim()

      return res
    }

    throw new Error(`语言处理错误${key}`)
  }
}

并且要覆盖小程序本身每个 Page 中的 setData 方法。 注意,使用子组件的页面由于 setData 方法不可修改,所以需要重新命名一个新的函数,并在 Page 中使用该新函数来替代 setData 方法:

/**
 * 代理小程序的 setData,在更新数据后,翻译传参类型的字符串
 *
 * @param {object} langData 当页的翻译模块
 */
function resetSetData (langData) {
  let self = this

  /**
   * 在小程序中,使用子组件的页面, this.setData configurable 和 writable 都是 false
   * 所以不能重置 setData 方法,只能另起一个函数名,这里用了 setComData,
   * 另外,由于在 langData.js 中 setTransData 方法调用的是 setData,
   * 所以,另外给使用子组件的页面,定义了个 setComTransData 方法,去调用 setComData
   */

  let isUsingComponents = !self.__proto__.hasOwnProperty('setData') && self.__proto__.__proto__.hasOwnProperty('setData')
  let _ = self.setData

  if (!isUsingComponents) {
    self.setData = function(data, isSetTrans = false){
      _.call(self, data)
      if (isSetTrans) {/* 阻止翻译循环调用 setData  */return;}
      langData.setTransData && langData.setTransData.call(self)
    }
  } else {
    self.setComData = function(data, isSetTrans = false){
      _.call(self, data)
      if (isSetTrans) {/* 阻止翻译循环调用 setData  */return;}
      langData.setComTransData && langData.setComTransData.call(self)
    }
  }
  
}