如果你还在使用一个java文件声明静态变量来配置接口环境及其他环境,每次打包发布需要不断取消注解。那么恭喜你下文你刚好用得到。
- 开撸之前,捋一下最后需要达到什么效果呢?
- 支持最少三中接口环境配置
- 支持配置多个第三方AppKey
- apk文件命名与环境对应(xx-v1.0.1-debug.apk)
- 不同环境可同时安装(可选)
- 使用不同的ApkName,不同得LOGO
- 不同环境打不同的包名
** 宝典 “build.gradle + gradle.properties +BuildConfig.java+占位符” **
首先,要认识下BuildConfig.java这个文件。
在我们使用build.gradle文件进行同步编译时,都会在module目录下的build文件夹中创建一个BuildConfig.java文件。
**double Shift **输入 BuildConfig 你就能找到此文件。这个文件是gradle自己生成的。用于保存你在build.gradle文件中的配置信息。路径是主包名根路径下(单独放在build目录下而已)。所以在整个项目中我们都可以直接使用BuildConfig.XX来引用对应属性。
BuildConfig.java 每次项目编译后都会刷新,重新写入。
进来一看你就会发现,BuildConfig文件中生成的属性全是
public static final
。这完全就是个典型的配置文件,不同的是它会根据gradle配置自动刷新重新写入。看到这里,套路就明显了:在gradle文件中针对不同打包编译环境,配置我们各种环境配置属性即可达到我们的目的。
正式开撸
为了实现上面提到要求,这里配置三种打包环境,默认debug模式,渠道包测试,渠道包正式。
-
配置需要用到的环境地址
为了让build.gradle文件中更简洁,这里利用build.gradle文件可以直接引用gradle.properites中的属性,将接口配置先写在此文件中。
如下图
注意:在.properites
文件赋值遵守的格式要完全同Java语言中一至,否则就会变成这样下面这样,造成编译失败
public static final String NODE_JS = http://xx.xx.x:222/;
OK,上面配置了两个接口环境,一个正式,一个debug.每个对应三个接口和一个激光AppKey。
- 在build.gradle中引用配置
写入BuildConfig文件需要使用buildConfigField属性,根据占位符配置AndroidManifest.xml
文件。
在AndroidManifest.xml
文件中添加占位符
<meta-data
android:name="JPUSH_APPKEY"
android:value="${JPUSH_APPKEY_VALUE}"/>
- 为debug添加环境配置,这一步完成,直接Run得到的debug包就会使用下面参的数
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.config
}
//当出现3个或者3个以上环境和多个渠道时,线上不提供debug打包方式。
//直接使用特定渠道包作为测试包,指定不同包名
debug {
signingConfig signingConfigs.config
buildConfigField 'String','BASE_URL',BASE_URL_DEBUG
buildConfigField 'String','H5_BASE_URL',H5_BASE_URL_DEBUG
buildConfigField 'String','NODE_JS',NODE_JS_DEBUG
buildConfigField 'boolean','IS_TEST','true'
manifestPlaceholders = [UMENG_CHANNEL_VALUE: "debug"
,JPUSH_APPKEY_VALUE: JPUSH_KEY_TEST]
}
}
- 配置渠道包
在AndroidManifest.xml
添加渠道配置占位符
<!-- 配置渠道区分占位符 -->
<meta-data
android:name="UMENG_CHANNEL"
android:value="${UMENG_CHANNEL_VALUE}" />
添加两个渠道包配置,使用manifestPlaceholders 属性,配置好激光AppKay
productFlavors {
istest{
manifestPlaceholders = [UMENG_CHANNEL_VALUE: "istest"
,JPUSH_APPKEY_VALUE: JPUSH_KEY_TEST]
}
fromal {
manifestPlaceholders = [UMENG_CHANNEL_VALUE: "fromal"
,JPUSH_APPKEY_VALUE: JPUSH_KEY_FORMAL]
}
}
为不同渠道包配置不同接口环境
productFlavors.each {
flavors ->
//线上打包测试环境
if(flavors.name.equals("istest")){
//指定包名为.istest
// flavors.applicationIdSuffix '.istest'
flavors.buildConfigField 'String','BASE_URL',BASE_URL_TEST
flavors.buildConfigField 'String','H5_BASE_URL',H5_BASE_URL_TEST
flavors.buildConfigField 'String','NODE_JS',NODE_JS_TEST
flavors.buildConfigField 'boolean','IS_TEST','true'
//线上打包正式渠道包
}else{
flavors.buildConfigField 'String','BASE_URL',BASE_URL_FORMAL
flavors.buildConfigField 'String','H5_BASE_URL',H5_BASE_URL_FORMAL
flavors.buildConfigField 'String','NODE_JS',NODE_JS_FORMAL
flavors.buildConfigField 'boolean','IS_TEST','false'
}
}
接口环境配置就是这么简单,看看BuildConfig文件生成后的样子吧
我们配置的所有接口环境在这里生成了对应的属性,你只需要在把他当成普通的(不是亲生的)配置文件来用即可,无需在添加其他配置文件。
除了接口属性,多出来的是其他的配置,与此文无关直接忽略。
- 为了方便区分,我们还想在生成apk文件时对命名做点手脚,代码很简单直接上代码。
//修改生成的apk名字及输出文件夹
applicationVariants.all { variant ->
variant.outputs.each { output ->
//新名字
def newName
//时间戳
def timeNow
//输出文件夹
def outDirectory
//是否为Jenkins打包,输出路径不同
if ("true".equals(IS_JENKINS)) {
//BUILD_PATH为服务器输出路径
timeNow = BUILD_TIME
outDirectory = BUILD_PATH_JENKINS
//xx-v1.0.1-release.apk
newName = APPNAME+'-v'+APP_VERSION + '-'+variant.productFlavors[0].name +'-' + variant.buildType.name + '.apk'
output.outputFile = new File(outDirectory+"/"+timeNow, newName)
} else {
//本机打包输出在本机路径
outDirectory = BUILD_PATH_LOCAL
if ("debug".equals(variant.buildType.name)){
newName = APPNAME+'-v'+APP_VERSION + '-' + variant.buildType.name +'.apk'
}else {
newName = APPNAME+'-v'+APP_VERSION + '-' + variant.buildType.name +'-'+getDate()+ '.apk'
}
output.outputFile = new File(outDirectory, newName)
}
}
}
上面代码种,我们修改了apk生成路径及根据环境来命名。
下图时我更换版本号以后生成的两个apk文件。
- 如何安装一个测试的同时,再安装一个生成呢?
为主包名添加一个包名后缀,他就会完全变成一个新的apk包。
在上面渠道配置我注释了这一行。
debug时同样可以加入,只是最后的包名会变成com.xx.debug.istest
很难受还是不要加了。
//指定包名为.istest
// flavors.applicationIdSuffix '.istest'
- 不同环境设置不同的AppName 和logo?
这时候分两种,debug,和渠道包
先说debug模式,再src目录下创建debug文件夹,创建res文件夹,拷贝进你想修改的资源文件即可,我这里只是在原appName基础上加了debug-标识,所以只需要string文件。
如果你想换logo,与上同理
- 渠道包配置不同appName或者logo
上面我们提到,如何同时安装不同环境的apk包,需要为渠道包添加包名后缀。
上面举例flavors.applicationIdSuffix '.istest'
,这里包名后缀为 istest。
这时候我们在src目录下新建istest文件夹,创建res目录拷贝对应资源文件进行修改即可。
此前学习部署了Jenkins这个东西,并遗留了动态切换环境的问题。所以最近撸出了这个东西。一石头二鸟哈哈。
收工!如果你有什么问题或建议欢迎下方留言。