Android | 使用 ContentProvider 无侵入

2020-07-06 本文已影响0人彭旭锐

前言

在Android中，使用三方库或二方库时，通常都需要使用Context进行初始化
这篇文章将介绍一种基于ContentProvider机制实现的无侵入获取Context的方法，希望能帮上忙

1. 获取 Context 的常规方法

我们知道Context本身是一个抽象类，所以我们获取Context实际上是获取Context的实现类，具体可以分为：Application、Activity、Service与ContextImpl。若还不了解，请务必阅读文章：《Android | 一个进程有多少个 Context 对象（答对的不多）》

1.1 获取 Application 对象

既然Application是Context的实现类，那么我们就可以直接使用Application对象来初始化第三方库，同时也可以使用一个静态方法将对象暴露出去：

// MainApplication.kt

class MainApplication : Application() {

    companion object {
        lateinit var application: Application
            get
    }

    override fun onCreate() {
        super.onCreate()
        application = this

        // 初始化第三方库
    }
}

1.2 获取 Activity & Service 对象

同样地，Activity & Service也是Context的实现类，那么我们就可以在程序运行过程中，按需初始化第三方库。例如使用Glide时，并不需要一开始就调用Glide#with(Context)，只需要在显示图片的时候调用即可：
【todo】

1.3 小结

优点
最常用的方式，实现简单，没有性能 / 稳定性风险；可以按需初始化第三方库 & 懒加载
缺点
需要获取ApplicationContext / Context(依赖方与库代码强耦合)，不利于组件化

下面，我将介绍两种无侵入获取Context的方法，将涉及到Android进程的启动流程，若还不了解，请务必阅读文章：《Android | 带你理解 Application 的创建过程》

2. 反射 ActivityThread 获得 ApplicationContext（不推荐）

这一节介绍一种通过ActivityThread.java获得Application的方法，具体如下：

2.1 源码分析

我们都知道，在启动四大组件（Activity、Service、ContentProvider, BroadcastReceiver）时，如果对应的进程未启动，就需要先创建进程，相应地也会创建一个Application对象。若还不了解，请务必阅读：《Android | 带你理解 Application 的创建过程》。简单来说：

在system_server进程，通过AMS#getProcessRecordLocked(...)获取进程信息(ProcessRecord)；
若不存在，则调用AMS#startProcessLocked(...)创建进程
在Zygote孵化目标进程之后，在目标进程反射执行ActivityThread#main()，并最终在ActivityThread#handleBindApplication(...)中创建Application对象

// ActivityThread.java

Application mInitialApplication;

public Application getApplication() {
        return mInitialApplication;
}
    
private void handleBindApplication(AppBindData data) {
    // ...
    Application app;
    // data.info 为 LoadedApk.java
    app = data.info.makeApplication(data.restrictedBackupMode, null);
    // ...
    mInitialApplication = app;
    // ...
}

可以看到，创建Application对象之后会保存在mInitialApplication属性中，那么如果我们可以访问到这个属性，是不是就可以获得Application对象了呢？

首先，我们需要获得ActivityThread对象，那么我们先在源码中寻找创建ActivityThread对象的地方：

// ActivityThread.java

private static volatile ActivityThread sCurrentActivityThread;

public static ActivityThread currentActivityThread() {
    return sCurrentActivityThread;
}
    
// (简化)
public static void main(String[] args) {
    Looper.prepareMainLooper();
    
    // 创建 ActivityThread 对象
    ActivityThread thread = new ActivityThread();
    thread.attach(false, startSeq);
    
    Looper.loop();
}

private void attach(boolean system, long startSeq) {
    sCurrentActivityThread = this;
}

可以看到，ActivityThread对象存储在静态变量sCurrentActivityThread中，那么我们就可以写反射代码了。

2.2 使用步骤

// 新建文件 Context.kt

private var application: Context? = null

fun context(): Context {
    if (null == application) {
        try {
            val activityThread: Any
            val clazz = Class.forName("android.app.ActivityThread")
            val currentActivityThread = clazz.getMethod("currentActivityThread").apply {
                isAccessible = true
            }
            val getApplication = clazz.getMethod("getApplication").apply {
                isAccessible = true
            }
            activityThread = currentActivityThread.invoke(null)
            application= getApplication.invoke(activityThread) as Context
        } catch (e: Throwable) {
            // 存在未适配的风险
        }
    }
    return application!!
}

运行测试一下，context()的返回结果：

android.app.Application@c12661f

2.3 小结

优点：
依赖方不需要传递Context对象给库进行初始化，减少了代码耦合，有利于组件化
缺点：
需要反射调用私有API，存在系统版本适配风险；使用反射有一定性能损耗

3. 使用 ContentProvider 获取 ApplicationContext

这一节介绍一种通过ContentProvider.java获得Application的方法。ContentProvider通常的用法是为当前进程 / 远程进程提供内容服务，它们会在应用启动的时候初始化，正因如此，我们可以利用ContentProvider来获得Context。

3.1 源码分析

// ActivityThread.java

private void handleBindApplication(AppBindData data) {
    // ...
    Application app;
    app = data.info.makeApplication(data.restrictedBackupMode, null);
    mInitialApplication = app;
    // 初始化所有 ContentProvider
    installContentProviders(app, data.providers);
    // ...
}

private void installContentProviders(Context context, List<ProviderInfo> providers) {
    final ArrayList<ContentProviderHolder> results = new ArrayList<>();

    for (ProviderInfo cpi : providers) {
        // 依次初始化 ContentProvider
        ContentProviderHolder cph = installProvider(context, null, cpi,
                false /*noisy*/, true /*noReleaseNeeded*/, true /*stable*/);
        if (cph != null) {
            cph.noReleaseNeeded = true;
            results.add(cph);
        }
    }
    // ...
}

可以看到，在ActivityThread中，创建Application对象之后会调用installContentProviders()安装属于当前进程(processName)的ContentProvider，若还不了解，请务必阅读文章：《Android | 带你理解 ContentProvider 机制》

在ContentProvider声明的方法中，提供了getContext()获得ApplicationContext，所以，我们就可以ContentProvider启动的机制，从ContentProvider启动时拿到ApplicationContext

3.2 使用步骤

步骤一：实现 ContentProvider 子类

// ContextProvider.kt

internal sealed class ContextProvider : ContentProvider(){

    override fun onCreate(): Boolean {
        init(context!!)
        return true
    }
    
    // 其他方法直接 return 
}
// Context.kt
private lateinit var application : Context

fun init(context : Context){
    application= context
}

fun context() : Context{
    return application
}

步骤二：在 AndroidManifest 中配置

// AndroidManifest.xml

<application>
    <provider
        android:name=".Contextprovider"
        android:authorities="${applicationId}.contextprovider"
        android:exported="false" />
</application>

步骤三：使用

Toast.makeText(context(),"",Toast.LENGTH_SHORT).show()

3.3 小结

优点：
依赖方不需要传递Context对象给库进行初始化，减少了代码耦合，有利于组件化
缺点：
在App启动时就初始化ContentProvider，不是懒初始化
风险：
应保证初始化非常轻量，否则会降低App的启动速度

4. 案例

下面举出一些基于ContentProvider机制实现无侵入地获取Context的例子：

LeakCanary 2.4

internal sealed class AppWatcherInstaller : ContentProvider() {
    override fun onCreate(): Boolean {
        val application = context!!.applicationContext as Application
        AppWatcher.manualInstall(application)
        return true
    }

    // 其他方法直接 return 
}

AutoSize 1.1.2

public class InitProvider extends ContentProvider {
    @Override
    public boolean onCreate() {
        AutoSizeConfig.getInstance()
                .setLog(true)
                .init((Application) getContext().getApplicationContext())
                .setUseDeviceSize(false);
        return true;
    }

    // 其他方法直接 return 
}

Picasso 2.7

public final class PicassoProvider extends ContentProvider {

    @SuppressLint("StaticFieldLeak") static Context context;

    @Override public boolean onCreate() {
        context = getContext();
        return true;
    }

    // 其他方法直接 return 
}