在开发App时,经常需要切换开发环境,最常用的就是开发环境(测试服务器)和生产环境(正式服务器),更保险的,则会在上线前,会先在预发布(生产环境克隆版)环境跑一遍。
不同环境之间,签名、包名、服务器地址、应用名称、图标可能都不一样。手动切换环境不仅麻烦而且易出错。
为什么不同的环境要使用不同的applicationId、应用名称甚至图标呢,如果你遇到测试向你抱怨,在同一台设备上反复安装卸载app,只是为了切换环境,有时候自己都搞不清出安装的是哪个环境app时,你就会懂的这做多么有用。
这里详细讲几种多环境打包编译的方式。
一个环境一个分支
比如master就是开发分支,preview是预发布环境分支,release是生产环境分支。
不同分支之间,在上线时只有环境相关的代码或者配置是不一样的。
假设我们上线的流程是开发->测试->预发布->生产,在测试完成后,将master的改动合并到preview分支上,然后切换到preview分支打包预发布环境的安装包。通过测试后再合并到release,编译并上线完成。
需要注意的问题:不同分支之间,在代码合并时要特别注意不要将环境配置合并了。
使用gradle配置
打开app/build.gradle文件,找到buildTypes,默认有debug和release两个编译版本,我们添加了第三种:preview。
使用React Native的同学请注意:
新增一个buildTypes,如果名字不是releaseXXX
或则会debugXXX
,jsbundle将不会被打包到apk中。
React Native工程中的app/build.gralde写在前面的注释中有这么一段:
* // whether to bundle JS and assets in another build variant (if configured).
* // See http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Build-Variants
* // The configuration property can be in the following formats
* // 'bundleIn${productFlavor}${buildType}'
* // 'bundleIn${buildType}'
* // bundleInFreeDebug: true,
* // bundleInPaidRelease: true,
* // bundleInBeta: true,
也就是说,如果我们要引入名为preview的buildTypes,需要加入这么一段:
project.ext.react = [
entryFile: "index.js",
// 添加
bundleInPreview: true
]
在buildTypes和productFlavors中,我们多种方式个性化编译配置。以下是我经常用到的几种:
- applicationId 可以在buildTypes中指定新的,覆盖defaultConfig中的设置
- applicationIdSuffix 给applicationId添加后缀,比如.dev这样的
- manifestPlaceholders 此处定义的内容,可以在清单文件AndroidManifest.xml中使用,比如
android:label="${app_name}"
- buildConfigField 定义后可以通过BuildConfig.xxx使用
- resValue 跟在xml中定义的量一样,注意不要重复冲突就行,在Java中通过
getResources().getString(R.string.app_name)
之类的方式拿到,在xml(如布局)中可以通过@string/app_name
引用。 - 可以通过gradle.properties设置环境变量,如定义签名文件
MYAPP_RELEASE_STORE_FILE=my-release-key.keystore
,则可以在signingConfig 中使用storeFile file(MYAPP_RELEASE_STORE_FILE)
。
下面是示例:
多版本打包
buildTypes {
debug {
// applicationId添加后缀
//比如defaultConfig中设置的applicationId为com.example.myapp
//编译debug版本时applicationId将是com.example.myapp.dev
applicationIdSuffix ".dev"
manifestPlaceholders = [
app_name: "myApp-dev",
app_icon: "@drawable/icon_deve"
]
//开发服务器地址
buildConfigField "String", "BASE_URL", '"https://dev.example.com/api"'
//开发环境 极光推送的AppKey
buildConfigField "String", "JPUSH_APP_KEY", '"xxxxxx"'
signingConfig signingConfigs.debug
}
release {
applicationIdSuffix ".prod"
manifestPlaceholders = [
app_name: "myApp",
app_icon: "@drawable/icon_prod"
]
//生产服务器地址
buildConfigField "String", "BASE_URL", '"https://prod.example.com/api"'
//生产环境 极光推送的AppKey
buildConfigField "String", "JPUSH_APP_KEY", '"xxxxxx"'
signingConfig signingConfigs.release
minifyEnabled enableProguardInReleaseBuilds
proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
}
preview {
applicationIdSuffix ".preview"
manifestPlaceholders = [
app_name: "myApp-preview",
app_icon: "@drawable/icon_prod"
]
//预览版服务器地址
buildConfigField "String", "BASE_URL", '"https://preview.example.com/api"'
//预览环境 极光推送的AppKey
buildConfigField "String", "JPUSH_APP_KEY", '"xxxxxx"'
// 子模块没有preview时,则会匹配release
matchingFallbacks = ['release']
signingConfig signingConfigs.release
minifyEnabled enableProguardInReleaseBuilds
proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
}
}
多渠道打包
// 类型维度
flavorDimensions "myapp"
productFlavors {
// 官网下载渠道
official {
//自定义资源,类似在strings.xml中配置的
//Java中使用 getResources().getString(R.string.channel)
//xml中使用 android:text="@string/channel"
resValue "string", "channel", "official"
}
//应用宝下载渠道
tencent {
resValue "string", "channel", "tencent_market"
}
}
如果想编译preview版本的apk,则可以
./gradlew assemblePreview
编译完成后apk保存在app/build/outputs/apk
中,由于我们定义了两个变体(productFlavors),因此将输出两个变体版本的apk,存储路径是app/build/outputs/apk/{productFlavor}${buildType}
,一个channel值为official的官网渠道版本,另一个是值为tencent的应用包渠道版本。
如果只想编译一种变体,可以执行
./gradlew assembleOfficialPreview
完结。