TaroPlatformBase

我们把编译时常用的逻辑抽象出了一个基类 TaroPlatformBase，开发者可以继承于此基类，从而实现端平台的编译。

例如我们创建一个微信小程序平台：

program.ts

  1. import { TaroPlatformBase } from '@tarojs/service'
  2. export default class Weapp extends TaroPlatformBase {
  3.   // ...
  4. }

方法与属性

constructor (ctx, config)

构造函数，接受两个参数。

参数类型说明
ctxobject插件上下文对象
configobjectTaro 编译配置

ctx

object

插件上下文对象。

this.ctx.modifyWebpackChain

获取 WebpackChain，例子：

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   modifyWebpackChain () {
  3.     // 通过 this.ctx.modifyWepackChain 能获取到 WebpackChain 实例
  4.     this.ctx.modifyWebpackChain(({ chain }) => {
  5.       // chain.xxxx
  6.     })
  7.   }
  8. }

helper

object

存放着一系列工具函数，对应 @tarojs/helper 包的导出内容。

config

object

编译配置对象。

(abstract) platform

抽象属性，子类必须实现。

string

平台名称，如：

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   platform = 'weapp'
  3. }

(abstract) globalObject

抽象属性，子类必须实现。

string

小程序挂载各种 API 的全局对象名称。如微信小程序的 wx，支付宝小程序的 my，例如：

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   globalObject = 'wx'
  3. }

(abstract) runtimePath

抽象属性，子类必须实现。

stirng | string[]

小程序编译的运行时文件的解析路径，如：

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   runtimePath = '@tarojs/plugin-platform-weapp/dist/runtime'
  3. }

(abstract) fileType

抽象属性，子类必须实现。

object

平台的各种文件的后缀名，如：

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   fileType = {
  3.     // 模板文件后缀
  4.     templ: '.wxml',
  5.     // 样式文件后缀
  6.     style: '.wxss',
  7.     // 配置文件后缀
  8.     config: '.json',
  9.     // 脚本文件后缀
  10.     script: '.js',
  11.     // 【可选】渲染层脚本文件后缀，如微信小程序的 wxs，支付宝小程序的 sjs
  12.     xs: '.wxs'
  13.   }
  14. }

(abstract) template

抽象属性，子类必须实现。

object

模板对象的实例。

(optional) projectConfigJson

子类可选择是否进行设置。

小程序配置文件的名称。

如果子类有实现 projectConfigJson，则会自动拷贝此文件到 dist 目录下。

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   projectConfigJson = 'project.config.json'
  3. }

(optional) taroComponentsPath

子类可选择是否进行设置。

编译时对 @tarojs/components 包的 alias，下文将详细介绍。

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   taroComponentsPath = '@tarojs/plugin-platform-weapp/dist/components-react'
  3. }

setupTransaction

setup 阶段的事务钩子。

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   /**
  3.    * 1. setupTransaction - init
  4.    * 2. setup
  5.    * 3. setupTransaction - close
  6.    * 4. buildTransaction - init
  7.    * 5. build
  8.    * 6. buildTransaction - close
  9.    */
  10.   constructor (ctx, config) {
  11.     super(ctx, config)
  14.     this.setupTransaction.addWrapper({
  15.       init () {}
  16.       close () {}
  17.     })
  18.   }
  19. }

buildTransaction

build 阶段的事务钩子。

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   /**
  3.    * 1. setupTransaction - init
  4.    * 2. setup
  5.    * 3. setupTransaction - close
  6.    * 4. buildTransaction - init
  7.    * 5. build
  8.    * 6. buildTransaction - close
  9.    */
  10.   constructor (ctx, config) {
  11.     super(ctx, config)
  14.     this.buildTransaction.addWrapper({
  15.       init () {}
  16.       close () {}
  17.     })
  18.   }
  19. }

start ()

插件入口调用 start 方法开启编译，如：

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   // ...
  3. }
  6. export default (ctx) => {
  7.   ctx.registerPlatform({
  8.     name: 'weapp',
  9.     useConfigName: 'mini',
  10.     async fn ({ config }) {
  11.       const program = new Weapp(ctx, config)
  12.       await program.start()
  13.     }
  14.   })
  15. }

generateProjectConfig (src, dist)

用于生成 project.config.json 此类项目配置文件。

参数类型默认值说明
srcstring项目源码中配置文件的名称
diststring‘project.config.json’编译后配置文件的名称

例子：

  1. // 把用户编写的 `project.tt.json` 输出为 `project.config.json`
  2. generateProjectConfig('project.tt.json')
  3. // 把用户编写的 `project.swan.json` 输出为 `project.swan.json`
  4. generateProjectConfig('project.swan.json', 'project.swan.json')

recursiveReplaceObjectKeys (target, keyMap)

递归替换目标对象的 key 值。

参数类型说明
targetobject目标对象
keyMapobjectkey 值替换规则

例子，支付宝小程序配置项 key 值和大多数小程序的规范不一样，需要进行对齐：

  1. // this.ctx.modifyMiniConfigs 能获取到小程序入口和页面配置文件的列表
  2. this.ctx.modifyMiniConfigs(({ configMap }) => {
  3.   const replaceKeyMap = {
  4.     navigationBarTitleText: 'defaultTitle',
  5.     navigationBarBackgroundColor: 'titleBarColor',
  6.     enablePullDownRefresh: 'pullRefresh',
  7.     list: 'items',
  8.     text: 'name',
  9.     iconPath: 'icon',
  10.     selectedIconPath: 'activeIcon',
  11.     color: 'textColor'
  12.   }
  13.   Object.keys(configMap).forEach(key => {
  14.     const item = configMap[key]
  15.     if (item.content) {
  16.       // 递归替换配置文件里的 key 值为目标对象的 key 值
  17.       this.recursiveReplaceObjectKeys(item.content, replaceKeyMap)
  18.     }
  19.   })
  20. })

自定义平台类

接下来将以扩展对微信小程序的编译支持为例，介绍如何创建一个自定义平台类。

1. 继承基类

继承 TaroPlatformBase 以实现 Weapp 类，并实现所有抽象属性、可选属性：

program.ts

  1. import { TaroPlatformBase } from '@tarojs/service'
  4. const PACKAGE_NAME = '@tarojs/plugin-platform-weapp'
  7. class Weapp extends TaroPlatformBase {
  8.   // 平台名称
  9.   platform = 'weapp'
  10.   // 小程序全局对象
  11.   globalObject = 'wx'
  12.   // 小程序编译的运行时文件的解析路径
  13.   runtimePath = `${PACKAGE_NAME}/dist/runtime`
  14.   // 文件后缀
  15.   fileType = {
  16.     templ: '.wxml',
  17.     style: '.wxss',
  18.     config: '.json',
  19.     script: '.js',
  20.     xs: '.wxs'
  21.   }
  22.   template = new Template()
  23.   // 小程序配置文件名称
  24.   projectConfigJson = 'project.config.json'
  25.   // 对 `@tarojs/components` 包的 alias 路径
  26.   taroComponentsPath = `${PACKAGE_NAME}/dist/components-react`
  29.   constructor (ctx, config) {
  30.     super(ctx, config)
  32.     /**
  33.     * 1. setupTransaction - init
  34.     * 2. setup
  35.     * 3. setupTransaction - close
  36.     * 4. buildTransaction - init
  37.     * 5. build
  38.     * 6. buildTransaction - close
  39.     */
  42.     // 可以在 setup 的不同阶段注入自定义逻辑
  43.     this.setupTransaction.addWrapper({
  44.       init () {}
  45.       close () {}
  46.     })
  49.     // 可以在 build 的不同阶段注入自定义逻辑
  50.     this.buildTransaction.addWrapper({
  51.       init () {}
  52.       close () {}
  53.     })
  54.   }
  55. }
  58. export default Weapp

2. 处理模板逻辑

编写一个模板类以处理模板逻辑，把它的实例设置为自定义平台类的 template 属性：

program.ts

  1. import { Template } from './template'
  4. class Weapp extends TaroPlatformBase {
  5.   // ...
  6.   // 模板实例
  7.   template = new Template()
  8. }

3. 处理组件

我们把目前支持的 6 种小程序进行了组件和组件属性的比对，得出了一份最通用的组件以及其属性。访问 Template 类实例的 internalComponents 属性可以获取到这些通用组件以及属性。

抽取这份通用组件的目的是为了在生成 B 小程序的模板时，尽量不会含有 A 小程序独有的组件或属性。

但随着各小程序平台发展，各平台都可能独自新增一些组件或属性。这时我们的端平台插件就需要通过修改 template.internalComponents 来处理这些特殊的组件或属性。

3.1 编写 components.ts

components.ts 可以导出一个对象，以表示对 internalComponents 修改属性、新增属性或新增组件。

规范：

components.ts

  1. import { singleQuote } from '@tarojs/shared'
  4. export const components = {
  5.   // 组件名 CamelCase
  6.   ScrollView: 
  7.   // 属性对象
  8.   {
  9.     // value 为空字符串时，代表不设置默认值
  10.     'scroll-left': '',
  11.     // 属性默认值为布尔值或数字时，value 写为字符串
  12.     'enable-flex': 'false',
  13.     'refresher-threshold': '45',
  14.     // 属性默认值为字符串时，需要使用 singleQuote 函数进行包裹
  15.     'refresher-default-style': singleQuote('black'),
  16.     // 事件
  17.     bindRefresherAbort: ''
  18.   }
  19. }

3.2 合并到 template.internalComponents

编写好 components.ts 后，可以借助 Template 类实例的 mergeComponents 方法进行合并。

template.mergeComponents (ctx, patch)

合并组件补丁到 this.internalComponents。

参数类型说明
ctxobject插件上下文对象
patchobject组件补丁

例子：

program.ts

  1. import { components } from './components'
  4. class Weapp extends TaroPlatformBase {
  5.   constructor (ctx, config) {
  6.     super(ctx, config)
  9.     // 在 setup 阶段结束时，修改模板
  10.     this.setupTransaction.addWrapper({
  11.       close: this.modifyTemplate
  12.     })
  13.   }
  16.   modifyTemplate () {
  17.     this.template.mergeComponents(this.ctx, components)
  18.   }
  19. }

components.ts

  1. export const components = {
  2.   ScrollView: {
  3.     'enable-flex': 'true',
  4.     'refresher-threshold': '45'
  5.   },
  6.   Xyz: {
  7.     'a': ''
  8.   }
  9. }

假设 template.internalComponent 的默认值为：

  1. internalComponent = {
  2.   ScrollView: {
  3.     'scroll-left': '',
  4.     'enable-flex': 'false',
  5.   }
  6. }

合并后的结果为：

  1. internalComponent = {
  2.   ScrollView: {
  3.     'scroll-left': '',
  4.     // enable-flex 的默认值修改了
  5.     'enable-flex': 'true',
  6.     // 新增了 refresher-threshold 属性
  7.     'refresher-threshold': '45'
  8.   },
  9.   // 新增了 Xyz 组件
  10.   Xyz: {
  11.     'a': ''
  12.   }
  13. }

3.3 直接修改 template.internalComponents

除了借助 template.mergeComponents 进行合并，我们也可以直接修改 template.internalComponents。

program.ts

  1. class Weapp extends TaroPlatformBase {
  2.   modifyTemplate () {
  3.     // 删除 Slider 组件里的一些属性
  4.     this.modifySlider(this.template.internalComponents.Slider)
  5.     // 改写 View 组件的属性对象
  6.     this.template.internalComponents.View = {}
  7.   }
  10.   modifySlider (slider) {
  11.     delete slider['block-size']
  12.     delete slider['block-color']
  13.   }
  14. }

建议尽量编写一份 components.ts 进行 merge，而不是直接操作。因为运行时也需要合并后的组件信息，编写一份 components.ts 能进行复用。

3.4 编写 components-react.ts

在 Taro 里使用 React，内置组件需要从 @tarojs/components 中引用后再使用。

  1. import { View } from '@tarojs/components'

但如果我们增加了新的内置组件，再从 @tarojs/components 中引用就取不到这些新增的组件。

因此当我们新增加了组件时，需要编写一份 components-react.ts，并配置 Webpack alias，供 React 引用。

例子：

  1. 编写 components-react.ts 文件

components-react.ts

  1. // 原有的组件
  2. export * from '@tarojs/components/mini'
  3. // 新增的组件
  4. export const Editor = 'editor'
  5. export const OfficialAccount = 'official-account'
  1. 设置 taroComponentsPath

program.ts

  1. const PACKAGE_NAME = '@tarojs/plugin-platform-weapp'
  2. class Weapp extends TaroPlatformBase {
  3.   taroComponentsPath = `${PACKAGE_NAME}/dist/components-react`
  4. }