Walle(瓦力):Android Signature V2 Scheme签名下的新一代渠道包打包神器
瓦力通过在Apk中的APK Signature Block
区块添加自定义的渠道信息来生成渠道包,从而提高了渠道包生成效率,可以作为单机工具来使用,也可以部署在HTTP服务器上来实时处理渠道包Apk的升级网络请求。
快速开始
为了方便大家的使用,我们提供了2种使用方式:
- Gradle插件方式,方便快速集成
- 命令行方式,最大化满足各种自定义需求
在位于项目的根目录 build.gradle
文件中添加Walle Gradle插件的依赖, 如下:
buildscript {
dependencies {
classpath 'com.meituan.android.walle:plugin:1.0.0'
}
}
并在当前App的 build.gradle
文件中apply这个插件,并添加上用于读取渠道号的AAR
apply plugin: 'walle'
dependencies {
compile 'com.meituan.android.walle:library:1.0.0'
}
如何获取渠道信息
在需要渠道等信息时可以通过下面代码进行获取
String channel = WalleChannelReader.getChannel(this.getApplicationContext());
如何生成渠道包
生成渠道包的方式是和assemble指令结合,可以通过传入参数决定是否生成渠道包,渠道包的生成目录存放在build/outputs/apk/
下面是各类用法示例:
- 生成单个渠道包
./gradlew clean assembleRelease -PchannelList=meituan
- 支持 productFlavors
./gradlew clean assembleMeituanRelease -PchannelList=meituan
- 生成多个渠道包
./gradlew clean assembleRelease -PchannelList=meituan,dianping
- 通过渠道配置文件来生成渠道包
./gradlew clean assembleRelease -PchannelFile=channel
渠道信息的配置文件支持配置相对路径,详见:配置文件示例,同时配置文件支持使用#号添加注释。
更多用法
插入额外信息
如果想插入除渠道以外的其他信息,请在生成渠道包时使用
./gradlew clean assembleRelease -PchannelList=meituan -PextraInfo=buildtime:20161212,hash:xxxxxxx
extraInfo以key:value
形式提供,多个以,
分隔。
注意:
- extraInfo需要搭配channelList或者channelFile使用,plugin不支持只写入extraInfo。
- 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");
命令行工具使用方式
可以使用命令行工具来支持各类自定义的需求,具体使用方式详见:Walle CLI 使用说明
其他使用方式
为了更好的满足大家的各类自定义需求,我们把对APK Signing Block
区块进行读写操作的模块进行了封装。
读写模块的使用说明详见:
原理介绍
对该工具的原理感兴趣的同学,可以移步美团Android新一代渠道包生成工具进行了解。
注意事项
- 使用apksigner重新对Apk签名会导致渠道信息丢失,需要再次写入渠道信息