Gradle 實現 Android 多渠道定製化打包

踏歌行發表於2016-09-19

最近在專案中遇到需要實現 Apk 多渠道、定製化打包, 查詢了一些資料,成功實現了上述功能,在此記錄以備不時之需,溫故而知新,可以為師矣~

需求可以總結如下:
多渠道打包

如何實現多個 Apk 安裝在同一裝置

在之前的印象中,同一個應用在同一裝置上只能安裝一個,除非手動修改 AndroidManifest.xml 檔案中的包名( package ),但這麼做的後果就是新的應用真的是新的應用,舊版應用再也收不到更新。而現在你通過 Gradle,你可以輕鬆構建多個不同版本的應用,並且在同一裝置上安裝使用。

這裡要用到 productFlavors ,productFlavors 可以用來自定義應用構建版本,我們可以用其 applicationId 屬性來實現多個 Apk 安裝在同一裝置上。

build.gradle 中部分配置程式碼如下:

MainActivity.java:

在 Android Studio 中執行如下命令:

打包完成後,將 Apk 安裝到模擬器(adb install name.apk),執行,log 如下:

flavors_default:

flavors_dev:

flavors_release:

從這裡可以看出,不同 flavor 的 package name 被 applicationId 替換掉了,而且同一個模擬器上可以同時安裝以上三個應用。

下面我們再看看 AndroidManifest.xml 中發生了什麼變化。這裡需要用到 aapt 來檢視 AndroidManifest.xml 的資訊:

關於 aapt 使用的更多用法,可以閱讀這篇博文:使用 aapt 檢視 apk 的各種資訊

下面是 flavors_dev 版本的資訊,可以看出 Java 原始檔的包名並沒有發生改變,而 package 屬性的值被替換為 applicationId了。

applicationId 的原理可以理解為在 gradle 打包的時,動態合併屬性,將 package 替換為 applicationId 指定的值,但並不會替換 Java 檔案的包名,包括生成的 R 檔案(可以去對應 module 下的 build/generated 目錄下檢視對應 flavor 的 R 檔案)。

Android 官方文件原文如下:

Therefore, we have decoupled the two usages of package name:

The final package that is used in your built .apk’s manifest, and is the package your app is known as on your device and in the Google Play store, is the “application id”.

The package that is used in your source code to refer to your R class, and to resolve any relative activity/service registrations, continues to be called the “package”.

補充ApplicationId versus PackageName

替換 AndroidManifest.xml 中的屬性

這裡可以參考友盟統計 SDK 中使用的方案。該方案通過在 AndroidManifest.xml 檔案中 application 標籤下指定 <mate-data>  設定佔位符來實現動態替換屬性值。

佔位符形如${name},在最終執行 AndroidManifest.xml 檔案合併的時候,佔位符會被 build.gradle 中對應值取代。 build.gradle 的配置需要用到上節講到的 productFlavors 的 manifestPlaceholders 屬性, manifestPlaceholders 屬性直譯過來就是清單檔案佔位符

下面是 build.gradle 的節選程式碼:

如果你要替換多個屬性,則只需要將 manifestPlaceholders 的寫法如下:

補充:關於 AndroidManifest 檔案合併規則可以檢視 官方文件

替換資原始檔

多渠道打包的時候可能會碰到這種情況:每個應用市場的啟動頁圖示、應用名稱可能會有點小出入,更有甚者,連佈局都不一樣。這時候我們該怎麼辦呢?

有一種解決辦法就是:在程式碼裡進行判斷,根據渠道的不一樣,載入不同的圖片和佈局,這是一種解決辦法。但是當渠道有很多時,程式碼就會變得很難維護,而且指定渠道用到的資原始檔都會被打入所有 Apk 中。所以這個方法並不值得推薦。那麼,有什麼好的解決辦法呢?

辦法 Google 早就給我們想好了,而且相當簡單,那就是:在 main 的同級目錄下建立以渠道名命名的資料夾,然後建立資原始檔(路徑要與 main 中的一致),然後打包的時候 gradle 就會自己替換或者合併資源。

例如, App 的預設 icon 路徑為 main\res\mipmap-hdpi\ic_launcher.png ,那麼 flavors_dev的路徑就為 flavors_dev\res\mipmap-hdpi\ic_launcher.png ,打包 flavors_dev 渠道的時候會自動替換圖片。

對於資源合併,如果在 main 下的 strings.xml 內容為:

在 flavors_dev 下的 strings.xml 內容為:

當打 flavors_dev 渠道包時,最終 strings.xml 會變成:

以上特性可以用來替換 Apk 的應用名稱和應用圖示,這比使用前面講到的佔位符方便很多。同理,替換圖片和合並顏色的原理也相似。

多渠道使用獨立簽名

多渠道打包的時候,可能每個渠道包的簽名都必須不一樣,真正做到定製化,那麼,怎麼實現每個渠道包使用指定的簽名呢?

平時我們打包的時候是這樣的:

而給每個渠道包指定簽名其實也差不多。

Google 官方原話:

This enables either having all release packages share the same SigningConfig, by setting android.buildTypes.release.signingConfig, or have each release package use their own SigningConfig by setting each android.productFlavors.*.signingConfig objects separately.

大意就是,在 buildType 下指定簽名的具體屬性,形如 android.productFlavors.*.signingConfig signingConfigs.* ,前一個 * 指代在 productFlavors 中定義的 flavor ,後一個 * 指代在 signingConfigs 定義的屬性。值得注意的是,signingConfigs 必須定義在 buildType 之前。

以下是 build.gradle 的配置節選:

下面我們來驗證下生成的包的簽名是否正確,檢視簽名我們會用到如下兩個命令:

更多 keytool 命令使用可以檢視 官方文件

首先,我們來看下 littlejie.jks 的資訊:

解壓 multichannel-flavors_default-release.apk ,檢視 CERT.RSA 資訊

可以發現兩者的 SHA1 值是相等的。

同理,可以檢視 littlejie_dev.jks 和 multichannel-flavors_dev-release.apk 的簽名資訊

但是這裡有個問題,就是這種給某個 flavor 指定簽名的方法對 debug 無效,有興趣的同學可以看上述註釋掉的 debug 簽名部分配置。簡單來說,debug 簽名只能指定一個或者使用預設的 debug 簽名。

若哪位大神有解決方案,歡迎指出~

這裡再做幾點補充:

  1. 多渠道使用獨立簽名,打包時千萬不要使用 Android Studio 中 Build 選單下的 Generate Signed APK,因為當你使用這個打包的時候, Android Studio 會讓你指定使用的簽名檔案, so 你就等著哭吧~樓主因為這個折騰了半天。解決方法就是使用 gradle tasks。傳送門:Android Gradle Build Tasks
  2. 鑑於第一點中的傳送門需要FQ,所以在這裡簡單介紹一下 Android Gradle Build Tasks 的使用。
  • 打全部包: gradle assemble
  • 打全部 Debug 包: gradle assembleDebug ,可以簡寫為 gradle aD ,前提是沒有相同縮寫的引數
  • 打全部 Release 包: gradle assembleRelease,可以簡寫為 gradle aR
  • 打指定 flavor 包: gradle assemble(flavor)(Debug|Release)
  • 打包完成後安裝(裝置上沒有安裝該 apk ,否則會失敗,而且只能指定 flavor ,不然也會失敗): gradle install(flavor)(Debug|Release)
  • 打包前先 clean 一下(在測試的時候很必要,如果不 clean 的話,可能會導致某些小修改不會及時打入新包): gradle clean assembleDebug

利用 Gradle 修改構建版本號

樓主表示對 Groovy 不是很熟,所以利用 Gradle 自動修改構建版本這個就先留著,我先去研究幾天~

總結

以上就是自己在使用 Gradle 實現 Android 多渠道打包時碰到的問題, Android 官方關於使用 Gradle 的文件已經很詳細了,自己總結的只是一點皮毛,有時間要去自習研讀下。

工作一年多,愣是沒有寫部落格做總結,好多東西都是用過就忘,下次要用再找,沒有成體系的 Android 知識結構,對工資不滿意,可就連想跳槽面試都沒底氣。這次寫這篇部落格畫了思維導圖,自以為邏輯清晰了,可是真正要把這些東西講述清楚,還真是一件麻煩的事~看來,自己還有很長的路要走~

這段時間自己也在思考,是轉行還是去考事業編制,還是繼續做 Android。轉行,除了程式設計自己好像別的什麼也不會,當然自己程式設計也做的不怎麼好。考事業編制,這個可以考慮,畢竟再很多人眼裡這是個旱澇保收的職業。繼續做 Android ,這個也不錯,除了每次都花大把時間用來改 UI,別的都還不錯(吐槽產品)。

話說,有沒有什麼工作,自由、上班時間少、工資高的?當然沒有,至少現階段的自己是接觸不到的,所以,騷年,還是努力吧!多讀書、多看報、多運動,少吃零食多睡覺~

恩,算是對工作一年多的總結也是吐槽~

讀萬卷書,行萬里路~

參考

  1. Gradle Plugin User Guide
  2. Android Plugin DSL Reference
  3. Android Studio Gradle實踐之多渠道自動化打包+版本號管理

打賞支援我寫出更多好文章,謝謝!

打賞作者

打賞支援我寫出更多好文章,謝謝!

任選一種支付方式

Gradle 實現 Android 多渠道定製化打包 Gradle 實現 Android 多渠道定製化打包

相關文章