Android学习笔记——Retrofit2源码浅分析

标签： Android

先看看这张图

制图简陋请多包涵

Retrofit

在学习Android的时候，我最熟悉的网络请求框架莫过于OKHttp + Retrofit，反反复复用了很多次，个人感觉Retrofit的兼容和解耦做的太好了，这里想要试着分析一下Retrofit的源码。

RESTful 原则

在我们使用Retrofit这个框架的时候，我们都需要后端的接口遵循RESTful原则，那什么是RESTful原则呢？
RESTful是Representational State Transfer的缩写，翻译过来就是“表现层状态转化”，他是基于HTTP协议的。

1. 表现层：我们访问服务器是为了“增、删、改、查”服务器上面的资源（数据），资源的对应的是一段文本（text）、一张图片、一首歌曲或者一段音频等，那么这里我们就说这些资源的实体就是表现层。
2. 状态转化：当我们通过用“增、删、改、查”的方式访问服务器的时候，服务器的资源实体可能会发生变化，对应的状态也会相映的变化，这就是状态转化。
3. 客户端怎么进行“增、删、改、查”？ 通过HTTP协议，具体就是用HTTP提供的GET、POST、DELETE、PUT的方式。

Retrofit分层

我们导入Retrofit的时候，发现我们导入的包分为了三个部分：包装OKHttp的Retrofit部分，兼容RxJava的部分和兼容Gson的部分。

一、包装OKHttp

我们来看看这个部分的目录：

image.png

1. 首先这里有一个子目录http，进去看我们就可以发现里面定义了若干的关于http协议的注解（包括GET、POST、PUT和DELETE等）。
2. 接下来就是Retrofit以及它包装的网络请求执行器，请求的构建器，响应、转化器、线程池和工具等等（以上没按照顺序）

二、兼容Gson

我们来看看这个部分的目录：

image.png

这个部分很简单，只包含了三个部分：Gson转换器的工厂、Gson请求体的转换器和Gson响应体的转换器。

三、兼容RxJava

我们再来看看这个部分的目录：

image.png

这个部分我们可以看到很多继承自RxJava的Observable对象，都由RxJava2CallAdapter封装，最后由它的工厂类RxJava2CallAdapterFactory创建出来。

Retrofit 流程源码分析

一般情况下我们使用Retrofit的代码如下：

    mApiService = new Retrofit.Builder()
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .baseUrl(BASE_URL)
                .client(getClient())
                .build()
                .create(ApiService.class);

先是通过Retrofit的构建器构建一个Retrofit对象，前面的几个链式调用都是为了支持其他三方库的功能，我们直接去看Retrofit的构建器的build()方法。

Retrofit.Builder.java

    //成员
    //当前的平台
    private final Platform platform;
    //网络请求执行器的工厂
    private @Nullable okhttp3.Call.Factory callFactory;
    private HttpUrl baseUrl;
    //可能会用到的转换器工厂的集合
    private final List converterFactories = new ArrayList<>();
    //可能会用到的适配器工厂的集合
    private final List adapterFactories = new ArrayList<>();
    //可能会用到的线程池，默认为null
    private @Nullable Executor callbackExecutor;
    //是否在调用create()方法时，验证传入的接口中的所有方法
    private boolean validateEagerly;
    
    .......
    
    
 public Retrofit build() {
      if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
      }

      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }

      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }

      // 制作适配器的防御副本并添加默认的呼叫适配器.
      List adapterFactories = new ArrayList<>(this.adapterFactories);
      adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

      // 制作转换器的防御副本.
      List converterFactories = new ArrayList<>(this.converterFactories);

      return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
          callbackExecutor, validateEagerly);
    }

我们可以看见，这里和简单的构建者模式没什么区别，初始化需要用到的成员变量，然后再直接通过Retrofit的构造函数创建一个实例对象，接下来我们去看看create()方法。

public  T create(final Class service) {
    //验证服务接口，服务接口必须是一个interface对象，且它没有任何父接口
    Utils.validateServiceInterface(service);
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }
    //通过动态代理创建服务接口的实现类
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
              throws Throwable {
            // 如果是Object的方法，不做任何处理
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            //这个条件判断在Retrofit3.2.0时一直为false,其他版本不知道
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            //这里通过服务接口的方法加载了一个ServiceMethod对象
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);
            OkHttpCall