探索Android路由框架-ARouter之深挖源码(二)

  1. 云栖社区>
  2. 博客>
  3. 正文

探索Android路由框架-ARouter之深挖源码(二)

小猪看流星 2018-05-14 18:08:00 浏览634
展开阅读全文

本文已独家授权 郭霖 ( guolin_blog ) 公众号发布!

在《 探索Android路由框架-ARouter(一)》中,主要介绍了ARouter框架的基本配置、多种跳转方案、拦截器的使用等。这一篇文章主要是对该框架的源码进行分析:    

ARouter是通过APT生成代码在框架内部进行操作,那么,项目编译生成的文件位置在那里?

img_8689b51f5ea0d6b91879b0e8d7c2962a.png
项目编译生成的文件位置  

既然生成了这些源码,我们就先随便点点看看这些都是啥?

img_3697c3bdff99a826192eacf2cc93e829.png
源码 - 1
img_7fed86387d80aeba695d7bfa4e408441.png
源码 - 2
img_66227fb1924179a5dfc2bc9684637cca.png
源码 - 3
img_652ecd2beb15d241682b056c11e729ba.png
源码 - 4

这里简简单单随便截图了APT生成的部分源码,是不是感觉跟上一篇文章使用到的代码很多相似性呐~比如拦截器的优先级是1、跳转匹配的路径也是一样的、跳转传递的参数、定义的组名等等。既然这么多一样的那肯定是在内部某部分进行封装使用,带着这个问题我们开始逐步分析。

首先,我们从该框架使用到的注解开始分析(因为注解是使用这个框架的起点)

注解分析:

首先,我们知道要使用ARouter的首先需要在类的注释上面写上 @Route 这个注解,点进源码看看

img_f2b1fb8d2ce53f1378e61fd20454eca6.png
Route注解

使用该注解标注的类将被自动添加至路由表中。而且,ARouter 并非仅提供页面(Activity)的路由功能,还可以用来路由模块想要暴露给其他模块调用的接口。也就是说 @Route 不仅可用于 Activity 类,还可用于模块对外接口的实现类。那么具体它可以实现那些类型?

从上面的源码1、2、3、4截图可以看到,除了拦截器,里面通过实现接口重写方法,方法里面都有一个RouteMeta,那么我们点进去RouteMeta这个类看看:

img_0b3e829d834db6f939c8c9fd9034d68a.png
RouteMeta

其中红色矩形中的类注释一目了然、翻译过来: 它包含基本路由信息。

截图中蓝色的矩形,RouteType,就是路由的类型。那么,这款路由框架的具体路由类型又有那些?带着这个疑问,点进RouteType 源码看看。

img_157677a24b6d07763ead1b6991514bca.png
RouterType

首先这是一个枚举,这些就是框架可以具体使用到的路由类型

说完Route 这个注解,我们在来看看@Interceptor 拦截器注解,

img_fd1ec1431987f08663bf642debeb522b.png
Interceptor 注解

哦,我们发现拦截器的注解就2个方法,第一个是定义优先级的,第二个就是拦截器的名字。

接着,@Autowired 注解:

img_749fbf5bfaabc899f11ddc99051ec13d.png

我们知道这个注解是界面跳转时参数传递用的。Activity 中使用该注解标志的变量,会在页面被路由打开的时候自动赋予传递的参数值。赋值的操作可以参考上面的源码 - 4截图。

初始化分析:

我们知道,ARouter框架使用的第一个步骤,是要先初始化,也就是调用:ARouter.init( Application.this );这个API,那么,它的初始化究竟是做了那些东西?我们先点进源码看看:

img_d09122dc97fb80126bc659bd71142298.png
ARouter.init()

那么,实际上它调用的是绿色矩形内的代码,绿色矩形内有两个初始化,一个是 _ARouter.init(application),还有一个是 _ARouter.afterInit( )

我们首先点进 _ARouter . init()看看,

img_9c6f37ef85382f5c72414e238d3565fa.png
 _ARouter

A:红色箭头的是类注释,翻译过来就是:ARouter核心( 外观模式 )

B:绿色箭头代表的是一个线程池,对线程池概念不是很清楚的朋友可以点进 必须要理清的Java线程池 先了解一下

C:蓝色箭头代表的是 这个_ARouter init()实际是调用的LogisticsCenter里面的init方法。

首先,什么是外观模式?

简单点理解就是,通过创建一个统一的类,用来包装子系统中一个或多个复杂的类,客户端可以通过调用外观类的方法来调用内部子系统中所有方法。大概意思就是这样,想深入理解的话可以自行查阅资料。

其次,这个线程池做了什么功能?

点进去DefaultPoolExecutor这个类看看:

img_1d34788a7c74096183c76c67b7f81ba3.png
DefaultPoolExecutor

由源码得知就是创建了一个数组阻塞队列的线程池

最后,我们点进LogisticsCenter,看看里面的init方法执行了什么操作(因为源码太长,我就分别截图)

img_93cd697810c92dc02c92fd32d417d148.png
LogisticsCenter - init (1)
img_dc4d048895d807baa247a60a7b8813d9.png
LogisticsCenter - init (2)

通过LogisticsCenter - init(1)这幅源码图可以得知:如果是Debug模式,则执行从if代码块; 如果是Release模式:通过PackageUtils.isNewVersion(context)判断当前应用是否是第一次启动。接着,获取arouter-compiler生成的文件,然后将该文件,存储在sp中,下次启动应用的时候,直接从sp缓存中读取。

然后,在LogisticsCenter - init(2)红色矩形的代码块可以得知:首先遍历arouter-compiler生成的文件,将他们按照类型分别存储到Warehouse的对应字段中。也就是,如果类名前缀符合文件拼接规则,比如为com.alibaba.android.arouter.routes.ARouter$$Root的文件,就将其添加到具体的Warehouse里面的集合中。也就是对应的这里

img_e4b1a147b2bdf78fe0cd44cd179bf9aa.png
对应的文件

那么,这个文件拼接规则(也就是字符串拼接)是?

img_223fd0c01b0c57f1c4746de584aad10b.png
文件拼接规则

Warehouse又是什么?点进源码看看

img_8189c069357030de4f8c79bb8536d176.png
Warehouse

其中,Warehouse的类注释写的非常好,翻译过来就是:路由元数据和其他数据的存储。这个类本质就是路由文件映射表。里面提供了各种HashMap集合(Map不允许重复的key),去存储SP存储的值。

我们再看看这里存储拦截器的集合,UniqueKeyTreeMap,这个类是存储拦截器的,我们看看它做了什么?

img_0b4c0c8685ef1c1151a89d6064f7318f.png
UniqueKeyTreeMap

原来,这个UniqueKeyTreeMap,就是继承了TreeMap,哦,我们知道TreeMap是一种有序的集合(底层帮我们排序)所以数值越小,它就优先添加拦截器。这样也就解释了为什么拦截器属性值设置的越低,优先级越高。

综上,针对 _ARouter init( ) 这个初始化的源码我们可以得知以下:

A:初始化这一操作,表面上是_ARouter ,实则是LogisticsCenter 在帮我们管理逻辑

B:LogisticsCenter 内部通过先存储SP,然后遍历、匹配(满足条件则添加到具体的集合中,按照文件的前缀不同,将他们添加到路由映射表Warehouse的groupsIndex、interceptorsIndex、providersIndex 中)

C:具体的路由清单是Warehouse ,不仅保存实例,还给我们提供了缓存。也就是说 同一个目标(RouteMeta、IProvider、IInterceptor)仅会在第一次使用的时候创建一次,然后缓存起来。后面都是直接使用的缓存。

初始化还有一个API,_ARouter.afterInit( ) ; 这个API在上面的截图也有,那么这个API是用来干什么的?我们点进去看看。

img_2f59d53f683960b0e9d5e97b05646481.png
_ARouter.afterInit

首先,它实例化了一个InterceptorService。这里的InterceptorService下面会说。 这里的build方法,最终返回的是一个Postcard对象:

img_a417fe70f6556286c564767cbeeec0d8.png
build

从源码可以得知,实际上它返回的却是,_ARouter.getInstance().build(path)这个方法,这个方法是一个方法重载(一般用的最多的就是这一个,也就是默认分组,不进行自定义分组),跟进去看看(源码很长,分为以下两个截图):

img_ee92d4f869d4cb4e4df71c0b699f6496.png
_ARouter.getInstance().build - 1
img_b511c6a1dc5521c7438b0826a1dc949d.png
_ARouter.getInstance().build - 2

发现这里有一个PathReplaceService(也就是红色矩形),这个PathReplaceService又是什么,点进去看看

img_03b1c4f12d6bf2aa40f2452b8670ecad.png
PathReplaceService

这个类注释翻译过来就是:预处理路径。这个接口是IProvider的子类

让我们在看回绿色箭头,其中,navigation(clazz)这种方式是属于根据类型查找,而build(path)是根据名称进行查找。如果应用中没有实现PathReplaceService这个接口,则pService=null。PathReplaceService可以对所有的路径进行预处理,然后返回一个新的值(返回一个新的String和Uri)。绿色箭头有一个extractGroup()方法,点进去看看:

img_cf0162660897eaba204f432be006ae9b.png
extractGroup

extractGroup(path)这个方法,核心逻辑是红色矩形内的代码,这个方法主要是获取分组名称。切割path字符串,默认为path中第一部分为组名。这就证明了如果我们不自定义分组,默认就是第一个分号的内容。

分析完了build,我们在看看navigation

img_c9a4d7d71379e98a7ba3e111a9d5b4ae.png
navigation

继续点进源码看看,发现进入了_ARouter这个类里面的navigation方法:

img_8e965e197e7bed60990d6ce94969e452.png
navigation - 1
img_0a703a56a852242ba63e833498bfc657.png
navigation - 2

其中,navigation - 1这幅图中的红色矩形代表的意思是,如果(两个)路径没写对,ARouter会Toast提示客户端,路径不对。

navigation - 2这幅图中的红色矩形代表的是忽略拦截器。interceptorService实例化对象的时机,是在_ARouter这类中的afterInit( )进行实例化的。这幅图中的蓝色矩形和箭头的方法真实逻辑是调用了下图的方法:

img_231100fe693dd497b82452eaa545dbed.png
img_c9e023b807ba7016e7a60251d1e37d74.png

通过这段代码我们可以得知:

1:如果navigation()不传入Activity作为context,则使用Application作为context

2:内部使用了Intent来进行传递

3:如果在跳转时,设置了flags,且没有设置Activity作为context,则下面的startActivity()方法会发生错误,因为缺少Activity的Task栈;

4:Fragment的判断根据版本不同进行了相应的判断

看到了这里,我们在看回navigation - 2这幅图。如果(两个)路径匹配的话,会执行到截图中的蓝色矩形,点进蓝色矩形里面去看看(也就是 LogisticsCenter.completion( Postcard )):

img_c20047ca798a8a3650f32cb5df94d85e.png
LogisticsCenter.completion - 1
img_bb1b0a15b98eaa2c57d124fbf30e78a6.png
LogisticsCenter.completion - 2
img_92cb1627041e86befe0fb9ca912af78e.png
LogisticsCenter.completion - 3

首先,根据path在Warehouse.routes映射表中查找对应的RouteMeta。但是,第一次加载的时候,是没有数据的。(而第一次加载是在LogisticsCenter.init()中,上面也说了。因此只有`Warehouse`的`groupsIndex、interceptorsIndex、providersIndex` 有数据),因此这个时候routeMeta=null。所以,这个时候会先从Warehouse.groupsIndex中取出类名前缀为com.alibaba.android.arouter.routes.ARouter$$Group$$group的文件;接着,将我们添加@Route注解的类映射到Warehouse.routes中;然后将已经加载过的组从Warehouse.groupsIndex中移除,这样也避免了重复添加进Warehouse.routes;注意,这个时候Warehouse.routes已经有值了,所以重新调用本方法(completion(postcard))执行了else代码块。

然后,LogisticsCenter.completion - 2 图中就是具体的设置属性值;然后在 LogisticsCenter.completion - 3 图中,对 IProvider的子类进行初始化 provider.init(mContext); 初始化完毕以后,将IProvider的子类添加进Warehouse.providers中;最后将IProvider的实现类保存在postcard中,因此可以从postcard获取IProvider的实例对象,其中,greenChannel()会忽略拦截器这个前面也说了。

小结:

在LogisticsCenter.completion这个方法里面完成了对Warehouse.providers、Warehouse.routes的赋值。那么Warehouse.interceptors又是在哪里赋值的呢?

IProvider有个子类接口,InterceptorService(在文章的上面,也简单提到过这个接口)

img_2356838e4a29319217752777685eff34.png
InterceptorService

因此InterceptorServiceImpl也是IProvider的子类;在LogisticsCenter.completion()中,有provider.init(context)的初始化 ;那么,我们看看InterceptorServiceImpl这个拦截器的实现类,

img_0738f8a2ee5f63ec0e1f8d1c8e8022c6.png
InterceptorServiceImpl

在InterceptorServiceImpl这个类里面的红色矩形中,完成了具体拦截器的初始化以及将拦截器添加到Warehouse.interceptors映射表中。

写到这里,ARouter框架的源码基本上就分析完毕了。可能你说,这不是只是初始化嘛,是的这只是初始化,但是界面跳转的源码都涵盖在上面了,你可能不信,我们点击跳转的API去看看:

img_145f2cfae426e3bb3152d6a9ccf499dd.png
简单跳转

点击build,又跳进熟悉的build里面来了:

img_61d37d3d0fcab5d041d2a5a4d643cc0b.png
build

同样,点击navigation,也回到了上面的navigation中去了。

源码基本上就写到这里,内容有点绕。个人建议自己对着源码好好过一遍,这样理解的效果可能会比较好。

如果觉得这篇文章对你有帮助,希望点下一个小小的star,谢谢。

Ps:著作权归作者所有,转载请注明作者, 商业转载请联系作者获得授权,非商业转载请注明出处(开头或结尾请添加转载出处,添加原文url地址),文章请勿滥用、开源项目仅供学习交流、也希望大家尊重笔者的劳动成果,谢谢。

网友评论

登录后评论
0/500
评论
小猪看流星
+ 关注