背景問題
我們在組件化的過程商佛，業(yè)務(wù)被拆分至獨立的Module中，一些公用組件會在各個Module中通過APT生成一些需要被注冊至組件中的信息類整葡，比如EventBus生成的Index類件余。我們這邊RN定制的Plugin是跟隨各自module，需要被注冊掘宪。還有蛾扇，各Module對外提供的api接口的話，也需要被注冊魏滚。
另外镀首，有些組件為某些Module特有，需要在App啟動的時候就要初始化鼠次，有些需要在主線程中初始化更哄，有些為不阻塞主線程可以在非主線程中初始化芋齿。
在組件化之前，我們是在Main Module通過硬編碼來進行注冊成翩，在Application中堆積各個組件的初始化邏輯觅捆。
有沒有更好的解決方式？
解決思路
首先麻敌，將問題分解抽象：
-
把注冊行為進行抽象化栅炒，可以把一個類（需要被注冊的信息）看作方法函數(shù)的入?yún)ⅲ欠椒ê瘮?shù)就可以看作是對注冊相關(guān)邏輯的實現(xiàn)术羔。那注冊問題可以進一步轉(zhuǎn)化為各模塊如何把相關(guān)類（需要被注冊的信息）轉(zhuǎn)化為方法函數(shù)的入?yún)⒂蓿M件定義方法函數(shù)，獲取入?yún)韺崿F(xiàn)注冊邏輯级历。比如：
A a = new A() B b = new B() b.shoot(a.get()) A為Module定義的一個類释移，通過get方法可以獲得被注冊的信息，B為組件定義的一個類寥殖，在shoot方法中實現(xiàn)注冊邏輯玩讳。 -
接下來的問題是，AB分處不同模塊嚼贡，如何把AB按上述代碼邏輯組合起來熏纯？
AB組合意味著需要代碼注入，代碼注入使用的技術(shù)方案是Gradle Transform + ASM编曼。AB分別實現(xiàn)約定的接口豆巨，再用注解標記。在編譯時掐场，通過Gradle Transform + ASM往扔，通過注解找到AB，生成上述格式的代碼并注入到合適的位置熊户。
-
剩下的問題就是萍膛，在什么位置注入？
采用的方式是預(yù)先定義一個空方法嚷堡，通過注解標記蝗罗，并在適當時機調(diào)用這個空方法。在編譯時通過注解找到AB和空方法蝌戒，生成上述格式的代碼并注入到這個空方法中串塑。
以上是有關(guān)組件注冊方面的解決思路，而模塊中的組件初始化有點不同北苟，因為其不需要入?yún)ⅰ?但可以直接在方法函數(shù)中實現(xiàn)初始化邏輯桩匪，比如：
A a = new A()
a.shoot()
模塊定義一個類A，實現(xiàn)約定的接口友鼻，在shoot方法中做實現(xiàn)初始化邏輯傻昙。
其余和組件注冊方式相類似闺骚，主要在注入的代碼邏輯上有所不同。
設(shè)計模型
具體的實現(xiàn)方式其實是借鑒了弓箭耙的模式妆档。
弓箭耙模式:
-
箭 Arrow：對應(yīng)一種型號
提供模塊相關(guān)類（需要被注冊的信息）的載體僻爽。
-
弓 Bow：適配一種型號的箭，射向唯一的耙贾惦。
方法函數(shù)胸梆，即實現(xiàn)注冊邏輯的載體。
-
耙 Target：位置
將被注入的空方法须板。
介紹AutoInject
使用方式
在根項目的build.gradle中添加插件依賴：
buildscript {
...
dependencies {
...
classpath 'com.eastwood.tools.plugins:auto-inject:1.0.0'
}
}
在模塊的build.gradle中添加注解庫依賴：
dependencies {
...
implementation 'com.eastwood.common:auto-inject:1.0.0'
}
在主模塊的build.gradle中引用插件：
apply plugin: 'auto-inject'
autoInject {
showLog = true
ignorePackages = ['android', 'com/google'] // 忽略一些包名乳绕，提升查詢效率
}
@AutoTarget
預(yù)先定義一個空方法并調(diào)用，在方法上標記@AutoTarget逼纸，例如：
public class App extends Application {
public EventBusBuilder eventBusBuilder;
@Override
public void onCreate() {
super.onCreate();
eventBusBuilder = EventBus.builder();
// add config to eventBusBuilder
addIndex2EventBus();
eventBusBuilder.build();
}
@AutoTarget
void addIndex2EventBus() {}
}
addIndex2EventBus 方法將被注入代碼。
@AutoArrow
新建一個類济蝉，并實現(xiàn)IAutoArrow接口杰刽，在get方法中返回需要被注冊的信息類。例如：
@AutoArrow(model = "eventBusIndex")
public class ModuleBAutoArrow implements IAutoArrow<SubscriberInfoIndex> {
@Override
public SubscriberInfoIndex get() {
return new ModuleBEventBusIndex();
}
}
@AutoBow
新建一個類王滤，并實現(xiàn)IAutoBow接口贺嫂，在shoot方法中獲取入?yún)⒉?zhí)行具體的注冊邏輯。例如：
@AutoBow(target = "addIndex2EventBus", model = "eventBusIndex", context = true)
public class EventBusAutoBow implements IAutoBow<SubscriberInfoIndex> {
private App app;
EventBusAutoBow(Application application) {
app = (App) application;
}
@Override
public void shoot(SubscriberInfoIndex index) {
app.eventBusBuilder.addIndex(index);
}
}
其中 context 用于聲明EventBusAutoBow被實例化時是否需要上下文雁乡，這個上下文是被@AutoTarget標記的方法在運行時的上下文第喳。為 true時，該類需定義一個以上下文做為唯一入?yún)⒌臉?gòu)造函數(shù)踱稍。
@AutoBowArrow
新建一個類曲饱，并實現(xiàn)IAutoBowArrow接口，在shoot方法中執(zhí)行相關(guān)邏輯珠月。
@AutoBowArrow(target = "init")
public class InitAutoBowArrow implements IAutoBowArrow {
@Override
public void shoot() {
// ...
}
}
兩種組合方式
@AutoArrow + @AutoBow + @AutoTarget扩淀，三者關(guān)系為 n:1:1
@AutoBowArrow + @AutoTarget ，兩者比例關(guān)系為 1:1
編譯后啤挎，被注入的代碼樣式
打包成apk后驻谆，@AutoTarget標記的方法將會被注入具有固定結(jié)構(gòu)的代碼，例如：
// @AutoArrow + @AutoBow + @AutoTarget 組合
@AutoTarget
void addIndex2EventBus() {
ModuleBAutoArrow moduleBAutoArrow = new ModuleBAutoArrow();
EventBusAutoBow eventBusAutoBow = new EventBusAutoBow(this);
eventBusAutoBow.shoot(moduleBAutoArrow.get());
...
eventBusAutoBow.shoot(***.get());
}
// @AutoBowArrow + @AutoTarget 組合
@AutoTarget
void init() {
InitAutoBowArrow initAutoBowArrow = new InitAutoBowArrow();
initAutoBowArrow.shoot();
...
}
結(jié)語
本文并沒有詳細深入解釋Gradle Transform + ASM如何查找到類和方法并注入庆聘，源碼已上傳至github胜臊，方便自行研究。 github地址：https://github.com/EastWoodYang/AutoInject
