Android Overlay機(jī)制

前言

Android Overlay是一種資源替換機(jī)制,它能在不重新打包apk的情況下,實(shí)現(xiàn)資源文件的替換(res目錄非assert目錄),Overlay又分為靜態(tài)Overlay(Static Resource Overlay)與運(yùn)行時(shí)Overlay(Runtime Resource Overlay)。

源碼編譯流程簡(jiǎn)介

Overlay的定制需要在源碼編譯環(huán)境中完成,所以先簡(jiǎn)單介紹Android的源碼編譯流程。
首先下載系統(tǒng)源碼,配置好編譯環(huán)境,然后進(jìn)入源碼根目錄,在Linux shell終端中執(zhí)行以下步驟即可。

圖1-android源碼目錄結(jié)構(gòu)

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

  1. source build/envsetup.sh
    該步驟主要是將Shell腳本envsetup.sh中定義的一些函數(shù)命令加載到環(huán)境變量中,方便直接使用,source命令可替換成“.”命令。腳本文件的開(kāi)頭說(shuō)明如下:
圖2-envsetup.sh
  1. lunch
    該步驟主要是選擇平臺(tái)編譯選項(xiàng),該命令會(huì)羅列出所有平臺(tái)編譯選項(xiàng),如下圖,輸入相應(yīng)數(shù)字即可
圖3-來(lái)自“手動(dòng)編譯源碼”一文

參考圖1中l(wèi)unch命令說(shuō)明,“build_varaint”可分為以下幾類(lèi):

build_varaint Description
eng 工程機(jī),具備root權(quán)限以及一些debug工具
user 用戶(hù)機(jī),可正式銷(xiāo)售給用戶(hù),無(wú)root權(quán)限、debug權(quán)限
userdebug 在user的基礎(chǔ)上開(kāi)放root、debug權(quán)限
  1. make
    執(zhí)行編譯,make命令會(huì)調(diào)用根目錄下的Makefile文件,Makefile又包含 build/core/main.mk,main.mk又會(huì)包含build目錄下其他的makefile文件來(lái)完成編譯并打包得到系統(tǒng)鏡像文件。
    在這個(gè)編譯過(guò)程會(huì)將packages/apps目錄下的源碼項(xiàng)目通過(guò)AAPT打包成APK,存放至system/app或者system/priv-app目錄下,最后連同其他資源打包得到系統(tǒng)鏡像,當(dāng)然也可以將APK直接打包到系統(tǒng)鏡像。

靜態(tài)Overlay

靜態(tài)Overlay,簡(jiǎn)稱(chēng)為SRO,發(fā)生在編譯時(shí),需要在Android系統(tǒng)源碼環(huán)境中進(jìn)行配置。

配置步驟

官方源碼示例Demo如下:
1.修改產(chǎn)品(backup應(yīng)用)的mk文件,添加如下代碼
示例文件路徑:
android-6.0.0_r1\device\sample\products\backup_overlay.mk

圖4-官方示例
PRODUCT_PACKAGE_OVERLAYS := device/sample/overlays/backup

其中,AndroidProducts.mk定義了哪些APP會(huì)被編譯打包,其他mk文件則是對(duì)應(yīng)APP的配置文件。
一般廠商都會(huì)有一些個(gè)性化定制的產(chǎn)品,會(huì)參照device目錄結(jié)構(gòu)創(chuàng)建一個(gè)vendor目錄,所以有的產(chǎn)品的overlay需要在這個(gè)vendor目錄中進(jìn)行修改。

2.在overlays目錄下添加對(duì)應(yīng)產(chǎn)品的overlay項(xiàng)目,overlay項(xiàng)目實(shí)際上就是源項(xiàng)目剔除代碼和替換資源后的項(xiàng)目,注意包名路徑需要與源項(xiàng)目保持一致。

原理

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

圖5-SRO

可見(jiàn)SRO在編譯成APK時(shí)已經(jīng)完成。

運(yùn)行時(shí)Overlay

運(yùn)行時(shí)Overlay,簡(jiǎn)稱(chēng)RRO,顧名思義,該機(jī)制的資源替換發(fā)生在運(yùn)行時(shí)。

與SRO的區(qū)別
  1. RRO能直接定制替換第三方APK的資源,而不需要其源碼。SRO如上節(jié)所述,則需要對(duì)應(yīng)APK的源碼才能完成,一般而言,第三方是不會(huì)提供項(xiàng)目源碼的。

  2. RRO的編譯結(jié)果會(huì)得到一個(gè)xxx_overlay.apk,加上原項(xiàng)目的apk,總共會(huì)有2個(gè)apk,而SRO最終只會(huì)得到一個(gè)已經(jīng)完成資源替換的apk。得到的overlay.apk可以視為一個(gè)正常的apk,因?yàn)樗鼙话惭b,含有自己的AndroidManifest.xml文件,當(dāng)然正常下,overlay.apk是不含有執(zhí)行代碼的。

  3. RRO不能替換AndroidManifest.xml文件及reference resource 類(lèi)型的文件,如layout、anim、xml目錄中的xml文件。雖然RRO具有自己的AndroidManifest.xml文件,但它卻不能替換源項(xiàng)目中的AndroidManifest.xml文件。關(guān)于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);
配置步驟

下面以創(chuàng)建Launcher3的RRO為例進(jìn)行說(shuō)明

  1. 創(chuàng)建一個(gè)新項(xiàng)目,包名命名為com.android.launcher3.overlay,事實(shí)上包名可以隨意命名,這樣命名可讀性高,一看包名就知道是哪個(gè)項(xiàng)目的overlay。

  2. 編輯overlay項(xiàng)目的AndroidManifest.xml文件,文件內(nèi)容如下:

<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的項(xiàng)目的包名
android:priority:設(shè)置overlay.apk的優(yōu)先級(jí),值越大,優(yōu)先級(jí)越高,用于存在多個(gè)overlay.apk情況下的判斷。

  1. 替換相應(yīng)的res資源

  2. 編寫(xiě)mk文件,編譯、打包、簽名,并將生成的overlay.apk輸出到/vendor/overlay目錄下,其中簽名需要與源項(xiàng)目簽名一致,否則不會(huì)生效。
    注意:
    把a(bǔ)pp放到vendor/overlay下面以后,還要activate,默認(rèn)是disable的
    activate有兩種方式:
    一種是overlay的app的清單文件中,overlay標(biāo)簽寫(xiě) isStatic="true"
    一種是加系統(tǒng)屬性ro.boot.vendor.overlay.theme=overlay的app的包名,分號(hào)分割

PS:沒(méi)有源碼環(huán)境,或者不懂mk文件,可以通過(guò)root手機(jī),直接將我們生成的overlay.apk直接push到/vendor/overlay目錄下,來(lái)測(cè)試RRO機(jī)制。
部分廠商可能更改了路徑,可通過(guò)adb shell pm path xxxx.overlay 查找到路徑,前提是手機(jī)中已經(jīng)安裝了某個(gè)overlay的apk。

資源ID

我們知道資源文件在打包之后,會(huì)在R.java文件中生成一個(gè)對(duì)應(yīng)的int類(lèi)型資源id,這個(gè)id遵循以下的規(guī)則:
0xppttiiii
其中,
pp:01表示是系統(tǒng)資源,7f表示是應(yīng)用資源
tt:用于表示資源類(lèi)型,如string、array、圖片資源等
iiii:用于表示相同類(lèi)型的不同資源

原理

以我們常見(jiàn)的圖片資源訪問(wèn)為例,當(dāng)我們?cè)趹?yīng)用層調(diào)用getDrawable方法的時(shí)候,會(huì)調(diào)用系統(tǒng)的getResource方法,該方法會(huì)根據(jù)資源id及設(shè)備配置信息(語(yǔ)言、像素密度等)來(lái)查找并返回合適的圖片資源。此處,我們只關(guān)注根據(jù)id來(lái)選擇資源。

如果id表明是系統(tǒng)資源,那么就會(huì)去framework-res.apk中查找并返回資源,一般位于/system/framework目錄下,可root手機(jī)查看;如果是應(yīng)用資源則在overlay和app中查找并返回。

圖6-RRO流程
單個(gè)overlay包

當(dāng)對(duì)應(yīng)項(xiàng)目只有一個(gè)overlay包時(shí),那么查找資源時(shí),會(huì)先從overlay.apk中進(jìn)行查找,查找成功直接返回,反之則從app中查找。

多個(gè)overlay包

當(dāng)對(duì)應(yīng)項(xiàng)目具有多個(gè)overlay包時(shí),會(huì)按照overlay包的優(yōu)先級(jí)從高到底依次進(jìn)行查找,如果overlay包都查找失敗,才會(huì)到app中進(jìn)行查找。
以訪問(wèn)R.drawable.ic_01為例,會(huì)先從overlay1包先查找,因?yàn)槠鋬?yōu)先級(jí)最高,查找到則直接返回。
如果訪問(wèn)R.drawable.ic_02,先從overlay1查找,查找失敗,接著從overlay2中查找,查找到直接返回。
如果訪問(wèn)R.drawable.ic_03,依次從overlay1,overlay2中查找,查找失敗,最后會(huì)從app中查找到,并返回。

總結(jié)

SRO實(shí)際上只是利用AAPT重新打包,發(fā)生在編譯時(shí);RRO,才是overlay機(jī)制的關(guān)鍵,其本質(zhì)是Android系統(tǒng)的動(dòng)態(tài)資源查找機(jī)制。
實(shí)際運(yùn)用當(dāng)中,Overlay機(jī)制一般用于手機(jī)廠商為不同運(yùn)營(yíng)商做客制化定制,或者做主題換膚;一般,第三方應(yīng)用是無(wú)法享受該機(jī)制的,除非與手機(jī)廠商合作,不過(guò)應(yīng)用層現(xiàn)在也有了換膚框架Android-Skin-Loader,其本質(zhì)也是利用Android的資源查找機(jī)制。

【參考文章】
Sony contributes Runtime Resource Overlay framework to Android
make file
Android源碼編譯流程
https://www.ibm.com/developerworks/cn/opensource/os-cn-android-build/index.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容