Walle

Walle（瓦力）：Android Signature V2 Scheme签名下的新一代渠道包打包神器

瓦力通过在Apk中的APK Signature Block区块添加自定义的渠道信息来生成渠道包，从而提高了渠道包生成效率，可以作为单机工具来使用，也可以部署在HTTP服务器上来实时处理渠道包Apk的升级网络请求。

Quick Start

为了方便大家的使用，我们提供了2种使用方式：

Gradle插件方式，方便快速集成
命令行方式，最大化满足各种自定义需求

Gradle插件使用方式

配置build.gradle

在位于项目的根目录 build.gradle 文件中添加Walle Gradle插件的依赖，如下：

buildscript {
    dependencies {
        classpath 'com.meituan.android.walle:plugin:1.0.5'
    }
}

并在当前App的 build.gradle 文件中apply这个插件，并添加上用于读取渠道号的AAR

apply plugin: 'walle'

dependencies {
    compile 'com.meituan.android.walle:library:1.0.5'
}

配置插件

walle {
    // 指定渠道包的输出路径
    apkOutputFolder = new File("${project.buildDir}/outputs/channels");
    // 定制渠道包的APK的文件名称
    apkFileNameFormat = '${appName}-${packageName}-${channel}-${buildType}-v${versionName}-${versionCode}-${buildTime}.apk';
    // 配置渠道文件列表，也可以通过channelList来配置
    channelFile = "./channel";
}

目前插件支持下面几个配置项：

apkOutputFolder：指定渠道包的输出路径，默认值为new File("${project.buildDir}/outputs/apk")
apkFileNameFormat：定制渠道包的APK的文件名称, 默认值为'${appName}-${buildType}-${channel}.apk'
channelList：渠道信息列表
channelFile：包含渠道配置信息的文件路径
extraInfo：以key:value形式提供，多个以,分隔

可以通过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哈希值)

如何获取渠道信息

在需要渠道等信息时可以通过下面代码进行获取

String channel = WalleChannelReader.getChannel(this.getApplicationContext());

如何生成渠道包

生成渠道包的方式是和assemble${variantName}Channels指令结合，可以通过传入参数决定是否生成渠道包，也可以通过在build.gradle中的walle闭包中配置相应的参数，渠道包的生成目录默认存放在 build/outputs/apk/，也可以通过walle闭包中的apkOutputFolder参数来指定输出目录

下面是各类用法示例：

生成单个渠道包 ./gradlew clean assembleReleaseChannels -PchannelList=meituan
支持 productFlavors ./gradlew clean assembleMeituanReleaseChannels -PchannelList=meituan
生成多个渠道包 ./gradlew clean assembleReleaseChannels -PchannelList=meituan,dianping
通过渠道配置文件来生成渠道包 ./gradlew clean assembleReleaseChannels -PchannelFile=channel

渠道信息的配置文件支持配置相对路径，详见：配置文件示例，同时配置文件支持使用#号添加注释。

命令行工具使用方式

可以使用命令行工具来支持各类自定义的需求，具体使用方式详见：Walle CLI 使用说明

其他使用方式

为了更好的满足大家的各类自定义需求，我们把对APK Signing Block区块进行读写操作的模块进行了封装。

读写模块的使用说明详见：

原理介绍

对该工具的原理感兴趣的同学，可以移步美团Android新一代渠道包生成工具进行了解。

注意事项

使用apksigner重新对Apk签名会导致渠道信息丢失，需要再次写入渠道信息

技术支持

Read The Fucking Source Code
通过提交issue来寻求帮助
联系我们寻求帮助

贡献代码

欢迎提交issue
欢迎提交PR

参考

License

Copyright 2017 Meituan-Dianping

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

bornbeauty/walle