前言

在 Android逆向分析(2) APK的打包與安裝 一文中對資源編譯過程的介紹中，筆者提到了overlay（重疊包）這個概念，一位每天都被自己帥醒的好友看了那篇東西后，來問我這個重疊包究竟是個什麼東西，筆者想了想，確實這個概念有很多同學們都不甚瞭解，搜尋了一下網上了介紹，也幾乎沒有看到任何對這個的講解，只有 老羅的部落格 提到過

–mOverlay：表示當前正在編譯的資源的重疊包。重疊包是什麼概念呢？假設我們正在編譯的是Package-1，這時候我們可以設定另外一個Package-2，用來告訴aapt，如果Package-2定義有和Package-1一樣的資源，那麼就用定義在Package-2的資源來替換掉定義在Package-1的資源。通過這種Overlay機制，我們就可以對資源進行定製，而又不失一般性。

那我們應該怎麼怎麼去使用重疊包呢？它又能用在什麼地方，帶來什麼便利呢？

aapt overlay

我們看看aapt的命令help裡是怎麼描述的，省略版:

Usage:
 aapt l[ist] [-v] [-a] file.{zip,jar,apk}
   List contents of Zip-compatible archive.

 aapt d[ump] [--values] [--include-meta-data] WHAT file.{apk} [asset [asset ...]]
   ...

 aapt p[ackage] [-d][-f][-m][-u][-v][-x][-z][-M AndroidManifest.xml] \
        ...
        [--utf16] [--auto-add-overlay] \
        ...
        [-S resource-sources [-S resource-sources ...]] \
        [-F apk-file] [-J R-file-dir] \
        ...

   Package the android resources.  It will read assets and resources that are
   supplied with the -M -A -S or raw-files-dir arguments.  The -J -P -F and -R
   options control which files are output.

...

 Modifiers:
   ...
   # 特別說明下，這就是前一篇我們說到的include的base set啦，比如android.jar
   -I  add an existing package to base include set
   ...
   # overlay通過-S指定，可以指定多個目錄，
   -S  directory in which to find resources.  Multiple directories will be scanned
       and the first match found (left to right) will take precedence.
   ...
   # 自動新增overlays包裡的資源
   --auto-add-overlay
       Automatically add resources that are only in overlays.
   ...
 

舉個例子

aapt package \
-M AndroidManifest.xml \
-m -J gen \
-S src/com/example/res \
-S src/com/example/ui/res

假如我們有如上的aapt命令輸入，那麼當 src/com/example/res 與 src/com/example/ui/res 有相同資源的時候，就會使用前者的，這裡對資源替換的粒度是resource而不是檔案，比如兩個資料夾的values/string.xml都有對同一個string id的描述，最後就會使用前者的字串。

然後我們再來看看 --auto-add-overlay 有什麼用，

假如我們在 src/com/example/ui/res 定義了資源string a，但是在 src/com/example/res 卻沒有這個string，那就會報錯，因為基礎包裡是沒有那個資源的，這時候就需要加上 --auto-add-overlay ，於是就會自動把新的資源都新增進去。

overlay大致就是這麼一回事啦。

Gradle實踐

aaptOptions

google的官方文件簡直說了和沒說一樣。還是自己來吧，用AS的模板新建一個Testapp工程，隨便建兩個res資料夾，各放兩個strings.xml，結構為：

├── res
│   ├── drawable
│   ├── layout
│   │   ├── activity_main.xml
│   │   └── content_main.xml
│   ├── menu
│   │   └── menu_main.xml
│   ├── mipmap-xxxhdpi
│   │   └── ic_launcher.png
│   └── values
│       ├── colors.xml
│       ├── dimens.xml
│       ├── strings.xml
│       └── styles.xml
├── res2
│   └── values
│       └── strings.xml
└── res3
    └── values
        └── strings.xml

res2和res3分別定義了一個string hehe ，value分別為 hehe res2 和 hehe res3 。

content_main.xml的TextView使用了 hehe （原來就是那個Hello World）。當然這裡as會報錯，因為res2和res3並沒有標示為資原始檔夾。

在module的build.gradle裡:

android {
  ...
  aaptOptions {
      additionalParameters '-S',
              '/Users/yifan/dev/github/Testapp/app/src/main/res3',
              '-S',
              '/Users/yifan/dev/github/Testapp/app/src/main/res2',
              '--auto-add-overlay'
      noCompress 'foo', 'bar'
      ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:<dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~'
  }
  ...
}

然後我們試圖編譯:

All input files are considered out-of-date for incremental task ':app:processDebugResources'.
Starting process 'command '/Users/yifan/dev/sdk/adt-bundle-mac-sdk/build-tools/23.0.2/aapt''. Working directory: /Users/yifan/dev/github/Testapp/app Command: /Users/yifan/dev/sdk/adt-bundle-mac-sdk/build-tools/23.0.2/aapt package -f --no-crunch -I /Users/yifan/dev/sdk/adt-bundle-mac-sdk/platforms/android-23/android.jar -M /Users/yifan/dev/github/Testapp/app/build/intermediates/manifests/full/debug/AndroidManifest.xml -S /Users/yifan/dev/github/Testapp/app/build/intermediates/res/merged/debug -A /Users/yifan/dev/github/Testapp/app/build/intermediates/assets/debug -m -J /Users/yifan/dev/github/Testapp/app/build/generated/source/r/debug -F /Users/yifan/dev/github/Testapp/app/build/intermediates/res/resources-debug.ap_ --debug-mode --custom-package cn.zhaiyifan.testapp -0 apk -S /Users/yifan/dev/github/Testapp/app/src/main/res2 --output-text-symbols /Users/yifan/dev/github/Testapp/app/build/intermediates/symbols/debug
Successfully started process 'command '/Users/yifan/dev/sdk/adt-bundle-mac-sdk/build-tools/23.0.2/aapt''
/Users/yifan/dev/github/Testapp/app/build/intermediates/res/merged/debug/values-af/values-af.xml:3 : AAPT: Resource at abc_action_bar_home_description appears in overlay but not in the base package; use <add-resource> to add.
...
...各種類似報錯
/usr/local/google/buildbot/src/googleplex-android/mnc-supportlib-release/frameworks/support/v7/appcompat/res/color/switch_thumb_material_light.xml:19 : AAPT: No resource found that matches the given name (at 'color' with value '@color/switch_thumb_normal_material_light').

:app:processDebugResources FAILED
:app:processDebugResources (Thread[main,5,main]) completed. Took 10.493 secs.

看到 <add-resource> 這個，大概知道啥問題了…於是在 additionalParameters 最後又加上了 --auto-add-overlay ，成功編譯執行。

在螢幕中央，顯示了hehe res3，交換-S順序後則變成了hehe res2，符合我們第一節中說到的，選擇首個匹配原則。

不僅是string，anim，layout等等資源都可以使用重疊包來進行動態指定。

資源合併

和aapt的overlay有關，但使用場景略有不同，也介紹一下。

Google在Android Tools Project Site專門為此開了一個頁面： Resource Merging(資源合併) 。

在過去的編譯系統中，資源合併是通過傳給aapt一個作為重疊包的資原始檔夾列表來做的，再加上–auto-add-overlay來確保在重疊包裡的新資源會被自動新增（預設行為只會過載既有資源）。

基礎Gradle的編譯系統的一個目標就是提供更大的靈活性，而另一個經常並問到的功能要求則是能擁有多個資原始檔夾。aapt無法去處理這個，所以新的編譯系統引進了一種新的超越aapt的合併機制，生成一個單獨的，合併的，資原始檔夾並提供給aapt。這個合併機制擁有增量的優點，既因為Gradle的輸入/輸出變更檢測，又因為其實現方式（可以只使用唯一一個變更檔案來做重新merge）。

合併的資源來自3種來源：

1. 主資源，和main sourceSet相關聯，大多位於src/main/res
2. Variant重疊包，來自Build Type和Flavor(s).
3. Library專案依賴，通過它們的aar bundle提供資源。

優先順序

優先順序為：BuildType -> Flavor -> main -> Dependencies.

這意味著如果一個資源同時在Build Type和main存在，會使用Build Type裡的。

需要注意的是合併的scope，同樣（型別，名字）的資源但標示符不同的，是分開處理的。

即如果src/main/res有:

• res/layout/foo.xml
• res/layout-land/foo.xml 
  而src/debug/res有：
• res/layout/foo.xml

則合併後的資原始檔夾會包含預設的來自src/debug/res的foo.xml，但橫屏版本則會選擇src/main/res下的。

PS: android的資源有19個維度，見 Grouping Resource Types 的Table 2，這19個維度會唯一指定1個資源（qualifier標示符）。在老羅的資源介紹部落格中曾經提到過18個維度，現在變成了19是因為多了Round screen這個維度，用於描述Android Wear，添加於API 23.

處理多個資原始檔夾

每個sourceSet可以定義多個資原始檔夾，舉個例子:

android.sourceSets { main.res.srcDirs = ['src/main/res', 'src/main/res2'] }

這種情況下，兩個資原始檔夾具有相同優先順序，即如果一個資源在兩個資料夾都聲明瞭，合併會報錯。

Library依賴的優先順序順序

根據傳遞的依賴，Library專案的實際集被工程視為一個圖，而不是平鋪的列表，然後合併機制只會處理一個平優先順序列表。

如果我們考慮如下例子的依賴關係：

專案 -> A, B (意味著A的優先順序高於B)

A -> C, D

B -> C

則最後的優先順序list為A, D, B, C，同時保證了A和B可以過載C。

小測試

繼續在之前我們建立的工程的基礎上做個小測試吧。在sourceSet加上res2資料夾，最後build.gradle的android域如下:

android {
    compileSdkVersion 23
    buildToolsVersion "23.0.2"

    defaultConfig {
        applicationId "cn.zhaiyifan.testapp"
        minSdkVersion 14
        targetSdkVersion 23
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    aaptOptions {
        additionalParameters '-S',
                '/Users/yifan/dev/github/Testapp/app/src/main/res3',
                '-S',
                '/Users/yifan/dev/github/Testapp/app/src/main/res2',
                '--auto-add-overlay'
        noCompress 'foo', 'bar'
        ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:<dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~'
    }
    android.sourceSets {
        main.res.srcDirs = ['src/main/res', 'src/main/res2']
    }
}

執行後發現介面顯示了 hehe res2，符合預期，因為res2已經和res合併了，所以先找到了build/intermediates/res/merged/debug下的string，沒有用res3的。

使用場景

不同的buildType、渠道下的包，使用不同的資源，做一些定製，而不用侵入程式碼本身的邏輯。

總結

我們瞭解了Android aapt overlay的機制，以及gradle下的資源合併，並分別編寫運行了demo驗證資源生效的結果。

參考文獻