Walle —— Android多渠道打包神器

图片只为致敬斯坦·李

Walle为了android多渠道打包而生的工具,废话不多说直接上用法

配置build.gradle

在项目的build.gradle文件中添加walle插件依赖

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

然后,在app的build.gradle文件中apply插件,同时添加一个用于读取渠道名的依赖库

apply plugin: 'walle'

dependencies {
    //walle
    implementation 'com.meituan.android.walle:library:1.1.6'
}

按照以上配置,基本上这里就可以使用了,还有一个小问题,build的时候会出现这样的错误

Plugin requires 'APK Signature Scheme v2 Enabled' for release.

这是因为release变体的构建没有开启v2签名的原因,在build.gradle文件的android代码块中添加signingConfigs签名配置信息,然后在buildTypes中对应的变体中配置signingConfig

v1SigningEnabledv2SigningEnabled的代码会注视掉,是因为默认为true
同时signingConfigs还可以配置打包时签名的keystore相关信息

android{
    //...
    signingConfigs {
        debug {
            //...
        }
        release {
            //v1SigningEnabled true
            //v2SigningEnabled true
            keyAlias 'alias名字'
            keyPassword '对应alias密码'
            storeFile file('keystore的文件路径')
            storePassword 'keystore的密码'
        }
    }
    buildTypes {
        debug {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.debug
        }
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
    }
}

配置walle

walle {
    // 指定渠道包的输出路径
    apkOutputFolder = new File("${project.rootDir}/output/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:包含渠道配置信息的文件路径。

其中channelFile文件,每行是一个渠道名,支持使用#注释,具体的格式如下:

360
#百度
baidu
develoer.huawei #华为

获取渠道信息

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

public class ChannelUtil {
    public static String getChannelName(Context context){
        if(context == null){
            return "";
        }
        return WalleChannelReader.getChannel(context,"");
    }
}

如何生成渠道包

生成渠道包的方式是和assemble${variantName}Channels指令结合,渠道包的生成目录默认存放在build/outputs/apk/,也可以通过walle代码块中的apkOutputFolder参数来指定输出目录,在AndroidStudio的终端中执行构建指令即可。具体指令:

  • 生成渠道包 gradle clean assembleReleaseChannels
  • 支持 productFlavors gradle clean assemble${variantName}ReleaseChannels

Window环境可能需要使用gradlew才能执行

以上指令都是在walle配置好的基础上进行打包,也可以通过指令临时生成某个或某个渠道文件对应的渠道包

//单个渠道
gradle clean assembleReleaseChannels -PchannelList=baidu
//多个渠道
gradle clean assembleReleaseChannels -PchannelList=baidu,360
gradle clean assembleReleaseChannels -PchannelFile=/user/mrtrying/AS_WorkSpace/ReleaseExample/channel

更多使用方式

官方文档还提到configFile的使用,configFile是包含渠道信息和额外信息的配置文件路径。配置文件采用json格式,支持为每个channel单独配置额外的写入信息。具体内容格式详见:渠道&额外信息配置文件示例

walle {
    // 渠道&额外信息配置文件,与channelFile互斥
    configFile = new File("${project.getProjectDir()}/config.json")
}
  • 此配置项与channelFile功能互斥,开发者在使用时选择其一即可,两者都存在时configFile优先执行。
  • extraInfo不要出现以channel为key的情况

可以通过如下方法获取对应key的信息:

public static String getExtraInfo(Context context,String key){
    if(context == null){
        return "";
    }
    ChannelInfo channelInfo= WalleChannelReader.getChannelInfo(context.getApplicationContext());
    if (channelInfo != null) {
        //如果要获取渠道
        //String channel = channelInfo.getChannel();
        Map<String, String> extraInfo = channelInfo.getExtraInfo();
        return extraInfo.get(key);
    }else {
        return "";
    }
    // 或者也可以直接根据key获取
    //return WalleChannelReader.get(context, key);
}

指令也还有其他的用法:

  • 生成渠道包&写入额外信息:gradle clean assembleReleaseChannels -PchannelList=baidu -PextraInfo=buildtime:20161212,hash:xxxxxxx

  • 使用临时configFile生成渠道包:gradlew clean assembleReleaseChannels -PconfigFile=/user/mrtrying/AS_WorkSpace/ReleaseExample/config.json

  • 使用上述-P参数后,本次打包channelFile/configFile配置将会失效,其他配置仍然有效。-PchannelList,-PchannelFile,-PconfigFile三者不可同时使用。

注意: 上述的extraInfo以key:value形式提供,多个以,分隔。

命令行工具使用方式

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

其他使用方式

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

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

关于360加固失效问题

参考文章

Walle-美团点评技术团队出品

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,158评论 4 370
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,600评论 1 307
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 111,785评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,655评论 0 220
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,075评论 3 295
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,002评论 1 225
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,146评论 2 318
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,918评论 0 211
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,671评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,838评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,318评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,636评论 3 263
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,343评论 3 244
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,187评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,982评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,126评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,934评论 2 279

推荐阅读更多精彩内容