厲害了！自己寫(xiě)個(gè)App 啟動(dòng)任務(wù)框架
大家好，我是皇叔，最近開(kāi)了一個(gè)安卓進(jìn)階漲薪訓(xùn)練營(yíng)，可以幫助大家突破技術(shù)&職場(chǎng)瓶頸，從而度過(guò)難關(guān)，進(jìn)入心儀的公司。
詳情見(jiàn)文章：沒(méi)錯(cuò)！皇叔開(kāi)了個(gè)訓(xùn)練營(yíng)
作者：王晨彥
https://juejin.cn/post/7042201901399539748
1.前言
我們?cè)陂_(kāi)發(fā)應(yīng)用的時(shí)候，一般都會(huì)引入 SDK，而大部分 SDK 都要求我們?cè)?Application 中初始化，當(dāng)我們引入的 SDK 越來(lái)越多，就會(huì)出現(xiàn) Application 越來(lái)越長(zhǎng)，如果 SDK 的初始化任務(wù)相互依賴(lài)，還要處理很多條件判斷，這時(shí)，如果再來(lái)個(gè)異步初始化，相信大家都會(huì)崩潰。
有人可能會(huì)說(shuō)，我都在主線程按順序初始化不就行了，當(dāng)然行，只要老板不來(lái)找你麻煩。
「小王啊，咱們的 APP 啟動(dòng)時(shí)間怎么這么久？」
開(kāi)個(gè)玩笑，可見(jiàn)，一個(gè)優(yōu)秀的啟動(dòng)框架對(duì)于 APP 啟動(dòng)性能而言，是多么的重要！
2.為什么不用 Google 的 StartUp?
說(shuō)到啟動(dòng)框架，就不得不提 StartUp，畢竟是 Google 官方出品，現(xiàn)有的啟動(dòng)框架，或多或少都有參考 StartUp，這里不再詳細(xì)介紹，如果對(duì) StartUp 還不了解，可以參考這篇文章 Jetpack系列之App Startup從入門(mén)到出家。
https://juejin.cn/post/7023643365048582174
StartUp 提供了簡(jiǎn)便的依賴(lài)任務(wù)初始化功能，但是對(duì)于一個(gè)復(fù)雜項(xiàng)目來(lái)說(shuō)，StartUp 有以下不足：
1. 不支持異步任務(wù)
如果通過(guò) ContentProvider 啟動(dòng)，所有任務(wù)都在主線程執(zhí)行，如果通過(guò)接口啟動(dòng)，所有任務(wù)都在同一個(gè)線程執(zhí)行。
2. 不支持組件化
通過(guò) Class 指定依賴(lài)任務(wù)，需要引用依賴(lài)的模塊。
3. 不支持多進(jìn)程
無(wú)法單獨(dú)配置任務(wù)需要執(zhí)行的進(jìn)程。
4. 不支持啟動(dòng)優(yōu)先級(jí)
雖然可以通過(guò)指定依賴(lài)來(lái)設(shè)置優(yōu)先級(jí)，但是過(guò)于復(fù)雜。
3.一個(gè)合格的啟動(dòng)框架是怎么樣的？
1. 支持異步任務(wù)
減少啟動(dòng)時(shí)間的有效手段。
2. 支持組件化
其實(shí)就是解耦，一方面是解耦任務(wù)依賴(lài)，另一方面是解耦 app 和 module 的依賴(lài)。
3. 支持任務(wù)依賴(lài)
可以簡(jiǎn)化我們的任務(wù)調(diào)度。
4. 支持優(yōu)先級(jí)
在沒(méi)有依賴(lài)的情況下，允許任務(wù)優(yōu)先執(zhí)行。
5. 支持多進(jìn)程
只在需要的進(jìn)程中執(zhí)行初始化任務(wù)，可以減輕系統(tǒng)負(fù)載，側(cè)面提升 APP 啟動(dòng)速度。
4.收集任務(wù)
如果要做到完全解耦，我們可以使用 APT 收集任務(wù)。
首先定義注解，即任務(wù)的一些屬性。
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
annotation class InitTask(
/**
* 任務(wù)名稱(chēng)，需唯一
*/
val name: String,
/**
* 是否在后臺(tái)線程執(zhí)行
*/
val background: Boolean = false,
/**
* 優(yōu)先級(jí)，越小優(yōu)先級(jí)越高
*/
val priority: Int = PRIORITY_NORM,
/**
* 任務(wù)執(zhí)行進(jìn)程，支持主進(jìn)程、非主進(jìn)程、所有進(jìn)程、:xxx、特定進(jìn)程名
*/
val process: Array<String> = [PROCESS_ALL],
/**
* 依賴(lài)的任務(wù)
*/
val depends: Array<String> = []
)
name 作為任務(wù)唯一標(biāo)識(shí)，類(lèi)型為 String 主要是解耦任務(wù)依賴(lài)。
background 即是否后臺(tái)執(zhí)行。
priority 是在主線程、無(wú)依賴(lài)場(chǎng)景下的執(zhí)行順序。
process 指定了任務(wù)執(zhí)行的進(jìn)程，支持主進(jìn)程、非主進(jìn)程、所有進(jìn)程、:xxx、特定進(jìn)程名。
depends 指定依賴(lài)的任務(wù)。
任務(wù)的屬性定義好，還需要一個(gè)執(zhí)行任務(wù)的接口：
interface IInitTask {
fun execute(application: Application)
}
任務(wù)需要收集的信息已經(jīng)定義好了，那么看一下一個(gè)真正的任務(wù)長(zhǎng)什么樣。
@InitTask(
name = "main",
process = [InitTask.PROCESS_MAIN],
depends = ["lib"]
)
class MainTask : IInitTask {
override fun execute(application: Application) {
SystemClock.sleep(1000)
Log.e("WCY", "main1 execute")
}
}還是比較簡(jiǎn)潔清晰的。
接下來(lái)需要通過(guò) Annotation Processor 收集任務(wù)，然后通過(guò) kotlin poet 寫(xiě)入文件。
class TaskProcessor : AbstractProcessor() {
override fun process(annotations: MutableSet<out TypeElement>?, roundEnv: RoundEnvironment): Boolean {
val taskElements = roundEnv.getElementsAnnotatedWith(InitTask::class.java)
val taskType = elementUtil.getTypeElement("me.wcy.init.api.IInitTask")
/**
* Param type: MutableList<TaskInfo>
*
* There's no such type as MutableList at runtime so the library only sees the runtime type.
* If you need MutableList then you'll need to use a ClassName to create it.
* [https://github.com/square/kotlinpoet/issues/482]
*/
val inputMapTypeName =
ClassName("kotlin.collections", "MutableList").parameterizedBy(TaskInfo::class.asTypeName())
/**
* Param name: taskList: MutableList<TaskInfo>
*/
val groupParamSpec = ParameterSpec.builder(ProcessorUtils.PARAM_NAME, inputMapTypeName).build()
/**
* Method: override fun register(taskList: MutableList<TaskInfo>)
*/
val loadTaskMethodBuilder = FunSpec.builder(ProcessorUtils.METHOD_NAME)
.addModifiers(KModifier.OVERRIDE)
.addParameter(groupParamSpec)
for (element in taskElements) {
val typeMirror = element.asType()
val task = element.getAnnotation(InitTask::class.java)
if (typeUtil.isSubtype(typeMirror, taskType.asType())) {
val taskCn = (element as TypeElement).asClassName()
/**
* Statement: taskList.add(TaskInfo(name, background, priority, process, depends, task));
*/
loadTaskMethodBuilder.addStatement(
"%N.add(%T(%S, %L, %L, %L, %L, %T()))",
ProcessorUtils.PARAM_NAME,
TaskInfo::class.java,
task.name,
task.background,
task.priority,
ProcessorUtils.formatArray(task.process),
ProcessorUtils.formatArray(task.depends),
taskCn
)
}
}
/**
* Write to file
*/
FileSpec.builder(ProcessorUtils.PACKAGE_NAME, "TaskRegister\$$moduleName")
.addType(
TypeSpec.classBuilder("TaskRegister\$$moduleName")
.addKdoc(ProcessorUtils.JAVADOC)
.addSuperinterface(ModuleTaskRegister::class.java)
.addFunction(loadTaskMethodBuilder.build())
.build()
)
.build()
.writeTo(filer)
return true
}
}
看一下生成的文件長(zhǎng)什么樣。
public class TaskRegister$sample : ModuleTaskRegister {
public override fun register(taskList: MutableList<TaskInfo>): Unit {
taskList.add(TaskInfo("main2", true, 0, arrayOf("PROCESS_ALL"), arrayOf("main1","lib1"),MainTask2()))
taskList.add(TaskInfo("main3", false, -1000, arrayOf("PROCESS_ALL"), arrayOf(), MainTask3()))
taskList.add(TaskInfo("main1", false, 0, arrayOf("PROCESS_MAIN"), arrayOf("lib1"), MainTask()))
}
}
sample 模塊收集到了3個(gè)任務(wù)，TaskInfo 對(duì)任務(wù)信息做了聚合。
我們知道 APT 可以生成代碼，但是無(wú)法修改字節(jié)碼，也就是說(shuō)我們?cè)谶\(yùn)行時(shí)想到拿到注入的任務(wù)，還需要將收集的任務(wù)注入到源碼中。
這里可以借助 AutoRegister 幫我們完成注入。
https://github.com/luckybilly/AutoRegister
注入前：
internal class FinalTaskRegister {
val taskList: MutableList<TaskInfo> = mutableListOf()
init {
init()
}
private fun init() {}
fun register(register: ModuleTaskRegister) {
register.register(taskList)
}
}
將收集到的任務(wù)注入到 init 方法中，注入后的字節(jié)碼：
/* compiled from: FinalTaskRegister.kt */
public final class FinalTaskRegister {
private final List<TaskInfo> taskList = new ArrayList();
public FinalTaskRegister() {
init();
}
public final List<TaskInfo> getTaskList() {
return this.taskList;
}
private final void init() {
register(new TaskRegister$sample_lib());
register(new TaskRegister$sample());
}
public final void register(ModuleTaskRegister register) {
Intrinsics.checkNotNullParameter(register, "register");
register.register(this.taskList);
}
}
我們通過(guò) APT 生成的類(lèi)已經(jīng)成功的注入到代碼中。
小結(jié)
至此，我們已經(jīng)完成了任務(wù)的收集，通過(guò) APT 和字節(jié)碼修改是常見(jiàn)的類(lèi)收集方案，相比反射，字節(jié)碼修改沒(méi)有任何性能的損失。
后來(lái)發(fā)現(xiàn) Google 已經(jīng)推出了新的注解處理框架 ksp，處理速度更快，于是果斷嘗試了一把，所以有兩種注解處理可以選擇，GitHub 上有詳細(xì)介紹。
5.任務(wù)調(diào)度
任務(wù)調(diào)度是啟動(dòng)框架的核心，大家可能聽(tīng)到過(guò)。
處理依賴(lài)任務(wù)首先要構(gòu)建一個(gè)「有向無(wú)環(huán)圖」。
什么是有向無(wú)環(huán)圖，看下維基百科的介紹：
在圖論中，如果一個(gè)有向圖從任意頂點(diǎn)出發(fā)無(wú)法經(jīng)過(guò)若干條邊回到該點(diǎn)，則這個(gè)圖是一個(gè)有向無(wú)環(huán)圖（DAG, Directed Acyclic Graph）。
聽(tīng)起來(lái)好像很簡(jiǎn)單，那么具體怎么實(shí)現(xiàn)呢，今天我們拋開(kāi)高級(jí)概念不談，用代碼帶大家實(shí)現(xiàn)任務(wù)的調(diào)度。
首先，需要把任務(wù)分為兩類(lèi)，有依賴(lài)的任務(wù)和無(wú)依賴(lài)的任務(wù)。
有依賴(lài)的首先檢查是否有環(huán)，如果有循環(huán)依賴(lài)，直接 throw，這個(gè)可以套用公式 —— 如何判斷鏈表是否有環(huán)。
如果沒(méi)有循環(huán)依賴(lài)，則收集每個(gè)任務(wù)的被依賴(lài)任務(wù)，我們稱(chēng)之為子任務(wù)，用于當(dāng)前任務(wù)執(zhí)行完成后，繼續(xù)執(zhí)行子任務(wù)。
無(wú)依賴(lài)的最簡(jiǎn)單，直接按照優(yōu)先級(jí)執(zhí)行即可。
不知道大家是否有疑問(wèn)：有依賴(lài)的任務(wù)什么時(shí)候啟動(dòng)？
有依賴(lài)的任務(wù)，依賴(lài)鏈的葉子端點(diǎn)一定是一個(gè)無(wú)依賴(lài)的任務(wù)，因此無(wú)依賴(lài)的任務(wù)執(zhí)行完成后，就可以開(kāi)始執(zhí)行有依賴(lài)的任務(wù)。
下面用一個(gè)小例子來(lái)介紹：
? A 依賴(lài) B、C
? B 依賴(lài) C
? C 無(wú)依賴(lài)
樹(shù)形結(jié)構(gòu)：
1. 分組并梳理子任務(wù)。
? 有依賴(lài)：
A: 無(wú)子任務(wù)
B: 子任務(wù): [A]
? 無(wú)依賴(lài)：
C: 子任務(wù): [A, B]
2. 執(zhí)行無(wú)依賴(lài)的任務(wù)C。
3. 更新已完成的任務(wù): [C]。
4. 檢查 C 的子任務(wù)是否可以執(zhí)行。
A: 依賴(lài) [B, C]，已完成任務(wù)中不包含 B，無(wú)法啟動(dòng)
B: 依賴(lài) [C]，已完成任務(wù)中包含 C，可以執(zhí)行
5. 執(zhí)行任務(wù) B。
6. 重復(fù)步驟 3，直到所有任務(wù)執(zhí)行完成。
下面我們就用代碼來(lái)實(shí)現(xiàn)：
使用遞歸檢查循環(huán)依賴(lài)：
private fun checkCircularDependency(
chain: List<String>,
depends: Set<String>,
taskMap: Map<String, TaskInfo>
) {
depends.forEach { depend ->
check(chain.contains(depend).not()) {
"Found circular dependency chain: $chain -> $depend"
}
taskMap[depend]?.let { task ->
checkCircularDependency(chain + depend, task.depends, taskMap)
}
}
}
梳理子任務(wù)：
task.depends.forEach {
val depend = taskMap[it]
checkNotNull(depend) {
"Can not find task [$it] which depend by task [${task.name}]"
}
depend.children.add(task)
}
執(zhí)行任務(wù)：
private fun execute(task: TaskInfo) {
if (isMatchProgress(task)) {
val cost = measureTimeMillis {
kotlin.runCatching {
(task.task as IInitTask).execute(app)
}.onFailure {
Log.e(TAG, "executing task [${task.name}] error", it)
}
}
Log.d(
TAG, "Execute task [${task.name}] complete in process [$processName] " +
"thread [${Thread.currentThread().name}], cost: ${cost}ms"
)
} else {
Log.w( TAG, "Skip task [${task.name}] cause the process [$processName] not match")
}
afterExecute(task.name, task.children)
}
如果進(jìn)程不匹配直接跳過(guò)。
繼續(xù)執(zhí)行下一個(gè)任務(wù)：
private fun afterExecute(name: String, children: Set<TaskInfo>) {
val allowTasks = synchronized(completedTasks) {
completedTasks.add(name)
children.filter { completedTasks.containsAll(it.depends) }
}
if (ThreadUtils.isInMainThread()) {
// 如果是主線程，先將異步任務(wù)放入隊(duì)列，再執(zhí)行同步任務(wù)
allowTasks.filter { it.background }.forEach {
launch(Dispatchers.Default) { execute(it) }
}
allowTasks.filter { it.background.not() }.forEach { execute(it) }
} else {
allowTasks.forEach {
val dispatcher = if (it.background) Dispatchers.Default else Dispatchers.Main
launch(dispatcher) { execute(it) }
}
}
}
如果子任務(wù)的依賴(lài)任務(wù)都已經(jīng)執(zhí)行完畢，就可以執(zhí)行了。
最后還需要提供一個(gè)啟動(dòng)任務(wù)的接口，為了支持多進(jìn)程，這里不能使用 ContentProvider。
小結(jié)
通過(guò)層層拆解，將復(fù)雜的依賴(lài)梳理清楚，用通俗易懂的方法，實(shí)現(xiàn)任務(wù)調(diào)度。
源碼
https://github.com/wangchenyan/init
另外，我也在 JitPack 上發(fā)布了 alpha 版本，歡迎大家嘗試:
kapt "com.github.wangchenyan.init:init-compiler:1-alpha.1"
implementation "com.github.wangchenyan.init:init-api:1-alpha.1"
詳細(xì)使用請(qǐng)移步 GitHub。
https://github.com/wangchenyan/init
總結(jié)
本文以 StartUp 作為引子，闡述依賴(lài)任務(wù)啟動(dòng)框架還需要具備哪些能力，通過(guò) APT + 字節(jié)碼注入進(jìn)行解耦，支持模塊化，通過(guò)一個(gè)簡(jiǎn)單的模型來(lái)表述任務(wù)調(diào)度具體的實(shí)現(xiàn)方式。
希望本文能夠讓大家了解依賴(lài)任務(wù)啟動(dòng)框架的核心思想，如果你有好的建議，歡迎評(píng)論。
參考
Kotlin + Flow 實(shí)現(xiàn)的 Android 應(yīng)用初始化任務(wù)啟動(dòng)庫(kù)
https://juejin.cn/post/6938229049462358047
為了失聯(lián)，歡迎關(guān)注我防備的小號(hào)
微信改了推送機(jī)制，真愛(ài)請(qǐng)星標(biāo)本公號(hào)??