【轉】Android Overlay機制

Android Overlay機制

GrayMonkey

0.5 2017.10.23 11:03* 字數 2134 閱讀 5810評論 0喜歡 11

前言

Android Overlay是一種資源替換機制，它能在不重新打包apk的情況下，實現資源文件的替換（res目錄非assert目錄），Overlay又分爲靜態Overlay(Static Resource Overlay)與運行時Overlay(Runtime Resource Overlay)。

源碼編譯流程簡介

Overlay的定製需要在源碼編譯環境中完成，所以先簡單介紹Android的源碼編譯流程。
首先下載系統源碼，配置好編譯環境，然後進入源碼根目錄，在Linux shell終端中執行以下步驟即可。

圖1-android源碼目錄結構

按照google給出的編譯步驟如下：

1. source build/envsetup.sh
   該步驟主要是將Shell腳本envsetup.sh中定義的一些函數命令加載到環境變量中，方便直接使用，source命令可替換成“.”命令。腳本文件的開頭說明如下：

圖2-envsetup.sh

1. lunch
   該步驟主要是選擇平臺編譯選項，該命令會羅列出所有平臺編譯選項，如下圖，輸入相應數字即可

圖3-來自“手動編譯源碼”一文

 

參考圖1中lunch命令說明，“build_varaint”可分爲以下幾類：

build_varaint	Description
eng	工程機，具備root權限以及一些debug工具
user	用戶機，可正式銷售給用戶，無root權限、debug權限
userdebug	在user的基礎上開放root、debug權限

1. make
   執行編譯，make命令會調用根目錄下的Makefile文件，Makefile又包含 build/core/main.mk，main.mk又會包含build目錄下其他的makefile文件來完成編譯並打包得到系統鏡像文件。
   在這個編譯過程會將packages/apps目錄下的源碼項目通過AAPT打包成APK，存放至system/app或者system/priv-app目錄下，最後連同其他資源打包得到系統鏡像，當然也可以將APK直接打包到系統鏡像。

靜態Overlay

靜態Overlay，簡稱爲SRO，發生在編譯時，需要在Android系統源碼環境中進行配置。

配置步驟

官方源碼示例Demo如下：
1.修改產品（backup應用）的mk文件，添加如下代碼
示例文件路徑：
android-6.0.0_r1\device\sample\products\backup_overlay.mk

圖4-官方示例

PRODUCT_PACKAGE_OVERLAYS := device/sample/overlays/backup

其中，AndroidProducts.mk定義了哪些APP會被編譯打包，其他mk文件則是對應APP的配置文件。
一般廠商都會有一些個性化定製的產品，會參照device目錄結構創建一個vendor目錄，所以有的產品的overlay需要在這個vendor目錄中進行修改。

2.在overlays目錄下添加對應產品的overlay項目，overlay項目實際上就是源項目剔除代碼和替換資源後的項目，注意包名路徑需要與源項目保持一致。

原理

實際上，SRO的實現很簡單，只是在通過AAPT打包成APK時，通過-S命令多增加了一個資源目錄(overlay目錄)而已，我們平時打包APK只是通過AAPT -S指定了一個資源目錄，而Overlay又額外增加了一個資源目錄而已。
AAPT -S命令可以指定多個資源目錄，overlay的資源將替換原res中的重名文件。

圖5-SRO

可見SRO在編譯成APK時已經完成。

運行時Overlay

運行時Overlay，簡稱RRO，顧名思義，該機制的資源替換髮生在運行時。

與SRO的區別

1. RRO能直接定製替換第三方APK的資源，而不需要其源碼。SRO如上節所述，則需要對應APK的源碼才能完成，一般而言，第三方是不會提供項目源碼的。

2. RRO的編譯結果會得到一個xxx_overlay.apk,加上原項目的apk，總共會有2個apk，而SRO最終只會得到一個已經完成資源替換的apk。得到的overlay.apk可以視爲一個正常的apk，因爲它能被安裝，含有自己的AndroidManifest.xml文件，當然正常下，overlay.apk是不含有執行代碼的。

3. RRO不能替換AndroidManifest.xml文件及reference resource 類型的文件，如layout、anim、xml目錄中的xml文件。雖然RRO具有自己的AndroidManifest.xml文件，但它卻不能替換源項目中的AndroidManifest.xml文件。關於layout目錄中的xml文件，SRO是可以替換的。

       //以下幾種，就屬於reference resource
        Resources resources = getResources();
        XmlResourceParser  parser0 = resources.getXml(R.xml.test);
        XmlResourceParser  parser1 = resources.getLayout(R.layout.activity_main);
        XmlResourceParser  parser2 = resources.getAnimation(R.anim.test);

配置步驟

下面以創建Launcher3的RRO爲例進行說明

1. 創建一個新項目，包名命名爲com.android.launcher3.overlay,事實上包名可以隨意命名，這樣命名可讀性高，一看包名就知道是哪個項目的overlay。

2. 編輯overlay項目的AndroidManifest.xml文件,文件內容如下：

<manifest xmlns:android="http://schemas.android.com/apk/res/android" 
    package="com.android.launcher3.overlay"> 
    <overlay android:targetPackage="com.android.launcher3"  android:priority="1"/> 
</manifest>

其中，
android:targetPackage：需要overlay的項目的包名
android:priority：設置overlay.apk的優先級，值越大，優先級越高，用於存在多個overlay.apk情況下的判斷。

1. 替換相應的res資源

2. 編寫mk文件，編譯、打包、簽名，並將生成的overlay.apk輸出到/vendor/overlay目錄下，其中籤名需要與源項目簽名一致，否則不會生效。
   注意:
   把app放到vendor/overlay下面以後，還要activate，默認是disable的
   activate有兩種方式:
   一種是overlay的app的清單文件中，overlay標籤寫 isStatic="true"
   一種是加系統屬性ro.boot.vendor.overlay.theme=overlay的app的包名，分號分割

PS:沒有源碼環境，或者不懂mk文件，可以通過root手機，直接將我們生成的overlay.apk直接push到/vendor/overlay目錄下，來測試RRO機制。
部分廠商可能更改了路徑，可通過adb shell pm path xxxx.overlay 查找到路徑，前提是手機中已經安裝了某個overlay的apk。

資源ID

我們知道資源文件在打包之後，會在R.java文件中生成一個對應的int類型資源id，這個id遵循以下的規則：
0xppttiiii
其中，
pp：01表示是系統資源，7f表示是應用資源
tt：用於表示資源類型，如string、array、圖片資源等
iiii：用於表示相同類型的不同資源

原理

以我們常見的圖片資源訪問爲例，當我們在應用層調用getDrawable方法的時候，會調用系統的getResource方法，該方法會根據資源id及設備配置信息（語言、像素密度等）來查找並返回合適的圖片資源。此處，我們只關注根據id來選擇資源。

如果id表明是系統資源，那麼就會去framework-res.apk中查找並返回資源，一般位於/system/framework目錄下，可root手機查看；如果是應用資源則在overlay和app中查找並返回。

圖6-RRO流程

單個overlay包

當對應項目只有一個overlay包時，那麼查找資源時，會先從overlay.apk中進行查找，查找成功直接返回，反之則從app中查找。

多個overlay包

當對應項目具有多個overlay包時，會按照overlay包的優先級從高到底依次進行查找，如果overlay包都查找失敗，纔會到app中進行查找。
以訪問R.drawable.ic_01爲例，會先從overlay1包先查找，因爲其優先級最高，查找到則直接返回。
如果訪問R.drawable.ic_02，先從overlay1查找，查找失敗，接着從overlay2中查找，查找到直接返回。
如果訪問R.drawable.ic_03，依次從overlay1，overlay2中查找，查找失敗，最後會從app中查找到，並返回。

總結

SRO實際上只是利用AAPT重新打包，發生在編譯時；RRO，纔是overlay機制的關鍵，其本質是Android系統的動態資源查找機制。
實際運用當中，Overlay機制一般用於手機廠商爲不同運營商做客製化定製，或者做主題換膚；一般，第三方應用是無法享受該機制的，除非與手機廠商合作，不過應用層現在也有了換膚框架Android-Skin-Loader，其本質也是利用Android的資源查找機制。