scheme 应用详情 scheme android

转载

桃太郎 2024-05-24 19:34:36

文章标签 scheme 应用详情 android 渠道配置文件 Android 文章分类 机器学习人工智能

walle

项目地址： Meituan-Dianping/walle

scheme 应用详情 scheme android_android

简介：Android Signature V2 Scheme 签名下的新一代渠道包打包神器

更多：作者提 Bug

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

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

Quick Start

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

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

Gradle 插件使用方式

配置 build.gradle

在位于项目的根目录 build.gradle

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

并在当前 App 的 build.gradle

apply plugin: 'walle'

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

配置插件

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