前期工作:我们如果想要使用这种多渠道打包方式,Jdk版本是需要Jdk1.8的,需要在环境变量里面配置一下Gradle文件路径,
在使用之前我们还需要签名:
这段代码放在项目build.gradle的android节点下
//签名配置文件 signingConfigs { debug { } release { keyAlias '别名' keyPassword '密码' storeFile file('你的签名文件路径') storePassword '密码' } }
以下一句话放在buildTypes节点下的release下
signingConfig signingConfigs.release
切换到Project视图下
在当前moudle目录下创建文件channel填写打包渠道的信息(Text文本格式)
meituan # 美团 samsungapps #三星 hiapk anzhi xiaomi # 小米 91com gfan appchina nduoa 3gcn mumayi 10086com wostore 189store lenovomm hicloud meizu wandou # Google Play # googleplay # 百度 baidu # # 360 360cn # # 应用宝 myapp
又创建了一个测试版本的打包渠道channel_debug
meituan # 美团 samsungapps #三星
Walle
Walle(瓦力):Android Signature V2 Scheme签名下的新一代渠道包打包神器
瓦力通过在Apk中的APK Signature Block
区块添加自定义的渠道信息来生成渠道包,从而提高了渠道包生成效率,可以作为单机工具来使用,也可以部署在HTTP服务器上来实时处理渠道包Apk的升级网络请求。
Gradle插件使用方式
配置build.gradle
在位于项目的根目录 build.gradle
文件中添加Walle Gradle插件的依赖, 如下:
buildscript {
dependencies {
classpath 'com.meituan.android.walle:plugin:1.1.6'
}
}
并在当前App的 build.gradle
文件中apply这个插件,并添加上用于读取渠道号的AAR
apply plugin: 'walle'
dependencies {
compile 'com.meituan.android.walle:library:1.1.6'
}
配置插件
walle {
// 指定渠道包的输出路径
apkOutputFolder = new File("${project.buildDir}/outputs/channels");
// 定制渠道包的APK的文件名称
apkFileNameFormat = '${appName}-${packageName}-${channel}-${buildType}-v${versionName}-${versionCode}-${buildTime}.apk';
// 渠道配置文件
channelFile = new File("${project.getProjectDir()}/channel")
}
配置项具体解释:
apkOutputFolder:指定渠道包的输出路径, 默认值为
new File("${project.buildDir}/outputs/apk")
apkFileNameFormat:定制渠道包的APK的文件名称, 默认值为
'${appName}-${buildType}-${channel}.apk'
可使用以下变量:projectName - 项目名字 appName - App模块名字 packageName - applicationId (App包名packageName) buildType - buildType (release/debug等) channel - channel名称 (对应渠道打包中的渠道名字) versionName - versionName (显示用的版本号) versionCode - versionCode (内部版本号) buildTime - buildTime (编译构建日期时间) fileSHA1 - fileSHA1 (最终APK文件的SHA1哈希值) flavorName - 编译构建 productFlavors 名
channelFile:包含渠道配置信息的文件路径。 具体内容格式详见:渠道配置文件示例,支持使用#号添加注释。
如何获取渠道信息
在需要渠道等信息时可以通过下面代码进行获取
String channel = WalleChannelReader.getChannel(this.getApplicationContext());
如何生成渠道包
生成渠道包的方式是和assemble${variantName}Channels
指令结合,渠道包的生成目录默认存放在 build/outputs/apk/
,也可以通过walle
闭包中的apkOutputFolder
参数来指定输出目录
用法示例:
- 生成渠道包
./gradlew clean assembleReleaseChannels
- 支持 productFlavors
./gradlew clean assembleMeituanReleaseChannels
集成完之后可能会报错:
Error occurred during initialization of VM Could not reserve enough space for 1572864KB object heap
这意味着JVM没有足够的内存空间。gradle添加以下属性。属性文件将解决你的问题!
解决方案:
1:在个人文件夹( (C:/Users/username/.gradle 或 ~/.gradle))下创建gradle.properties文件,添加
org.gradle.jvmargs=-Xmx512m -XX:MaxPermSize=512m
- 1
2:或者直接在Android Studio中gradle.properties文件中添加下面这行,存在则修改
org.gradle.jvmargs=-Xmx512m -XX:MaxPermSize=512m
更多用法
插入额外信息
channelFile
只支持渠道写入,如果想插入除渠道以外的其他信息,请在walle配置中使用configFile
walle {
// 渠道&额外信息配置文件,与channelFile互斥
configFile = new File("${project.getProjectDir()}/config.json")
}
configFile
是包含渠道信息和额外信息的配置文件路径。
配置文件采用json格式,支持为每个channel单独配置额外的写入信息。具体内容格式详见:渠道&额外信息配置文件示例 。
注意:
- 此配置项与
channelFile
功能互斥,开发者在使用时选择其一即可,两者都存在时configFile
优先执行。 - extraInfo 不要出现以
channel
为key的情况
而对应的渠道信息获取方式如下:
ChannelInfo channelInfo= WalleChannelReader.getChannelInfo(this.getApplicationContext());
if (channelInfo != null) {
String channel = channelInfo.getChannel();
Map<String, String> extraInfo = channelInfo.getExtraInfo();
}
// 或者也可以直接根据key获取
String value = WalleChannelReader.get(context, "buildtime");
临时生成某渠道包
我们推荐使用channelFile/configFile配置来生成渠道包,但有时也可能有临时生成渠道包需求,这时可以使用:
生成单个渠道包:
./gradlew clean assembleReleaseChannels -PchannelList=meituan
生成多个渠道包:
./gradlew clean assembleReleaseChannels -PchannelList=meituan,dianping
生成渠道包&写入额外信息:
./gradlew clean assembleReleaseChannels -PchannelList=meituan -PextraInfo=buildtime:20161212,hash:xxxxxxx
注意: 这里的extraInfo以
key:value
形式提供,多个以,
分隔。使用临时channelFile生成渠道包:
./gradlew clean assembleReleaseChannels -PchannelFile=/Users/xx/Documents/channel
使用临时configFile生成渠道包:
./gradlew clean assembleReleaseChannels -PconfigFile=/Users/xx/Documents/config.json
使用上述-P参数后,本次打包channelFile/configFile配置将会失效,其他配置仍然有效。 -PchannelList
,-PchannelFile
, -PconfigFile
三者不可同时使用。
命令行工具使用方式
可以使用命令行工具来支持各类自定义的需求,具体使用方式详见:Walle CLI 使用说明
其他使用方式
为了更好的满足大家的各类自定义需求,我们把对APK Signing Block
区块进行读写操作的模块进行了封装。
读写模块的使用说明详见:
Q&A
原理介绍
对该工具的原理感兴趣的同学,可以移步美团Android新一代渠道包生成工具进行了解。
注意事项
- 使用apksigner重新对Apk签名会导致渠道信息丢失,需要再次写入渠道信息
- 1.1.3版本起,walle支持对含有comment的apk进行渠道写入, 详见issue 52