嗨,我是哈利迪~《看完不忘系列》将以从树干到细枝
的思路分析一些技术框架,本文将对开源项目Retrofit
进行介绍。
本文约2800字,阅读大约8分钟。
Retrofit源码基于最新版本2.9.0
预备
Retrofit使得网络调用可以像RESTful设计风格一样简洁,如:
1 | interface WanApi { |
又如,后端的Spring Boot框架通过约定大于配置
思想省去了很多配置,其在网络接口RestController上也运用了这种风格,
1 |
|
Retrofit的底层网络实现基于okhttp,自身的类不是很多,最核心的点就是动态代理
了。代理模式
简单来说,就是为对象提供一个增强
或控制其访问
的代理。下面我们先来了解下静态代理
和动态代理
~
静态代理
编译期就完成代理
- 源码级:手动编写代理类、APT生成代理类
- 字节码级:编译期生成字节码、
举个栗子,
1 | interface 赚钱 { |
为什么代理类
和委托类
要实现相同接口?是为了尽可能保证代理类
的内部结构和委托类
一致,这样对代理类
的操作都可以转移到委托类
上,代理类
只关注增强
和控制
。
动态代理
运行期生成字节码,如Proxy.newProxyInstance、CGLIB
Proxy.newProxyInstance是java自带,只能对接口代理(因为生成的类已经继承了Proxy,java没法多继承)
CGLIB则更强大,还能对普通类代理,底层基于ASM(ASM使用类似SAX解析器逐行扫描来提高性能)
举个栗子,
1 | class 合作标准 implements InvocationHandler { |
通过栗子可以看出,动态代理
不需要提前创建具体的代理类(如经纪人
或经纪公司
)去实现赚钱
接口,而是先拟一份合作标准
(InvocationHandler),等到运行期才创建代理类$Proxy0
(字节码),然后反射创建其实例商务拓展
,这样显得更为灵活。
了解完动态代理
,就可以开始Retrofit之旅了~
树干
简单使用
引入依赖,
1 | implementation 'com.squareup.okhttp3:okhttp:3.14.9' |
定义接口WanApi
,
1 | interface WanApi { |
发起请求,
1 | class RetrofitActivity extends AppCompatActivity { |
实现原理
由于Retrofit底层基于okhttp,哈迪在《看完不忘系列》之okhttp已经对网络流程做了分析,所以本文忽略网络实现只关注Retrofit自身的一些处理,Retrofit对象的构建就是简单的builder模式,我们直接看create,
1 | //Retrofit.java |
Proxy.newProxyInstance动态代理,运行期会生成一个类(字节码)如$ProxyN
,实现传入的接口即WanApi
,重写接口方法然后转发给InvocationHandler的invoke,如下(伪代码),
1 | class $ProxyN extends Proxy implements WanApi{ |
我们先看validateServiceInterface验证逻辑,
1 | //Retrofit.java |
如果开了validateEagerly,会一次性把接口WanApi
的所有方法都检查一遍并加载进来,可以在debug模式下开启,提前发现错误写法,比如在@GET请求设置了@Body这种错误就会抛出异常:
java.lang.IllegalArgumentException: Non-body HTTP method cannot contain @Body.
loadServiceMethod
然后是loadServiceMethod(method).invoke(args)
,看名字可知是先找方法,然后执行,
1 | //Retrofit.java |
跟进ServiceMethod.parseAnnotations,
1 | //ServiceMethod.java |
先看1. RequestFactory.parseAnnotations,
1 | //RequestFactory.java |
得到RequestFactory后,看2. HttpServiceMethod.parseAnnotations,HttpServiceMethod负责适配和转换处理,将接口方法的调用调整为HTTP调用,
1 | //HttpServiceMethod.java |
可见最终返回了一个CallAdapted,看到CallAdapted,
1 | //CallAdapted extends HttpServiceMethod extends ServiceMethod |
那这个CallAdapter实例到底是谁呢,我们先回到Retrofit.Builder,
1 | //Retrofit.Builder.java |
DefaultCallAdapterFactory这个工厂创建具体的CallAdapter实例,
1 | //DefaultCallAdapterFactory.java |
invoke
前边loadServiceMethod
得到了CallAdapted,然后执行invoke,实现在父类HttpServiceMethod里,
1 | //HttpServiceMethod.java |
然后是请求入队,ExecutorCallbackCall.enqueue -> OkHttpCall.enqueue,
1 | //ExecutorCallbackCall.java |
总算把流程跑通了,回到前边再看一遍流程图,就豁然开朗了~
细枝
CallAdapter
CallAdapter适配器用于适配返回类型,比如还可以支持Rxjava、协程的使用,
1 | interface WanApi { |
Converter
Converter转换器用于转换参数类型,比如把Long时间戳格式化成string再传给后端,
1 | interface WanApi { |
动态替换url
在构建Retrofit时传入HttpUrl对象,之后这个实例就一直存在不会更改,所以可以反射修改他的字段比如host,来实现动态替换服务端地址,
1 | String SERVER = "https://www.xxx.com/"; |
尾声
咱们下期见~😆
系列文章:
参考资料
- GitHub & 文档 & API
- imooc - 破解Retrofit
- 简书 - 从架构角度看Retrofit的作用、原理和启示
- 简书 - JAVA动态代理
- csdn - CGLIB(Code Generation Library)详解
- 知乎 - Java 动态代理作用是什么?