美團Android自動化之旅—生成渠道包

NO IMAGE

概述

每當發新版本時,美團團購Android客戶端會被分發到各個應用市場,比如豌豆莢360手機助手等。為了統計這些市場的效果(活躍數,下單數等),需要有一種方法來唯一標識它們。

團購客戶端目前通過渠道號(channel)來區分不同的市場,程式碼中使用Config.channel變數記錄該渠道號。比如,豌豆莢市場中美團應用的渠道號是wandoujia,360手機助手中美團應用的渠道號為qihu360。客戶端訪問API時會在請求引數中帶上渠道號,以便後臺接下來計算不同渠道的效果。

每次發版時,市場部會提供一個渠道列表,Android RD會根據這些渠道相應地生成等量的渠道包。隨著渠道越來越多(截止本文寫作時已有900多個渠道),客戶端打渠道包的方式也一直在演進,本文接下來就詳細介紹美團應用的打包之旅。

Maven

Maven是一個軟體專案管理和自動構建工具,配合使用android-maven-plugin外掛,以及maven-resources-plugin外掛可以很方便的生成渠道包,下面簡要介紹下打包過程,更多Maven以及外掛的使用方法請參考相關文件。

首先,在AndroidManifest.xml<application>節點中新增如下<meta-data>元素,用來定義渠道的來源:

<!-- 使用Maven打包時會用具體的渠道號替換掉${channel} -->
<meta-data
android:name="channel"
android:value="${channel}" />

定義好渠道來源後,接下來就可以在程式啟動時讀取渠道號了:

private String getChannel(Context context) {
try {
PackageManager pm = context.getPackageManager();
ApplicationInfo appInfo = pm.getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
return appInfo.metaData.getString("channel");
} catch (PackageManager.NameNotFoundException ignored) {
}
return "";
}

要替換AndroidManifest.xml檔案定義的渠道號,還需要在pom.xml檔案中配置Resources外掛:

<resources>           
<resource>
<directory>${project.basedir}</directory>
<filtering>true</filtering>
<targetPath>${project.build.directory}/filtered-manifest</targetPath>
<includes>
<include>AndroidManifest.xml</include>
</includes>
</resource>
</resources>

準備工作已經完成,現在需要的就是實際的渠道號了。下面的指令碼會遍歷渠道列表,逐個替換並打包:

#!/bin/bash
package(){
while read line
do
mvn clean
mvn  -Dchannel=$line package
done < $1
}
package $1

在前期渠道很少時這種方法還可以接受,但只要渠道稍微增多該方法就不再適用了,原因是每打一個包都要執行一遍構建過程,效率太低。

apktool

apktool是一個逆向工程工具,可以用它解碼(decode)並修改apk中的資源。接下來詳細介紹如何使用apktool生成渠道包。

前期工作和用Maven打包一樣,也需要在AndroidManifest.xml檔案中定義<meta-data>元素,並在應用啟動的時候讀取清單檔案中的渠道號。具體請參考上面的程式碼。

和Maven不一樣的是,每次打包時不再需要重新構建專案。打包時,只需生成一個apk,然後在該apk的基礎上生成其他渠道包即可。

首先,使用apktool decode應用程式,在終端中輸入如下命令:

apktool d your_original_apk build

上面的命令會在build目錄中decode應用檔案,decode完成後的目錄如下:

接下來,替換AndroidManifest.xml檔案中定義的渠道號,下面是一段python指令碼:

import re
def replace_channel(channel, manifest):
pattern = r'(<meta-data\s android:name="channel"\s android:value=")(\S )("\s />)'
replacement = r"\g<1>{channel}\g<3>".format(channel=channel)
return re.sub(pattern, replacement, manifest)

然後,使用apktool構建未簽名的apk:

apktool b build your_unsigned_apk

最後,使用jarsigner重新簽名apk:

jarsigner -sigalg MD5withRSA -digestalg SHA1 -keystore your_keystore_path -storepass your_storepass -signedjar your_signed_apk, your_unsigned_apk, your_alias

上面就是使用apktool打包的方法,通過使用指令碼可以批量地生成渠道包。不像Maven,每打一個包都需要執行一次構建過程,該方法只需構建一次,大大節省了時間。

但是好景不長,我們的渠道包越來越多,目前已有近900個渠道,打完所有的渠道包需要近3個小時。有沒有更快的打包方式呢?且看下節。

META-INF

如果能直接修改apk的渠道號,而不需要再重新簽名能節省不少打包的時間。幸運的是我們找到了這種方法。直接解壓apk,解壓後的根目錄會有一個META-INF目錄,如下圖所示:

如果在META-INF目錄內新增空檔案,可以不用重新簽名應用。因此,通過為不同渠道的應用新增不同的空檔案,可以唯一標識一個渠道。

下面的python程式碼用來給apk新增空的渠道檔案,渠道名的字首為mtchannel_

import zipfile
zipped = zipfile.ZipFile(your_apk, 'a', zipfile.ZIP_DEFLATED) 
empty_channel_file = "META-INF/mtchannel_{channel}".format(channel=your_channel)
zipped.write(your_empty_file, empty_channel_file)

新增完空渠道檔案後的目錄,META-INFO目錄多了一個名為mtchannel_meituan的空檔案:

接下來就可以在Java程式碼中讀取空渠道檔名了:

public static String getChannel(Context context) {
ApplicationInfo appinfo = context.getApplicationInfo();
String sourceDir = appinfo.sourceDir;
String ret = "";
ZipFile zipfile = null;
try {
zipfile = new ZipFile(sourceDir);
Enumeration<?> entries = zipfile.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = ((ZipEntry) entries.nextElement());
String entryName = entry.getName();
if (entryName.startsWith("mtchannel")) {
ret = entryName;
break;
}
}
} catch (IOException e) {
e.printStackTrace();
} finally {
if (zipfile != null) {
try {
zipfile.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
String[] split = ret.split("_");
if (split != null && split.length >= 2) {
return ret.substring(split[0].length()   1);
} else {
return "";
}
}

這樣,每打一個渠道包只需複製一個apk,在META-INF中新增一個使用渠道號命名的空檔案即可。這種打包方式速度非常快,900多個渠道不到一分鐘就能打完。

總結

上面總共介紹了三種打渠道包的方式。目前,Android團隊打包基本使用第三種方式,完成了打包的自動化,解放了工程師的生產力,善哉善哉。

打包的問題解決了,但有時候還需要為不同的渠道定製不同的APK。下一講會介紹Android構建利器Gradle,以及如何使用Gradle定製渠道包,敬請期待。

From: http://tech.meituan.com/mt-apk-packaging.html

另外可參考:

Android Studio系列教程六–Gradle多渠道打包: http://stormzhang.com/devtools/2015/01/15/android-studio-tutorial6/

靈活強大的構建系統Gradle: http://tech.meituan.com/gradle-practice.html