Android组件化最佳实践 ARetrofit原理

本文首发于 vivo互联网技术 微信公众号
作者：朱壹飞

简介

ARetrofit 是一款针对Android组件之间通信的路由框架，实现快速组件化开发的利器。

源码链接：

组件化架构 APP Demo, ARetrofit 使用实例

 

组件化

Android组件化已经不是一个新鲜的概念了，出来了已经有很长一段时间了，大家可以自行Google，可以看到一堆相关的文章。

简单的来说，所谓的组件就是Android Studio中的Module，每一个Module都遵循高内聚的原则，通过ARetrofit来实现无耦合的代码结构，如下图：

每一个Module可单独作为一个project运行，而打包到整体时Module之间的通信通过ARetrofit完成。

 

ARetrofit原理

讲原理之前，我想先说说为什么要ARetrofit。开发ARetrofit这个项目的思路来源其实是Retrofit，Retrofit是Square公司开发的一款针对Android网络请求的框架，这里不对Retrofit展开来讲。主要是Retrofit框架使用非常多的设计模式，可以说Retrofit这个开源项目将Java的设计模式运用到了极致，当然最终提供的API也是非常简洁的。如此简洁的API，使得我们APP中的网络模块实现变得非常轻松，并且维护起来也很舒服。因此我觉得有必要将Android组件之间的通信也变得轻松，使用者可以优雅的通过简洁的API就可以实现通信，更重要的是维护起来也非常的舒服。

ARetrofit基本原理可以简化为下图所示：

1. 通过注解声明需要通信的Activity／Fragment或者Class

2. 每一个module通过annotationProcessor在编译时生成待注入的RouteInject的实现类和AInterceptorInject的实现类。
   这一步在执行app[build]时会输出日志，可以直观的看到，如下图所示：

    

3. 将编译时生成的类注入到RouterRegister中，这个类主要用于维护路由表和拦截器，对应的[build]日志如下：

    
4. Routerfit.register(Class service) 这一步主要是通过动态代理模式实现接口中声明的服务。

前面讲的是整体的框架设计思想，便于读者从全局的觉得来理解ARetrofit的框架的架构。接下来，将待大家个个击破上面提到的annotationProcessor、 transform在项目中如何使用，以及动态代理、拦截器功能的实现等细节。

 

一、annotationProcessor生成代码

annotationProcessor(注解处理器)是javac内置的一个用于编译时扫描和处理注解(Annotation)的工具。简单的说，在源代码编译阶段，通过注解处理器，我们可以获取源文件内注解(Annotation)相关内容。Android Gradle 2.2 及以上版本提供annotationProcessor的插件。

在ARetrofit中annotationProcessor对应的module是auto-complier，在使用annotationProcessor之前首先需要声明好注解。关于注解不太了解或者遗忘的同学可直接参考我之前写的Java注解这篇文章，本项目中声明的注解在auto-annotation这个module中，主要有：

• @Extra 路由参数
• @Flags intent flags
• @Go 路由路径key
• @Interceptor 声明自定义拦截器
• @RequestCode 路由参数
• @Route路由
• @Uri
• @IMethod 用于标记注册代码将插入到此方法中(transform中使用)
• @Inject 用于标记需要被注入类，最近都将插入到标记了#com.sjtu.yifei.annotation.IMethod的方法中(transform中使用)

创建自定义的注解处理器，具体使用方法可参考利用注解动态生成代码，本项目中的注解处理器如下所示：

生成代码的关键部分在GenerateAInterceptorInjectImpl 和 GenerateRouteInjectImpl中，以下贴出关键代码：

二、Transform

Android Gradle 工具在 1.5.0 版本后提供了 Transfrom API, 允许第三方 Plugin在打包dex文件之前的编译过程中操作 .class 文件。这一部分面向高级Android工程师的，面向字节码编程，普通工程师可不做了解。

写到这里也许有人会有这样一个疑问，既然annotationProcessor这么好用为什么还有Transform面向字节码注入呢？这里需要解释以下，annotationProcessor具有局限性，annotationProcessor只能扫描当前module下的代码，且对于第三方的jar、aar文件都扫描不到。而Transform就没有这样的局限性，在打包dex文件之前的编译过程中操作.class 文件。

关于Transfrom API在Android Studio中如何使用可以参考Transform API?—?a real world example，顺便提供一下字节码指令方便我们读懂ASM。

本项目中的Transform插件在AInject中，实现源码TransformPluginLaunch如下，贴出关键部分：

注入代码一般分为两个步骤：

• 第一步：扫描
  这一部分主要是扫描的内容有：
  注入类和方法的信息，是AutoRegisterContract的实现类和其中@IMethod，@Inject的方法。
  待注入类的和方法信息，是RouteInject 和 AInterceptorInject实现类且被@Inject注解的。

• 第二步：注入
  以上扫描的结果，将待注入类注入到注入类的过程。这一过程面向ASM操作，可参考字节码指令来读懂以下的关键注入代码：

三、动态代理

定义：为其它对象提供一种代理以控制对这个对象的访问控制；在某些情况下，客户不想或者不能直接引用另一个对象，这时候代理对象可以在客户端和目标对象之间起到中介的作用。

Routerfit.register(Class service) 这里就是采用动态代理的模式，使得ARetrofit的API非常简洁，使用者可以优雅定义出路由接口。关于动态代理的学习难度相对来说还比较小，想了解的同学可以参考这篇文章java动态代理。

本项目相关源码：
这里ServiceMethod是一个非常重要的类，使用了外观模式，主要用于解析方法中的被注解所有信息并保存起来。

四、拦截器链实现

本项目中的拦截器链设计，使得使用者可以非常优雅的处理业务逻辑。如下：

这一部分实现的思想是参考了okhttp中的拦截器，这里使用了java设计模式责任链模式，具体实现欢迎阅读源码。

总结

基本上读完本文可以对ARetrofit的核心原理有了很清晰的理解，简单来说ARetrofit通过annotationProcessor在编译时获取路由相关内容，通过ASM实现了可跨模块获取对象，最终通过动态代理实现面向切面编程(AOP)。

ARetrofit相对于其他同类型的路由框架来说，其优点是提供了更加简洁的API，其中高阶用法对开发者提供了更加灵活扩展方式，开发者还可以结合RxJava完成复杂的业务场景。具体可以参考ARetrofit的基本用法，以及Issues。

参考

Java注解

利用注解动态生成代码

Transform API?—?a real world example

字节码指令