Android设计模式之InitContentProvider

本文要讲的设计模式不是常常听到的GoF23种设计模式，也不会讨论java中茴香豆的茴，哦不，单例有多少种写法。本文主要介绍在Android开发中一些鲜为人知，但实际上广泛使用的设计模式。

所谓设计模式就是介于基本代码和架构之间的一种方法，用于解决特定的问题。在开发者之间已经达成某种默契，不需要特别说明，你在阅读这些代码的时候就能理解作者的意图。

问题

当一个app要在启动的时候做一些初始化操作，通常我们会重写Appliction的onCreate，例如这样：

class App : Application() {
    override fun attachBaseContext(base: Context?) {
        Log.d("App", "attachBaseContext: ${base?.javaClass?.canonicalName}")
        super.attachBaseContext(base)
    }

    override fun onCreate() {
        Log.d("App", "onCreate")
        super.onCreate()
        //init 操作
    }
}

如果是我们自己写app这样做没有问题，但是如果是写一个sdk，或者一个开源库，就必须让调用者在onCreate调用某个方法，这样就不太友好，有没有什么方法让调用者只需要在gradle配置中引入我们的库就能在自动在app启动的时候自动初始化呢？答案就是InitContentProvider

InitContentProvider

作为四大组件之一的ContentProvider，顾名思义被设计出来用于跨应用间的内容分享。但是由于它的一个独特特性：在应用被打开时每个注册的ContnentProvider都会被实例化并调用onCreate方法。
例如我们创建一个ContnentProvider 类

class ShadowProvider : ContentProvider() {

    override fun onCreate(): Boolean {
        Log.d("ShadowProvider", "onCreate with context:${context.javaClass.canonicalName}")
        return false
    }

    override fun insert(uri: Uri, values: ContentValues?): Uri? = null

    override fun query(
        uri: Uri,
        projection: Array<String>?,
        selection: String?,
        selectionArgs: Array<String>?,
        sortOrder: String?
    ): Cursor? = null
    
    override fun update(uri: Uri, values: ContentValues?, selection: String?, selectionArgs: Array<String>?): Int  = 0
    override fun delete(uri: Uri, selection: String?, selectionArgs: Array<String>?): Int = 0
    override fun getType(uri: Uri): String?  = null

}

并且在manifest中注册这个contentProvider，在app启动的时候就能看到如下日志输出

2019-06-27 16:03:44.164 31473-31473/? D/App: attachBaseContext: android.app.ContextImpl
2019-06-27 16:03:44.167 31473-31473/? D/ShadowProvider: onCreate with context:github.hotstu.shadowprovider.demo.App
2019-06-27 16:03:44.171 31473-31473/? D/App: onCreate

可以看到contentProvder的onCreate方法调用是在Application的attachBaseContext和onCreate之间

哪些库用了这个技术

firebase、androidx.camerax、androidx.worker、 crashlytics
等等，可以看到第一方库都在用这个模式。在使用者无知觉的情况下完成初始化.

性能影响

虽然google官方告诉大家开发者不要使用反射，但实际上可以看到framework内部的反射用得飞起，这个cotentprovder的初始化也不例外的使用了反射，所以为了影响app的启动速度，请不要滥用

如何禁用

第三方的库在manifest中搞了这个，如何禁用？

        <provider android:name="com.crashlytics.android.CrashlyticsInitProvider"
                  tools:node="remove"/>
        <provider android:name="com.google.firebase.provider.FirebaseInitProvider"
                  tools:node="remove"/>

只想在特定版本下启用？

例如camera2相关api只在api21后才支持，但app需要兼容之前的版本， 解决办法：在value和value-21中声明bool值, 在 android:enabled中引用，这样在5.0之前改组件就被禁用了

            android:name="androidx.camera.camera2.impl.Camera2Initializer"
            android:authorities="${applicationId}.camerax-init"
            android:enabled="@bool/camerax_enable"
            android:exported="false"
            android:initOrder="100"
            android:multiprocess="true" />

多进程

默认情况下contentProvider只会创建一个，如果app中用到了多进程，需要添加android:multiprocess="true"声明，这样每个进程中都会创建一次