美团多渠道打包工具walle及结合python实现界面化快速打包

时间：2021-11-11 18:39:43
项目地址
https://github.com/BinZhiLy/-walle-Python-.git

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

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

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

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

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

更多用法

插入额外信息

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三者不可同时使用。

打包过程需要注意的问题

1一定要配置完签名以后才可以集成插件，否则提示没有开启v2签名
2mac生成的签名没有jks格式，生成时受到增加jks名字
3生成渠道配置channel文件，多余的额外参数配置configs
4相比于原来的友盟是在meta-data中通过gradle多渠道编译修改清单文件内容，然后在代码中获取medat值，美团的思路是增加了新的ID-Value值，在代码中动态获取渠道，支持多种字段
5gradle语言
project.getProjectDir 当前app文件夹根目录
project.buildDir app文件夹build文件夹目录
6除了gradle打包工具美团还提供的jar命令行打包工具

命令行工具使用方式

通过java封装的工具打包

walle-cli

walle-cli是walle提供的命令行程序。

即：本目录下的 walle-cli-all.jar （github release中会及时更新，可到release中下载）

使用示例

获取信息

显示当前apk中的渠道和额外信息：

java -jar walle-cli-all.jar show /Users/Meituan/app/build/outputs/apk/app.apk

写入信息

写入渠道

java -jar walle-cli-all.jar put -c meituan /Users/Meituan/Downloads/app.apk

写入额外信息，不提供渠道时不写入渠道

java -jar walle-cli-all.jar put -c meituan -e buildtime=20161212,hash=xxxxxxx /Users/xxx/Downloads/app.apk

指定输出文件，自定义名称。 不指定时默认与原apk包同目录。

java -jar walle-cli-all.jar put -c meituan /Users/Meituan/Downloads/app.apk /Users/xxx/Downloads/app-new-hahha.apk

批量写入

命令行指定渠道列表
java -jar walle-cli-all.jar batch -c meituan,meituan2,meituan3 /Users/walle/app/build/outputs/apk/app.apk
指定渠道配置文件
java -jar walle-cli-all.jar batch -f /Users/Meituan/walle/app/channel  /Users/Meituan/walle/app/build/outputs/apk/app.apk

配置文件示例 支持使用#号添加注释

输出目录可指定，不指定时默认在原apk包同目录下。

指定渠道&额外信息配置文件
java -jar walle-cli-all.jar batch2 -f /Users/Meituan/walle/app/config.json  /Users/Meituan/walle/app/build/outputs/apk/app.apk

配置文件示例

输出目录可指定，不指定时默认在原apk包同目录下。


自己通过python封装的界面打包工具

美团多渠道打包工具walle及结合python实现界面化快速打包

使用方法
前提条件：
 1首先项目需要集成walle库
  implementation 'com.meituan.android.walle:library:1.1.6'
 2配置自己的签名信息，只有签名后才可以使用
 3在全局盒子或者主活动中获取相关渠道信息
 
 private void initView() {
        TextView tv = findViewById(R.id.tv_walle_pk);
        ChannelInfo channelInfo=           WalleChannelReader.getChannelInfo(this.getApplicationContext());
        if (channelInfo != null) {
            //渠道
            String channel = channelInfo.getChannel();
            //渠道额外信息
            Map<String, String> extraInfo = channelInfo.getExtraInfo();
            tv.setText(channel);
        }
    }


Python使用方法
切换到当前目录下，通过python3 start.py  启动程序 ，需要注意walle jar包必须在当前文件夹下
1多渠道打包  
 需要必填渠道文件路径，apk路径，生成路径选填，默认生成在当前文件夹下

2自定义渠道号打包
 需要必填apk路径和渠道名进行单个打包，填写From可以追加渠道名称
 同时填写From 和 To 为数字区间时，打这一个区间的渠道包，比如meituan1 meituan2 metuan3,这种用法要确保填写
 的都是数字，并且from<to才可以使用


项目地址
https://github.com/BinZhiLy/-walle-Python-.git




标签：

相关文章