Android Startup实现分析

前言

Android Startup提供一种在应用启动时能够更加简单、高效的方式来初始化组件。开发人员可以使用Android Startup来简化启动序列，并显式地设置初始化顺序与组件之间的依赖关系。 与此同时，Android Startup支持同步与异步等待、手动控制依赖执行时机，并通过有向无环图拓扑排序的方式来保证内部依赖组件的初始化顺序。

Android Startup经过几轮的迭代已经更加完善了，支持的功能场景也更加多样，如果你要使用Android Startup的新特性，请将依赖升级到最新版本latest release

dependencies {
    implementation 'com.rousetime.android:android-startup:latest release'
}

在之前的我为何弃用Jetpack的App Startup?文章中有提供一张与App Startup的对比图，现在也有了一点变化

指标	App Startup	Android Startup
手动配置	✅	✅
自动配置	✅	✅
依赖支持	✅	✅
闭环处理	✅	✅
线程控制	❌	✅
异步等待	❌	✅
依赖回调	❌	✅
手动通知	❌	✅
拓扑优化	❌	✅

核心内容都在这种对比图中，下面根据这种对比图来详细分析一下Android Startup的实现原理。

配置

手动

手动配置是通过StartupManager.Builder()来实现的，本质很简单，使用builder模式来初始化一些必要的参数，进而来获取StartupManager实例，最后再启动Android Startup。

val config = StartupConfig.Builder()
    .setLoggerLevel(LoggerLevel.DEBUG)
    .setAwaitTimeout(12000L)
    .setListener(object : StartupListener {
        override fun onCompleted(totalMainThreadCostTime: Long, costTimesModels: List) {
            // can to do cost time statistics.
            costTimesLiveData.value = costTimesModels
            Log.d("StartupTrack", "onCompleted: ${costTimesModels.size}")
        }
    })
    .build()
 
StartupManager.Builder()
    .setConfig(config)
    .addStartup(SampleFirstStartup())
    .addStartup(SampleSecondStartup())
    .addStartup(SampleThirdStartup())
    .addStartup(SampleFourthStartup())
    .build(this)
    .start()
    .await()

自动

另一种方式是自动配置，开发者不需要手动调用StartupManager.Builder()，只需在AndroidManifest.xml文件中进行配置。

而实现这种配置的原理是：Android Startup内部是通过一个ContentProvider来实现自动配置的，在Android中ContentProvider的初始化时机介于Application的attachBaseContext与onCreate之间。所以Android Startup借助这一特性将初始化的逻辑都封装到自定义的StartupProvider中

class StartupProvider : ContentProvider() {

    override fun onCreate(): Boolean {
        context.takeIf { context -> context != null }?.let {
            val store = StartupInitializer.instance.discoverAndInitialize(it)
            StartupManager.Builder()
                .setConfig(store.config?.getConfig())
                .addAllStartup(store.result)
                .build(it)
                .start()
                .await()
        } ?: throw StartupException("Context cannot be null.")

        return true
    }
    ...
    ...
}

有了StartupProvider之后，下一步需要做的就是解析在AndroidManife.xml的provider标签下所配置的Startup与Config。

有关解析的部分都在StartupInitializer类中，通过它的discoverAndInitialize()方法就能获取到解析的数据。

internal fun discoverAndInitialize(context: Context): StartupProviderStore {
 
    TraceCompat.beginSection(StartupInitializer::class.java.simpleName)
 
    val result = mutableListOf>()
    val initialize = mutableListOf()
    val initialized = mutableListOf()
    var config: StartupProviderConfig? = null
    try {
        val provider = ComponentName(context.packageName, StartupProvider::class.java.name)
        val providerInfo = context.packageManager.getProviderInfo(provider, PackageManager.GET_META_DATA)
        val startup = context.getString(R.string.android_startup)
        val providerConfig = context.getString(R.string.android_startup_provider_config)
        providerInfo.metaData?.let { metaData ->
            metaData.keySet().forEach { key ->
                val value = metaData[key]
                val clazz = Class.forName(key)
                if (startup == value) {
                    if (AndroidStartup::class.java.isAssignableFrom(clazz)) {
                        doInitialize((clazz.getDeclaredConstructor().newInstance() as AndroidStartup<*>), result, initialize, initialized)
                    }
                } else if (providerConfig == value) {
                    if (StartupProviderConfig::class.java.isAssignableFrom(clazz)) {
                        config = clazz.getDeclaredConstructor().newInstance() as? StartupProviderConfig
                        // save initialized config
                        StartupCacheManager.instance.saveConfig(config?.getConfig())
                    }
                }
            }
        }
    } catch (t: Throwable) {
        throw StartupException(t)
    }
 
    TraceCompat.endSection()
 
    return StartupProviderStore(result, config)
}

核心逻辑是：

1. 通过ComponentName()获取指定的StartupProvider
2. 通过getProviderInfo()获取对应StartupProvider下的meta-data数据
3. 遍历meta-data数组
4. 根据事先预定的value来匹配对应的name
5. 最终通过反射来获取对应name的实例

其中在解析Statup的过程中，为了减少Statup的配置，使用doInitialize()方法来自动创建依赖的Startup，并且提前对循环依赖进行检查。

依赖支持

/**
 * Returns a list of the other [Startup] objects that the initializer depends on.
 */
fun dependencies(): List>>?

/**
 * Called whenever there is a dependency completion.
 *
 * @param [startup] dependencies [startup].
 * @param [result] of dependencies startup.
 */
fun onDependenciesCompleted(startup: Startup<*>, result: Any?)

某个初始化的组件在初始化之前所依赖的组件都必须通过dependencies()进行申明。申明之后会在后续进行解析，保证依赖的组件优先执行完毕；同时依赖的组件执行完毕会回调onDependenciesCompleted()方法。执行顺序则是通过有向图拓扑排序决定的。

闭环处理

有关闭环的处理，一方面会在自动配置环节的doInitialize()方法中会进行处理

private fun doInitialize(
    startup: AndroidStartup<*>,
    result: MutableList>,
    initialize: MutableList,
    initialized: MutableList
) {
    try {
        val uniqueKey = startup::class.java.getUniqueKey()
        if (initialize.contains(uniqueKey)) {
            throw IllegalStateException("have circle dependencies.")
        }
        if (!initialized.contains(uniqueKey)) {
            initialize.add(uniqueKey)
            result.add(startup)
            startup.dependencies()?.forEach {
                doInitialize(it.getDeclaredConstructor().newInstance() as AndroidStartup<*>, result, initialize, initialized)
            }
            initialize.remove(uniqueKey)
            initialized.add(uniqueKey)
        }
    } catch (t: Throwable) {
        throw StartupException(t)
    }
}

将当前Startup加入到initialize中，同时遍历dependencies()依赖数组，递归调用doInitialize()。

在递归的过程中，如果在initialize中存在对应的uniqueKey(这里为Startup的唯一标识)则代表发送的互相依赖，即存在依赖环。

另一方面，再后续的有向图拓扑排序优化也会进行环处理

fun sort(startupList: List>): StartupSortStore {
    ...
 
    if (mainResult.size + ioResult.size != startupList.size) {
        throw StartupException("lack of dependencies or have circle dependencies.")
    }

}

在排序优化过程中会将在主线程执行与非主线程执行的Startup进行分类，再分类过程中并不会进行排重处理，只关注当前的Startup是否再主线程执行。所以最后只要这两种分类的大小之和不等于Startup的总和就代表存在环，即有互相依赖。

线程处理

线程方面，使用的是StartupExecutor接口， 在AndroidStartup默认实现了它的接口方法createExecutor()

override fun createExecutor(): Executor = ExecutorManager.instance.ioExecutor

在ExecutorManager中提供了三种线程分别为

1. cpuExecutor: cpu使用频率高，高速计算；核心线程池的大小与cpu核数相关。
2. ioExecutor: io操作，网络处理等；内部使用缓存线程池。
3. mainExecutor: 主线程。

所以如果需要修改默认线程，可以重写createExecutor()方法。

异步等待

在上面的依赖支持部分已经提到使用dependencies()来设置依赖的组件。每一个初始化组件能够执行的前提是它自身的依赖组件全部已经执行完毕。

如果是同步依赖，自然很简单，只需要按照依赖的顺序依次执行即可。而对于异步依赖任务，则需要保证所有的异步依赖任务完成，当前组件才能正常执行。

在Android Startup借助了CountDownLatch来保证异步依赖的执行完成监听。

CountDownLatch字面意思就是倒计时锁，它是作用于线程中，初始化时会设置一个count大小的倒计时，通过await()来等待倒计时的结束，只不过倒计时的数值减少是通过手动调用countDown()来触发的。

所以在抽象类AndroidStartup中，通过await()与countDown()来保证异步任务的准确执行。

abstract class AndroidStartup : Startup {
 
    private val mWaitCountDown by lazy { CountDownLatch(dependencies()?.size ?: 0) }
    private val mObservers by lazy { mutableListOf() }
 
    override fun toWait() {
        try {
            mWaitCountDown.await()
        } catch (e: InterruptedException) {
            e.printStackTrace()
        }
    }
 
    override fun toNotify() {
        mWaitCountDown.countDown()
    }
    ...
}

我们通过toWait()方法来等待依赖组件的执行完毕，而依赖的组件任务执行完毕之后，通过toNotify()来通知当前组件，一旦所有的依赖执行完毕之后，就会释放当前的线程，使它继续执行下去。

而toWait()与toNotify()的具体调用时机分别在StartupRunnable与StartupManagerDispatcher中执行。

依赖回调

在依赖回调之前，先来认识一个接口ManagerDispatcher

interface ManagerDispatcher {
 
    /**
     * dispatch prepare
     */
    fun prepare()
 
    /**
     * dispatch startup to executing.
     */
    fun dispatch(startup: Startup<*>, sortStore: StartupSortStore)
 
    /**
     * notify children when dependency startup completed.
     */
    fun notifyChildren(dependencyParent: Startup<*>, result: Any?, sortStore: StartupSortStore)
}

在ManagerDispatcher中有三个接口方法，分别用来管理Startup的执行逻辑，保证执行前的准备工作，执行过程中的分发与执行后的回调。所以依赖回调自然也在其中。

调用逻辑被封装到notifyChildren()方法中。最终调用Startup的onDependenciesCompleted()方法。

所以我们可以在初始化组件中重写onDependenciesCompleted()方法，从而拿到所依赖的组件完成后返回的结果。例如Sample中的SampleSyncFourStartup

class SampleSyncFourStartup: AndroidStartup() {
 
    private var mResult: String? = null
 
    override fun create(context: Context): String? {
        return "$mResult + sync four"
    }
 
    override fun callCreateOnMainThread(): Boolean = true
 
    override fun waitOnMainThread(): Boolean = false
 
    override fun dependencies(): List>>? {
        return listOf(SampleAsyncTwoStartup::class.java)
    }
 
    override fun onDependenciesCompleted(startup: Startup<*>, result: Any?) {
        mResult = result as? String?
    }
}

当然这是在当前组件中获取依赖组件的返回结果，Android Startup还提供了在任意时候来查询任意组件的执行状况，并且支持获取任意已经完成的组件的返回结果。

Android Startup提供StartupCacheManager来实现这些功能。具体使用方式可以通过查看Sample来获取。

手动通知

上面介绍了依赖回调，它是自动调用依赖完成后的一系列操作。Android Startup也提供了手动通知依赖任务的完成。

手动通知的设置是通过manualDispatch()方法开启。它将配合onDispatch()一起完成。

在ManagerDispatcher接口具体实现类的notifyChildren()方法中，如果开启手动通知，就不会走自动通知流程，调用toNotify()方法，而是会将当前组件的Dispatcher添加到注册表中。等待onDispatche()的手动调用去唤醒toNotify()的执行。

override fun notifyChildren(dependencyParent: Startup<*>, result: Any?, sortStore: StartupSortStore) {
    // immediately notify main thread,Unblock the main thread.
    if (dependencyParent.waitOnMainThread()) {
        needAwaitCount.incrementAndGet()
        awaitCountDownLatch?.countDown()
    }
 
     sortStore.startupChildrenMap[dependencyParent::class.java.getUniqueKey()]?.forEach {
        sortStore.startupMap[it]?.run {
            onDependenciesCompleted(dependencyParent, result)
 
            if (dependencyParent.manualDispatch()) {
                dependencyParent.registerDispatcher(this)
            } else {
                toNotify()
            }
        }
    }
    ...
}

具体实现示例可以查看SampleManualDispatchStartup

拓扑优化

Android Startup中初始化组件与组件间的关系其实就是一张有向无环拓扑图。

以Sample中的一个demo为例：

我们将每一个Startup的边指向目标为一个入度。根据这个规定很容易算出这四个Startup的入度

1. SampleFirstStartup: 0
2. SampleSecondStartup: 1
3. SampleThirdStartup: 2
4. SampleFourthStartup: 3

那么这个入度有什么用呢？根据由AOV网构造拓扑序列的拓扑排序算法主要是循环执行以下两步，直到不存在入度为0的顶点为止。

1. 选择一个入度为0的顶点并输出之；
2. 从网中删除此顶点及所有出边

循环结束后，若输出的顶点数小于网中的顶点数，则输出“有回路”信息，否则输出的顶点序列就是一种拓扑序列。

根据上面的步骤，可以得出上面的四个Startup的输出顺序为

SampleFirstStartup -> SampleSecondStartup -> SampleThirdStartup -> SampleFourthStartup

以上的输出顺序也是初始化组件间的执行顺序。这样即保证了依赖组件间的正常执行，也保证了初始化组件的执行顺序的最优解，即依赖组件间的等候时间最短，同时也检查了依赖组件间是否存在环。

既然已经有了方案与实现步骤，下面要做的就是用代码实现出来。

fun sort(startupList: List>): StartupSortStore {
    TraceCompat.beginSection(TopologySort::class.java.simpleName)

    val mainResult = mutableListOf>()
    val ioResult = mutableListOf>()
    val temp = mutableListOf>()
    val startupMap = hashMapOf>()
    val zeroDeque = ArrayDeque()
    val startupChildrenMap = hashMapOf>()
    val inDegreeMap = hashMapOf()

    startupList.forEach {
        val uniqueKey = it::class.java.getUniqueKey()
        if (!startupMap.containsKey(uniqueKey)) {
            startupMap[uniqueKey] = it
            // save in-degree
            inDegreeMap[uniqueKey] = it.dependencies()?.size ?: 0
            if (it.dependencies().isNullOrEmpty()) {
                zeroDeque.offer(uniqueKey)
            } else {
                // add key parent, value list children
                it.dependencies()?.forEach { parent ->
                    val parentUniqueKey = parent.getUniqueKey()
                    if (startupChildrenMap[parentUniqueKey] == null) {
                        startupChildrenMap[parentUniqueKey] = arrayListOf()
                    }
                    startupChildrenMap[parentUniqueKey]?.add(uniqueKey)
                }
            }
        } else {
            throw StartupException("$it multiple add.")
        }
    }

    while (!zeroDeque.isEmpty()) {
        zeroDeque.poll()?.let {
            startupMap[it]?.let { androidStartup ->
                temp.add(androidStartup)
                // add zero in-degree to result list
                if (androidStartup.callCreateOnMainThread()) {
                    mainResult.add(androidStartup)
                } else {
                    ioResult.add(androidStartup)
                }
            }
            startupChildrenMap[it]?.forEach { children ->
                inDegreeMap[children] = inDegreeMap[children]?.minus(1) ?: 0
                // add zero in-degree to deque
                if (inDegreeMap[children] == 0) {
                    zeroDeque.offer(children)
                }
            }
        }
    }

    if (mainResult.size + ioResult.size != startupList.size) {
        throw StartupException("lack of dependencies or have circle dependencies.")
    }

    val result = mutableListOf>().apply {
        addAll(ioResult)
        addAll(mainResult)
    }
    printResult(temp)

    TraceCompat.endSection()

    return StartupSortStore(
        result,
        startupMap,
        startupChildrenMap
    )
}

有了上面的步骤，相信这段代码都能够理解。

除了上面所介绍的功能，Android Startup还支持Systrace插桩，为用户提供系统分析初始化的耗时详细过程；初始化组件的准确耗时收集统计，方便用户下载与上传到指定服务器等等。

Android Startup的核心功能分析暂时就到这里结束了，希望能够对你有所帮助。

当然，本人真诚的邀请你加入Android Startup的建设中，如果你有什么好的建议也请不吝赐教。

项目

android_startup: 提供一种在应用启动时能够更加简单、高效的方式来初始化组件，优化启动速度。

AwesomeGithub: 基于Github的客户端，纯练习项目，支持组件化开发，支持账户密码与认证登陆。使用Kotlin语言进行开发，项目架构是基于JetPack&DataBinding的MVVM；项目中使用了Arouter、Retrofit、Coroutine、Glide、Dagger与Hilt等流行开源技术。

flutter_github: 基于Flutter的跨平台版本Github客户端。

android-api-analysis: 结合详细的Demo来全面解析Android相关的知识点, 帮助读者能够更快的掌握与理解所阐述的要点。

daily_algorithm: 每日一算法，由浅入深，欢迎加入一起共勉。

为自己代言

WeChat Official Account：【Android补给站】