概述

  • 在开发web时，有时需要一套代码编译发布到不同的站点，比如主站和微信h5站。（注意不是一套代码内部自适应不同浏览器，是真的分离部署了不同的网站）
  • 在开发小程序时，经常有扩展小程序平台，比如基于阿里小程序的钉钉小程序、淘宝小程序。

uni-app 通过在package.json文件中增加uni-app扩展节点，可实现自定义条件编译平台。

扩展新的平台后，有3点影响：

  1. 可以在代码里编写自定义的条件编译，为这个新平台编写专用代码
  2. 运行时可以执行面向新平台的编译运行
  3. 发行时可以执行面向新平台的编译发行

注意只能扩展web和小程序平台，不能扩展app打包。
并且扩展小程序平台时只能基于指定的基准平台扩展子平台，不能扩展基准平台。基准平台详见下文。

package.json扩展配置用法（拷贝代码记得去掉注释！）：

  1. {
  2.     /**
  3.      package.json其它原有配置 
  4.      */
  5.     "uni-app": {// 扩展配置
  6.         "scripts": {
  7.             "custom-platform": { //自定义编译平台配置，可通过cli方式调用
  8.                 "title":"自定义扩展名称", // 在HBuilderX中会显示在 运行/发行 菜单中
  9.                 "BROWSER":"",  //运行到的目标浏览器，仅当UNI_PLATFORM为h5时有效
  10.                 "env": {//环境变量
  11.                     "UNI_PLATFORM": "",  //基准平台
  12.                     "MY_TEST": "", // ... 其他自定义环境变量
  13.                  },
  14.                 "define": { //自定义条件编译
  15.                     "CUSTOM-CONST": true //自定义条件编译常量，建议为大写
  16.                 }
  17.             }
  18.         }    
  19.     }
  20. }

Tips：

  • UNI_PLATFORM仅支持填写uni-app默认支持的基准平台，目前仅限如下枚举值：h5、mp-weixin、mp-alipay、mp-baidu、mp-toutiao、mp-qq
  • BROWSER 仅在UNI_PLATFORM为h5时有效,目前仅限如下枚举值：Chrome、Firefox、IE、Edge、Safari、HBuilderX
  • package.json文件中不允许出现注释，否则扩展配置无效
  • vue-cli需更新到最新版，HBuilderX需升级到 2.1.6+ 版本

    示例：钉钉小程序

    如下是一个自定义钉钉小程序（MP-DINGTALK）的package.json示例配置（拷贝代码记得去掉注释）：
    1. "uni-app": {
    2.   "scripts": {
    3.       "mp-dingtalk": { 
    4.       "title":"钉钉小程序", 
    5.           "env": { 
    6.               "UNI_PLATFORM": "mp-alipay" 
    7.           },
    8.           "define": { 
    9.               "MP-DINGTALK": true 
    10.           }
    11.       }
    12.   }
    13. }
    在代码中使用自定义平台
    开发者可在代码中使用MP-DINGTALK进行条件编译，如下：
    1. // #ifdef MP
    2. 小程序平台通用代码（含钉钉）
    3. // #endif
    4. // #ifdef MP-ALIPAY
    5. 支付宝平台通用代码（含钉钉）
    6. // #endif
    7. // #ifdef MP-DINGTALK
    8. 钉钉平台特有代码
    9. // #endif
    运行及发布项目
    vue-cli开发者可通过如下命令，启动钉钉小程序平台的编译：
    1. npm run dev:custom mp-dingtalk 
    2. npm run build:custom mp-dingtalk
    HBuilderX会根据package.json的扩展配置，在运行、发行菜单下，生成自定义菜单（钉钉小程序），开发者点击对应菜单编译运行即可，如下图：
    image.png
    Tips：钉钉小程序编译目录依然是mp-alipay，需通过支付宝开发者工具，选择“钉钉小程序”，然后打开该目录进行预览及发布。

    示例：微信服务号

    如下是一个自定义微信服务号平台（H5-WEIXIN）的示例配置：
    1. "uni-app": {
    2.   "scripts": {
    3.       "h5-weixin": { 
    4.           "title":"微信服务号",
    5.           "BROWSER":"Chrome",  
    6.           "env": {
    7.               "UNI_PLATFORM": "h5"  
    8.            },
    9.           "define": { 
    10.               "H5-WEIXIN": true 
    11.           }
    12.       }
    13.   }    
    14. }
    开发者可在代码块中使用H5-WEIXIN变量，如下：
    1. // #ifdef H5
    2. H5平台通用代码（含微信服务号）
    3. // #endif
    4. // #ifdef H5-WEIXIN
    5. 微信服务号特有代码
    6. // #endif
    vue-cli开发者可通过如下命令，启动微信服务号平台（H5-WEIXIN）平台的编译：
    1. npm run dev:custom h5-weixin 
    2. npm run build:custom h5-weixin
    HBuilderX会根据package.json的扩展配置，在运行、发行菜单下，生成自定义菜单（微信服务号），开发者点击对应菜单编译运行即可，如下图：
    image.png