uni-app 通过在package.json
文件中增加uni-app
扩展节点,可实现自定义条件编译平台。
扩展新的平台后,有3点影响:
注意只能扩展web和小程序平台,不能扩展app打包。并且扩展小程序平台时只能基于指定的基准平台扩展子平台,不能扩展基准平台。基准平台详见下文。
package.json扩展配置用法:
{
/**
* package.json其它原有配置
* 拷贝代码后请去掉注释!
*/
"uni-app": {// 扩展配置
"scripts": {
"custom-platform": { //自定义编译平台配置,可通过cli方式调用
"title":"自定义扩展名称", // 在HBuilderX中会显示在 运行/发行 菜单中
"browser":"", //运行到的目标浏览器,仅当UNI_PLATFORM为h5时有效
"env": {//环境变量
"UNI_PLATFORM": "", //基准平台
"MY_TEST": "", // ... 其他自定义环境变量
},
"define": { //自定义条件编译
"CUSTOM-CONST": true //自定义条件编译常量,建议为大写
}
}
}
}
}
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示例配置(拷贝代码记得去掉注释):
"uni-app": {
"scripts": {
"mp-dingtalk": {
"title":"钉钉小程序",
"env": {
"UNI_PLATFORM": "mp-alipay"
},
"define": {
"MP-DINGTALK": true
}
}
}
}
在代码中使用自定义平台
开发者可在代码中使用MP-DINGTALK
进行条件编译,如下:
// #ifdef MP
小程序平台通用代码(含钉钉)
// #endif
// #ifdef MP-ALIPAY
支付宝平台通用代码(含钉钉)
// #endif
// #ifdef MP-DINGTALK
钉钉平台特有代码
// #endif
运行及发布项目
vue-cli
开发者可通过如下命令,启动钉钉小程序平台的编译:
npm run dev:custom mp-dingtalk
npm run build:custom mp-dingtalk
HBuilderX
会根据package.json
的扩展配置,在运行
、发行
菜单下,生成自定义菜单(钉钉小程序),开发者点击对应菜单编译运行即可,如下图:
Tips:钉钉小程序编译目录依然是mp-alipay
,需通过支付宝开发者工具,选择“钉钉小程序”,然后打开该目录进行预览及发布。
如下是一个自定义微信服务号平台(H5-WEIXIN)的示例配置:
"uni-app": {
"scripts": {
"h5-weixin": {
"title":"微信服务号",
"browser":"chrome",
"env": {
"UNI_PLATFORM": "h5"
},
"define": {
"H5-WEIXIN": true
}
}
}
}
开发者可在代码块中使用H5-WEIXIN
变量,如下:
// #ifdef H5
H5平台通用代码(含微信服务号)
// #endif
// #ifdef H5-WEIXIN
微信服务号特有代码
// #endif
vue-cli
开发者可通过如下命令,启动微信服务号平台(H5-WEIXIN)平台的编译:
npm run dev:custom h5-weixin
npm run build:custom h5-weixin
HBuilderX
会根据package.json
的扩展配置,在运行
、发行
菜单下,生成自定义菜单(微信服务号),开发者点击对应菜单编译运行即可,如下图: