【Android】图文解密Android OverlayManagerService

1、简介

Android OverlayManagerService（OMS）是一个有意思的模块，可以在运行时动态替换res，如图片。简单来说就是一个普通apk有若干res，另一个相关的overlay apk有相同的res，关闭overlay apk时，普通apk运行时加载的是自己本身的res，而打开overlay apk时，普通apk运行时加载的则是overlay apk中的res。

2、用法举例

普通apk为fruit.apk，package为com.example.fruit，res为/res/drawable/fruit.jpeg，这个图片可以在xml或java中使用。目录结构大致如下：

├── AndroidManifest.xml
├── Android.mk
├── java
│   └── com
│       └── example
│           └── fruit
│               ├── App.java
│               └── MainActivity.java
└── res
    ├── drawable
    │   ├── fruit.jpeg
    │   └── ic_launcher_background.xml
    ├── drawable-v24
    │   └── ic_launcher_foreground.xml
    ├── layout
    │   └── activity_main.xml
    ├── mipmap-anydpi-v26
    │   ├── ic_launcher_round.xml
    │   └── ic_launcher.xml
    ├── mipmap-hdpi
    │   ├── ic_launcher.png
    │   └── ic_launcher_round.png
    ├── mipmap-mdpi
    │   ├── ic_launcher.png
    │   └── ic_launcher_round.png
    ├── mipmap-xhdpi
    │   ├── ic_launcher.png
    │   └── ic_launcher_round.png
    ├── mipmap-xxhdpi
    │   ├── ic_launcher.png
    │   └── ic_launcher_round.png
    ├── mipmap-xxxhdpi
    │   ├── ic_launcher.png
    │   └── ic_launcher_round.png
    └── values
        ├── colors.xml
        ├── strings.xml
        └── styles.xml

Androd.mk使用LOCAL_CERTIFICATE := platform进行签名，LOCAL_AAPT_FLAGS := --auto-add-overlay的目的是支持overlay apk的资源可以和普通apk的资源不同，代码如下：

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_SRC_FILES := $(call all-java-files-under, java)
LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
LOCAL_PACKAGE_NAME := myapp
LOCAL_AAPT_FLAGS := --auto-add-overlay
LOCAL_CERTIFICATE := platform
include $(BUILD_PACKAGE)

AndroidManifest.xm通过android:sharedUserId="android.uid.system"使用系统权限，并添加overlay相应的权限，代码如下：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.fruit"
    android:sharedUserId="android.uid.system">
    <uses-permission android:name="android.permission.MODIFY_THEME_OVERLAY" />
    <uses-permission android:name="android.permission.CHANGE_OVERLAY_PACKAGES" />
    <uses-permission android:name="android.permission.INTERACT_ACROSS_USERS" />
    <uses-permission android:name="android.permission.INTERACT_ACROSS_USERS_FULL" />
    <application
        android:name=".App"
        android:allowBackup="true"
        android:hardwareAccelerated="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

然后是对应的overlay apk，即fruitOverlay.apk，package为com.example.fruit.overlay，有同样的res即res/drawable/fruit.jpeg。目录结构如下：

├── AndroidManifest.xml
├── Android.mk
└── res
    └── drawable
        └── fruit.jpeg

Android.mk中LOCAL_RRO_THEME = fruit指定fruitOverlay apk编译后在vendor/overlay/fruit目录下，include $(BUILD_RRO_PACKAGE)表示编译overlay apk，RRO即Runtime Resource Overlay，对应的还有个SRO，表示Static Resource Overlay，SRO发生在编译时，这里不作介绍。

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
LOCAL_PACKAGE_NAME := fruitOverlay
LOCAL_RRO_THEME = fruit
include $(BUILD_RRO_PACKAGE)

AndroidManifest.xml的overlay标签是个重要的内容，targetPackage表示作用的普通apk的package，priority表示优先级，isStatic为true时表示overlay apk的状态不可动态切换，代码如下：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.fruit.overlay "
    android:versionCode="1"
    android:versionName="1.0">
    <overlay android:targetPackage="com.example.fruit"
    	android:priority="1"
    	android:isStatic="false" />
</manifest>

最后，可以进行测试了，可以在命令行进行测试，也可以使用OverlayManagerService的接口。命令行“cmd overlay enable com.example.fruit.overlay”表示打开overlay， “cmd overlay disable com.example.fruit.overlay”表示关闭overlay，其它命令可通过“cmd overlay help”进行查看。OverlayManagerService的接口可参照“IOverlayManger.aidl”。

3、相关代码

frameworks/base/core/java/android/content/om/
├── IOverlayManager.aidl
├── OverlayInfo.aidl
└── OverlayInfo.java

frameworks/base/services/core/java/com/android/server/om
├── IdmapManager.java
├── OverlayManagerServiceImpl.java
├── OverlayManagerService.java
├── OverlayManagerSettings.java
└── OverlayManagerShellCommand.java

IOverlayManager：aidl，提供了管理overlay package的接口。
OverlayInfo：封装了ovelay package相关的所有信息。
IdmapManager：overlay package资源管理。
OverlayManagerService/OverlayManagerServiceImpl：OMS管理、实现类。
OverlayManagerSettings：专门用于设置overlay 的各个状态。
OverlayManagerShellCommand：支持overlay命令行。

4、启动流程

OMS启动流程如下。

5、使用一个overlay

前面介绍了使用overlay的方法，overlay状态发生变化时，对应的package的Activity会重启，下面介绍下enable一个overlay的大致流程。