Jetpack之Startup快速掌握

冬天的毛毛雨發表於2020-12-23

好文推薦
作者：LKV_劉言

功能

用於為App提供初始化回撥能力。體系化得將各種App內的功能模組、所引入的SDK的初始化聯合起來，不各自為戰。一方面能夠將所有的初始化方式進行統一，在程式碼學習層面便於進入。另一方面，在初始化方式收斂後也能夠有效的做效能資料監控。

配置

implementation "androidx.startup:startup-runtime:1.0.0"

使用

實現子類

每一個需要初始化的元件實現一個Initializer<T>的子類

並實現兩個方法：

create這個方法要求返回你要初始化的元件的物件例項，可以new出來，也可以使用Builder等等，by your self
dependencies這個方法用來返回一系列的Initializer的子類的Class集合。意義是告知初始化框架，當前這個元件的初始化需要依賴其他的哪些元件初始化。可以沒有有效內容。

例項（來自官方）

// Initializes WorkManager.
class WorkManagerInitializer : Initializer<WorkManager> {
    override fun create(context: Context): WorkManager {
        val configuration = Configuration.Builder().build()
        WorkManager.initialize(context, configuration)
        return WorkManager.getInstance(context)
    }
    override fun dependencies(): List<Class<out Initializer<*>>> {
        // No dependencies on other libraries.
        return emptyList()
    }
}

宣告Manifest

兩點注意：

要在Manifest中宣告其原理中真正使用的ContentProvider類androidx.startup.InitializationProvider，注意author要攜帶${applicationId}來避免與其他App產生衝突
記得一定要在這個provider下宣告meta-data

第一點不做解釋了，其基本原理就是依靠ContentProvider的onCreate會在應用初始化時被自動呼叫這一點。

關於第二個需要解釋：

Startup會去找自己Provider下宣告的第一個meta-data所對應的類，來對他進行初始化，如果他宣告瞭他有依賴項，那麼他的依賴項也會被初始化。這樣，一個初始化鏈路就行程了。

例項：

<provider
    android:name="androidx.startup.InitializationProvider"
    android:authorities="${applicationId}.androidx-startup"
    android:exported="false"
    tools:node="merge">
    <!-- This entry makes ExampleLoggerInitializer discoverable. -->
    <meta-data  android:name="com.example.ExampleLoggerInitializer"
          android:value="androidx.startup" />
</provider>

meta-data支援宣告多個，只要他們的android:value都是androidx.startup就會被收集到：

原理

概覽

核心

ContentProvider的onCreate生命週期會在Application的onCreate之前被ActivityThread呼叫：

並且，這個行為是系統行為，不需要使用者去主動觸發，也就節省了XXX.init這種程式碼呼叫。

流程

InitializationProvider呼叫AppInitializer.discoverAndInitialize()方法
AppInitializer.discoverAndInitialize()掃描AndroidManifest.xml中InitializationProvider下的註冊資訊中的meta-data進行初始化元件發現：

需要注意的是：

只要meta-data的android:value是androidx.startup那麼就可以被收集到，後續的觸發是按照在Manifest中宣告的順序進行的
截圖中程式碼沒有提到的，會使用Map mInitialized來確保每個類只會被初始化一次，而通過臨時的initializing確保在依賴關係中不允許迴圈依賴

第二點可以在下一步得到驗證：