uapp 是一个方便 uniapp 离线打包的脚手架工具,类似 cordova, expo, Taro 等项目cli的作用。uapp还包含 uapp-android, uapp-ios 两个平台的模板代码。
开发过程中,很多繁琐的操作用uapp
都是一步搞定:
- 开起一个新项目,通常要修改工程里的很多参数,比如app的名称,版本号, dcloud_key, 微信相关的 appkey
等,人工不仅繁琐,还容易出错,使用
uapp manifest sync
一步搞定。 - APP发布和开发调试时的配置不完全相同,比如你不能把 debug-server-release.aar 这种调试相关的库发布,那就需要把发布和开发的配置隔离开,uapp已经帮你做好隔离配置,并且很方便通过jenkins实现发布流程的自动化集成,即使不需要也好过手动改来改去,把自己都改晕了。
- 自己编译个调试基座,还需要手动 COPY 到 HBuilderX 下?用
uapp publish debug
自动编译一步搞定。 - HBuilderX 编译好的本地APP资源,还需要手动 COPY 到工程里? 用
uapp prepare
一步搞定。 - 微信开发者平台,DCloud 开发者中心 都需要的签名信息怎么查看,
uapp info
一步搞定。 - uniapp-cli 创建新工程的命令是啥了的,没记住,
uapp new xxx
一步搞定。
uniapp 用一套代码,运行到多个平台
uniapp是一个基于Vue同构技术的多平台前端框架,对公司或创业者来说,只需要有一个会Vue的前端,就可以同时写App(android/ios) ,H5,快应用,微信/QQ/抖音/飞书/百度/支付宝等各家小程序,维护一套代码可以发布10多个平台。有以下几大好处:
- 发布多个平台获取更多流量
- 一旦熟悉,开发效率极高
- 至少省 1 / 3 研发成本,商业试错成本更低
- 即使当前不需要发布多平台,同样花时间写代码,为什么不选择复用价值更高的方法呢
但 uniapp 官方发布的离线包里只有 DEMO,对于一个新的项目,需要手动更改的配置较多,且调试基座和正式发版共用一个配置,维护起来也很不方便。uapp 就是我们在实践了一些产品后,积累的一些经验,分离了调试和发布的配置,也方便通过命令加入自动化集成。
为什么不使用在线打包呢?
uniapp 在线打包,一般无法满足灵活的需求,比如:
- 没法在团队里实施自动化集成(自动构建、单元测试、发布)。
- 有些包是冗余的,在线打包不能控制具体打入哪些包。
- 在线打包有大小限制,超过需要单独付费,因为特别占用官方服务器资源。
- 写uniapp插件扩展时,必须有离线工程才方便调试,且可以自己控制是否发布插件。我们也是在写 ffmpeg 扩展时,遇到些许不便。
1、 安装 uapp 命令
npm install -g uapp
# 初始化或更新 uappsdk
uapp sdk init
2、下载 uniapp 离线打包的 SDK
注意和.uappsdk区分开,此处的uniapp离线包的SDK是指dcloud 官方发布的
android 离线打包SDK:
https://nativesupport.dcloud.net.cn/AppDocs/download/android
ios 离线打包SDK:
https://nativesupport.dcloud.net.cn/AppDocs/download/ios
解压其中的SDK目录,放入 .uappsdk 文件夹里,最终 .uappsdk 文件夹结构如下:
> $HOME/.uappsdk/
.
├── android
│ ├── SDK # -> 这里是Android的SDK
│ └── libs
├── ios
│ ├── SDK # -> 这里是iOS的SDK
└── templates
└── manifest.json
SDK 相关文件都放在当前用户的 $HOME/.uappsdk 目录下。
需要引入哪些模板,请务必仔细阅读官方的 SDK 模块依赖说明,包含多了会影响APP审核,少了会影响功能使用。
.uappsdk 目录下默认包含的第三方依赖包,仅含有微信授权登录,苹果授权登录,基础功能等。不包含广告、通知等相关依赖,因为广告和通知类的sdk,在审核时需要特别提交数据跟踪说明,比较麻烦。
如不是必须,最好不包含。如果确实需要,可以自行手动添加,参照如下模块依赖说明。
android 模块依赖说明:
针对 android,仅需提取必用的依赖包放入 $HOME/.uappsdk/android/libs 里。 https://nativesupport.dcloud.net.cn/AppDocs/usemodule/androidModuleConfig/android_Library
ios 模块依赖说明:
https://nativesupport.dcloud.net.cn/AppDocs/usemodule/iOSModuleConfig/common
git clone https://github.com/uappkit/uapp-android.git
git clone https://github.com/uappkit/uapp-ios.git
iOS 的工程化一直都不太方便,通常都是用的 CocoaPods,但不适合 DCloud离线SDK 的发布形式。经过我们在产品中的不断实践,最终选择了 XCodeGen。
# 读取 manifest 中的配置,并更新基本信息
uapp manifest info
uapp manifest sync ${webapp}/src/manifest.json
# 更新 HBuilderX 本地打包资源
# 如果通过 HBuilderX 重新编译,或者通过 uniapp-cli 命令重新编译的资源,可以通过 prepare 命令更新到离线 APP 工程中,用于 APP 重新打包发布。
uapp prepare
# 编译并发布自定义基座到 HBuilderX 下
uapp publish debug
注意:
uapp.* 参数
是 uapp 根据需要扩展出来的, 非 dcloud 官方标准.
原工程里的 manifest.json
内的参数,大多是给 hbuiderx 在线云打包用的。编译后生成的终极发布包,里面的 manifest.json
已被去除了无关数据,所以不用担心参数暴露问题。
{
"name": "uapp",
"appid": "__UNI__ECA8F4D",
"versionName": "1.0.1",
"versionCode": "1000000",
"uapp": {
"name": "μAppKit",
"package": "com.code0xff.uapp",
"android.appkey": "b4ab7d1c668cbb3b257aeeabd75c29da",
"ios.appkey": "aa215ff1522abe39cb7ccec5943eeb92",
"prepare.dir": "${SRC}/../dist/build/app",
"prepare.before": "cd ${SRC}/../ && npm run build:app",
"prepare.after": "uapp publish debug"
'icon': 'icon地址'
},
"app-plus": {
"distribute": {
"sdkConfigs": {
"oauth": {
"weixin": {
"appid": "wx95039516c9f72e50",
"appsecret": "123456",
"UniversalLinks": "https://uapp.code0xff.com/"
}
}
}
}
}
}
👉 不同平台可以用前缀区分
name, package, versionName, versionCode 如果需要平台差异化定义, 可以加前缀 android.xxx, ios.xxx
例如 android.name, android.package, ios.package, ios.versionCode ...
prepare.* 参数内,可以使用
${SRC}, ${SRC}
为当前 manifest.json 的同级目录,支持加 ../定位上一级目录,避免用绝对路径。
👇👇 👇
uapp.* 参数 | 说明 |
---|---|
name | APP名字,不填写默认使用根节点的name。不同平台可以加前缀区分,如 android.name |
package | 应用的包名。不同平台可以加前缀区分,如 ios.package |
android.appkey | DCloud平台申请的,Android 平台 dcloud_appkey,下方有申请地址 |
ios.appkey | DCloud平台申请的,iOS 平台 dcloud_appkey,下方有申请地址 |
versionName | App版本名,同上可以加前缀区分不同平台。如 android.versionName |
versionCode | App版本Code,同上可以加前缀区分不同平台。如 ios.versionCode |
prepare.dir | (选填) 自定义 uapp prepare 获取编译资源的路径 |
prepare.before | (选填) 在 uapp prepare 执行前的命令。比如可以执行 npm run build:app 先编译 vue 项目 |
prepare.after | (选填) 在 uapp prepare 执行后的命令。比如可以执行 uapp publish debug 发布离线包 |
如何申请 dcloud_appkey
https://nativesupport.dcloud.net.cn/AppDocs/usesdk/appkey
如何申请微信 appid
登录微信开发者平台创建APP,审核过后,获取 weixin.appid, weixin.appsecret
等参数,用于微信登录,分享,支付等相关参数
https://uniapp.dcloud.io/matter.html
1、获取到 team_id, client_id, key_id 填入到 jwt/config.json 中,如下:
{
"team_id": "3DSM494K6L",
"client_id": "com.code0xff.uapp.login",
"key_id": "3C7FMSZC8Z"
}
2、登录苹果开发者账号,创建并下载签名文件, 改名为jwt/key.txt。
3、运行 uapp info
命令查看 JWT Token
👉 参考教程: http://help.jwt.code0xff.com
The Apache License 2. Please see License File for more information.