简介

VasDolly是一种快速多渠道打包工具，同时支持基于V1签名和V2签名进行多渠道打包。插件本身会自动检测Apk使用的签名类别，并选择合适的多渠道打包方式，对使用者来说完全透明。 V3.0.4版本已支持Android Gradle Plugin 4.2.0以上版本，欢迎使用！

目前Gradle Plugin 2.2以上默认开启V2签名，所以如果想关闭V2签名，可将下面的v2SigningEnabled设置为false。关于应用签名说明：见官方文档

signingConfigs {
        release {
            ...
            v1SigningEnabled true
            v2SigningEnabled false
        }

        debug {
            ...
            v1SigningEnabled true
            v2SigningEnabled false
        }
    }

接入流程

添加对VasDolly Plugin的依赖

在根工程的build.gradle中，添加对打包Plugin的依赖：

dependencies {
        classpath 'com.android.tools.build:gradle:7.0.3'
        classpath 'com.tencent.vasdolly:plugin:3.0.4'
}

引用VasDolly Plugin

在主App工程的build.gradle中，添加对VasDolly Plugin的引用：

apply plugin: 'com.tencent.vasdolly'

添加对VasDolly helper类库的依赖

在主App工程的build.gradle中，添加读取渠道信息的helper类库依赖：

dependencies {
    api 'com.tencent.vasdolly:helper:3.0.4'
}

配置渠道列表

目前有两种方式配置渠道列表，最终的渠道列表是两者的累加之和：

在gradle.properties文件指定渠道文件名称，该渠道文件必须位于根工程目录下，一行一个渠道信息。

channel_file=channel.txt

在channel或者rebuildChannel属性中通过channelFile属性指定渠道文件，一行一个渠道信息。

channel{
    //指定渠道文件
    channelFile = file("/Users/leon/Downloads/testChannel.txt")
}
rebuildChannel{
    //指定渠道文件
    channelFile = file("/Users/leon/Downloads/testReChannel.txt")
}

通过Gradle生成多渠道包

直接编译生成多渠道包

若是直接编译生成多渠道包，首先要配置渠道文件、渠道包的输出目录和渠道包的命名规则：

channel{
    //指定渠道文件
    channelFile = file("/Users/leon/Downloads/testChannel.txt")
     //多渠道包的输出目录，默认为new File(project.buildDir,"channel")
    outputDir = new File(project.buildDir,"xxx")
    //多渠道包的命名规则，默认为：${appName}-${versionName}-${versionCode}-${flavorName}-${buildType}-${buildTime}
    apkNameFormat ='${appName}-${versionName}-${versionCode}-${flavorName}-${buildType}'
    //快速模式：生成渠道包时不进行校验（速度可以提升10倍以上，默认为false）
    fastMode = false
    //buildTime的时间格式，默认格式：yyyyMMdd-HHmmss
    buildTimeDateFormat = 'yyyyMMdd-HH:mm:ss'
    //低内存模式（仅针对V2签名，默认为false）：只把签名块、**目录和EOCD读取到内存，不把最大头的内容块读取到内存，在手机上合成APK时，可以使用该模式
    lowMemory = false
}

其中，多渠道包的命名规则中，可使用以下字段：

appName ：当前project的name
versionName ：当前Variant的versionName
versionCode ：当前Variant的versionCode
buildType ：当前Variant的buildType，即debug or release
flavorName ：当前的渠道名称
appId ：当前Variant的applicationId
buildTime ：当前编译构建日期时间，时间格式可以自定义，默认格式：yyyyMMdd-HHmmss

然后，通过gradle channelDebug、gradle channelRelease命令分别生成Debug和Release的多渠道包。

为了方便临时生成渠道包进行测试，我们从v2.0.0开始支持添加渠道参数：gradle channelDebug(channelRelease) -Pchannels=yingyongbao,gamecenter，这里通过属性channels指定的渠道列表拥有更高的优先级，且和原始的文件方式是互斥的。

根据已有基础包重新生成多渠道包

若是根据已有基础包重新生成多渠道包，首先要配置渠道文件、基础包的路径和渠道包的输出目录：

rebuildChannel {
  //指定渠道文件
  channelFile = file("/Users/leon/Downloads/testReChannel.txt")
  // 已有APK文件地址（必填）,如new File(project.rootDir, "/baseApk/app_base.apk"),文件名中的base将被替换为渠道名
  baseApk = 已有APK文件地址（必填）
  //默认为new File(project.buildDir, "rebuildChannel")
  outputDir = 渠道包输出目录
  //快速模式：生成渠道包时不进行校验（速度可以提升10倍以上，默认为false）
  fastMode = false
  //低内存模式（仅针对V2签名，默认为false）：只把签名块、**目录和EOCD读取到内存，不把最大头的内容块读取到内存，在手机上合成APK时，可以使用该模式
  lowMemory = false
}

然后，通过gradle rebuildChannel命令生成多渠道包。

为了方便临时生成渠道包进行测试，我们从v2.0.0开始支持添加渠道参数：gradle rebuildChannel -Pchannels=yingyongbao,gamecenter，这里通过属性channels指定的渠道列表拥有更高的优先级，且和原始的文件方式是互斥的。

通过命令行生成渠道包、读取渠道信息

从V1.0.5版本开始支持命令行，具体使用文档可参考command目录下的README。

读取渠道信息

通过helper类库中的ChannelReaderUtil类读取渠道信息。

String channel = ChannelReaderUtil.getChannel(getApplicationContext());

如果没有渠道信息，那么这里返回null，开发者需要自己判断。

Demo参考

详细的接入范式，可参考Demo

实现原理

具体原理可参考VasDolly实现原理

问题反馈

遇到任何问题或者有好的建议，欢迎提issues，或者QQ（1031747903）联系。

TODO

增加单元测试
防渠道信息篡改
提供Python脚本

License

VasDolly is under the BSD license. See the LICENSE file for details.

coolguyun/VasDolly

简介