repository·master·Indexed 25 days ago
https://github.com/tencent/vasdollyA high-performance multi-channel packaging tool for Android that supports V1, V2, and V3 signing schemes. It provides a CLI (VasDolly.jar), a Gradle plugin for direct compilation or rebuilding from base APKs, and low-level Reader and Writer APIs (ChannelReader, IdValueReader, ChannelWriter, IdValueWriter) for managing channel information and custom ID-Value pairs.
The verify module is responsible for checking whether the generated multi-channel APKs can be correctly installed on all Android systems. It relies on Google's apksig tool for verification.
Note: This is implemented as a standalone Java module because apksig is compiled with Java 8, which is incompatible with standard Android modules (due to Dex limitations regarding version 52 byte code).
VasDolly provides several ways to add channel information to a base APK using the put command:
-f flag to skip strong validation, which can increase speed by over 10x.-mtc flag with a channel file to enable multi-threading for V1-based multi-channel packaging, suitable for large numbers of channels.To use the low-level ChannelWriter and IdValueWriter classes for fine-grained control over channel information and custom ID-Value pairs, add the following dependency to your project's dependencies block:
dependencies {
compile 'com.tencent.vasdolly:writer:3.0.4'
}To generate multi-channel APKs directly from your project, configure the channel block in your app-level build.gradle.
Configuration Options:
channelFile: Path to the channel file.outputDir: Output directory (default: project.buildDir/channel).apkNameFormat: Naming pattern. Available tokens: ${appName}, ${versionName}, ${versionCode}, ${flavorName}, ${buildType}, ${appId}, ${buildTime}.fastMode: If true, skips verification (increases speed by >10x, default false).buildTimeDateFormat: Format for ${buildTime} (default: yyyyMMdd-HHmmss).lowMemory: If true, only reads signature blocks, central directory, and EOCD into memory (useful for V2 signatures on low-memory devices, default false).Commands:
gradle channelDebug: Generates Debug multi-channel APKs.gradle channelRelease: Generates Release multi-channel APKs.Temporary Testing:
You can pass channels via command line using the -Pchannels property, which takes precedence over files:
gradle channelDebug -Pchannels=channel1,channel2
channel {
channelFile = file("/Users/leon/Downloads/testChannel.txt")
outputDir = new File(project.buildDir,"xxx")
apkNameFormat ='${appName}-${versionName}-${versionCode}-${flavorName}-${buildType}'
fastMode = false
buildTimeDateFormat = 'yyyyMMdd-HH:mm:ss'
lowMemory = false
}If you already have a base APK, use the rebuildChannel block to generate multiple versions.
Configuration Options:
channelFile: Path to the channel file.baseApk: Path to the existing base APK (Required). The filename 'base' in the path will be replaced by the channel name.outputDir: Output directory (default: project.buildDir/rebuildChannel).fastMode: If true, skips verification (default false).lowMemory: If true, uses low-memory mode for V2 signatures (default false).Commands:
gradle rebuildChannel: Generates the multi-channel APKs.Temporary Testing:
gradle rebuildChannel -Pchannels=channel1,channel2
rebuildChannel {
channelFile = file("/Users/leon/Downloads/testReChannel.txt")
baseApk = new File(project.rootDir, "/baseApk/app_base.apk")
outputDir = new File(project.buildDir, "rebuildChannel")
fastMode = false
lowMemory = false
}The VasDolly command-line tool is provided as VasDolly.jar. It requires Java 8 or higher. You can view all available commands by running the help command.
java -jar VasDolly.jar helpTo use VasDolly for multi-channel packaging, follow these three steps:
build.gradle:dependencies {
classpath 'com.android.tools.build:gradle:7.0.3'
classpath 'com.tencent.vasdolly:plugin:3.0.6'
}build.gradle:apply plugin: 'com.tencent.vasdolly'build.gradle to enable reading channel information at runtime:dependencies {
api 'com.tencent.vasdolly:helper:3.0.6'
}dependencies {
classpath 'com.android.tools.build:gradle:7.0.3'
classpath 'com.tencent.vasdolly:plugin:3.0.6'
}
// In app build.gradle
apply plugin: 'com.tencent.vasdolly'
dependencies {
api 'com.tencent.vasdolly:helper:3.0.6'
}To use the low-level ChannelReader and IdValueReader APIs for fine-grained channel information retrieval, add the following dependency to your build.gradle file:
dependencies {
compile 'com.tencent.vasdolly:reader:3.0.4'
}You can configure channel lists using two methods. The final list is the sum of both.
gradle.properties: Specify a filename (must be in the root directory, one channel per line).channel_file=channel.txt
channelFile property within the channel or rebuildChannel blocks.channel {
channelFile = file("/path/to/testChannel.txt")
}
rebuildChannel {
channelFile = file("/path/to/testReChannel.txt")
}IdValueReader class provides interfaces for reading all or specific custom ID-Value pairs based on the V2 signature.ChannelWriter class provides interfaces for adding or removing channel information in an APK. It supports both V1 and V2 signatures. Use this class when you need to programmatically inject or strip channel metadata from your application packages.ChannelReader class provides interfaces for reading channel information based on V1 and V2 signatures. It also includes methods to check whether the package contains V1 or V2 signatures.