上一篇文章我們了解到:框架會(huì)在編譯時(shí)動(dòng)態(tài)掃描
@RouterUri注解并生成注冊(cè)UriHandl到UriAnnotationHandler中的代碼窿春。那這些代碼在運(yùn)行時(shí)如何調(diào)用呢？
先了解一下ServiceLoader這個(gè)概念吧兔。WMRouter中的ServiceLoader類似于java spi
ServiceLoader
它的基本功能是:
- 保存接口與實(shí)現(xiàn)類的對(duì)應(yīng)關(guān)系滤蝠。 這個(gè)關(guān)系是一對(duì)多驳概。
- 可以實(shí)例化一個(gè)實(shí)現(xiàn)類若河，返回給調(diào)用方使用平道。
那在WMRouter中，SerciceLoader保存的接口與實(shí)現(xiàn)類的關(guān)系是哪些呢? 我們看一下ServiceLoader的初始化方法:
void doInit() {
Class.forName(“com.sankuai.waimai.router.generated.ServiceLoaderInit”).getMethod("init").invoke(null);
}
即初始化的時(shí)候反射調(diào)用了ServiceLoaderInit.init()方法恢总。我全局搜索了一下這個(gè)類并沒(méi)有發(fā)現(xiàn)它的聲明迎罗。
最后發(fā)現(xiàn)這個(gè)類是使用Gradle Transform API和ams庫(kù)動(dòng)態(tài)生成的。
接下來(lái)我們就來(lái)研究一下這個(gè)類是怎么生成的片仿，先來(lái)看一下WMRouter的gradle transform插件是如何生成ServiceLoaderInit這個(gè)類的。
WMRouterPlugin
官方是這樣描述它的作用的 : 將注解生成器生成的初始化類匯總到ServiceLoader.init尤辱，運(yùn)行時(shí)直接調(diào)用ServiceLoader.init砂豌。 從而完成SerciceLoader的初始化。
這里我大致描述一下這個(gè)插件的工作邏輯:
- 掃描編譯生成的class文件夾或者jar包的指定目錄 : com/sankuai/waimai/router/generated/service, 收集目錄下的類并保存起來(lái) (這個(gè)類其實(shí)就是
ServiceInit_xxx1這種類) - 使用
asm生成ServiceLoaderInit類class文件光督，這個(gè)class文件調(diào)用前面掃描到的類的init方法阳距。
即最終產(chǎn)生如下代碼：
public class ServiceLoaderInit {
public static void init() {
ServiceInit_xxx1.init();
ServiceInit_xxx2.init();
}
}
到這里就有疑問(wèn)了，從開始分析到現(xiàn)在我們并沒(méi)有看到ServiceInit_xxx1這種類是如何生成的呢结借。那它是在哪里生成的呢筐摘？
ServiceInit_xx的生成
在上一篇文章已經(jīng)了解到UriAnnotationProcessor在編譯時(shí)會(huì)掃描@RouterUri,并且會(huì)生成UriAnnotationInit_xx1這種類衅斩，UriAnnotationInit_xx1.init方法就是接收一個(gè)UriAnnotationHandler實(shí)例，然后調(diào)用它的register方法遭京。
其實(shí)UriAnnotationProcessor在掃描@RouterUri生成UriAnnotationInit_xx1類的同時(shí)雏门，還會(huì)生成一個(gè)類,就是ServiceInit_xx:
//UriAnnotationProcessor.java
public void buildHandlerInitClass(CodeBlock code, String genClassName, String handlerClassName, String interfaceName) {
.... // 生成 UriAnnotationInit_xx1 代碼
String fullImplName = Const.GEN_PKG + Const.DOT + genClassName;
String className = "ServiceInit" + Const.SPLITTER + hash(genClassName);
new ServiceInitClassBuilder(className)
.putDirectly(interfaceName, fullImplName, fullImplName, false)
.build();
}
我們看一下ServiceInitClassBuilder的putDirectly和build方法:
public class ServiceInitClassBuilder {
...
public ServiceInitClassBuilder putDirectly(String interfaceName, String key, String implementName, boolean singleton) {
builder.addStatement("$T.put($T.class, $S, $L.class, $L)",
serviceLoaderClass, className(interfaceName), key, implementName, singleton);
return this;
}
public void build() {
MethodSpec methodSpec = MethodSpec.methodBuilder(Const.INIT_METHOD)
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(TypeName.VOID)
.addCode(this.builder.build())
.build();
TypeSpec typeSpec = TypeSpec.classBuilder(this.className)
.addModifiers(Modifier.PUBLIC)
.addMethod(methodSpec)
.build();
JavaFile.builder(“com.sankuai.waimai.router.generated.service”, typeSpec)
.build()
.writeTo(filer);
}
其實(shí)就是會(huì)把下面代碼生成到com/sankuai/waimai/router/generated/service文件夾下:
public class ServiceInit_xx1 {
public static void init() {
ServiceLoader.put(IUriAnnotationInit.class, "com.xxx.UriAnnotationInit_xx1", com.xx.UriAnnotationInit_xx1.class, false);
}
}
可以看到 ServiceInit_xx1.init的作用就是把接口與實(shí)現(xiàn)類的關(guān)系保存到ServiceLoader中。
WMRouter的transform插件會(huì)掃描com/sankuai/waimai/router/generated/service下的類馍管。即會(huì)掃描到ServiceInit_xx1這個(gè)類郭赐，然后按照剛開始所說(shuō)的生成調(diào)用其init()的代碼:
public class ServiceLoaderInit {
public static void init() {
ServiceInit_xxx1.init();
ServiceInit_xxx2.init();
}
}
綜上所述，ServiceLoaderInit.init被調(diào)用后确沸，SerciceLoader中就保存了IUriAnnotationInit的接口實(shí)現(xiàn)類UriAnnotationInit_xx1捌锭。
接下來(lái)的問(wèn)題就是IUriAnnotationInit的實(shí)現(xiàn)類UriAnnotationInit_xx1的init方法在什么時(shí)候調(diào)用呢 ？
UriAnnotationInit_xx1.init的調(diào)用時(shí)機(jī)
其實(shí)UriAnnotationInit_xx1.init就是為了把前面經(jīng)過(guò)UriAnnotationProcessor生成的路由節(jié)點(diǎn)信息注冊(cè)到UriAnnotationHandler中罗捎。我們來(lái)看一下UriAnnotationHandler的初始化方法:
protected void initAnnotationConfig() {
RouterComponents.loadAnnotation(this, IUriAnnotationInit.class);
}
上面的代碼最終會(huì)調(diào)用到這里:
List<? extends AnnotationInit<T>> services = ServiceLoader.load(clazz).getAll();
for (AnnotationInit<T> service : services) {
service.init(handler);
}
即會(huì)通過(guò)SerciceLoader來(lái)獲取IUriAnnotationInit的實(shí)現(xiàn)類观谦，并調(diào)用其init方法。
前面我們已經(jīng)分析過(guò)了SerciceLoader在初始化時(shí)桨菜，就已經(jīng)把IUriAnnotationInit與其實(shí)現(xiàn)類的關(guān)系保存起來(lái)了坎匿。所以上面的service.init(handler)實(shí)際上就是調(diào)用下面的代碼
//IUriAnnotationInit的實(shí)現(xiàn)類
public class UriAnnotationInit_xx1 implements IUriAnnotationInit {
public void init(UriAnnotationHandler handler) {
handler.register("", "", "/jump_activity_1", "com.sankuai.waimai.router.demo.basic.TestBasicActivity", false);
}
結(jié)合我們前面所了解的，這樣UriAnnotationHandler就生成了用于處理被@RouterUri標(biāo)記的頁(yè)面的UriHandlder雷激。 為了便于理解替蔬，我們用下面這張圖總結(jié)一下上面的過(guò)程:
ServiceLoader中更強(qiáng)大的功能
其實(shí)上面利用ServiceLoader來(lái)加載一個(gè)接口的實(shí)現(xiàn)類這個(gè)功能,WMRouter這個(gè)框架已經(jīng)把它單獨(dú)抽取出來(lái)了。即利用SerciceLoader可以跨模塊加載一個(gè)接口的實(shí)現(xiàn)類屎暇。我們看一下怎么使用
@RouterService
java 中的spi機(jī)制需要我們?cè)?META-INF/services規(guī)范好接口與實(shí)現(xiàn)類的關(guān)系承桥，WMRouter中提供@RouterService,來(lái)簡(jiǎn)化了這個(gè)操作。舉個(gè)例子 :
比如在一個(gè)項(xiàng)目中有3個(gè)庫(kù): interface根悼、lib1凶异、lib2
//定義在interface庫(kù)中
public abstract class LibraryModule {
public abstract String getModuleName();
}
//定義在lib1中
@RouterService(interfaces = LibraryModule.class)
public class LibraryModule1 extends LibraryModule {
}
//定義在lib2
@RouterService(interfaces = LibraryModule.class)
public class LibraryModule2 extends LibraryModule {
}
WMRouter中有一個(gè)ServiceAnnotationProcessor負(fù)責(zé)處理RouterService注解，它會(huì)把標(biāo)記了這個(gè)注解的類挤巡，生成ServiceInit_xx, 即
public class ServiceInit_f3649d9f5ff15a62b844e64ca8434259 {
public static void init() {
ServiceLoader.put(IUriAnnotationInit.class, "xxx",xxx.class, false);
}
}
這樣再由WMRouter的插件轉(zhuǎn)換生成 ServiceLoaderInit.init()中的調(diào)用代碼剩彬。就達(dá)到在運(yùn)行時(shí)把LibraryModule的實(shí)現(xiàn)注入到SerciceLoader中，從而我們可以獲得不同庫(kù)的實(shí)現(xiàn)矿卑。
歡迎Star我的Android進(jìn)階計(jì)劃,看更多干貨喉恋。
