android中Retrofit2源码解析（新版本）

android中Retrofit源码解析（新版）

在android开发中我们原生应用发起网络请求的时候，不免需要使用android对网络请求的封装，它提供了对http协议底层的抽象，我们可以通过它提供的方法直接调用http请求。在android2.2版本及其以前的版本使用HttpClient，在android2.3版本及其之后我们使用了httpUrlConnection，而且在6.0之后android移除了httpClient，我们在高版本的API中只能使用HttpUrlConnection了。

1.1 retrofit和OkHttp的关系

但是实际情况是使用了httpUrlConnection还是很繁琐，我们还是要去考虑超时时间，服务器异常情况、数据流转为实体对象这些烦恼。所以有了对android内置的HttpUrlConnection or httpClient的包装，让我们专心处理业务逻辑。oKHttp就诞生了，android4.4版本以后都内置了oKHttp了，而我们要讨论的retrofit就是再次对okHttp的包装，丰富了很多强大的功能，比如能和Rxjava这个流行的框架结合，返回结果能回调到UI线程等。oKHttp的源码涉及到了对阻塞队列，线程池的应用，我们下一节进行探讨。

1.2 retrofit的本质

retrofit的本质就是应用了大量的设计模式对Okhttp进行了封装，加入了网络数据转换、网络请求回调、网络请求适配这几个主要的功能。它本身肯定不会去发请求的，发请求交给了OkHttp，它只对调用方式和返回结果进行处理其他的不关它的事。为什么要去研究retrofit的源码呢？因为它封装的方式解耦性很高，功能调用十分简洁，可以参照它对我们的代码也能进行改造。

1.3 源码解析（retrofit：2.4.0）

1.3.1 retrofit的创建

一起打开IDE阅读源码更虚浮！retrofit的创建是整个框架的入口，它肯定会提前准备好很多看不懂的变量进行初始化，但是这不能阻挡我们，往后看就能理解它代表的含义了。根据官方的文档，retrofit的创建使用了建造者模式。

Retrofit retrofit = new Retrofit.Builder() 
//基本URL
.baseUrl("https://www.baidu.com") 
//网络请求适配器
.addCallAdapterFactory(RxJavaCallAdapterFactory.create()) 
//网络请求数据转换器
.addConverterFactory(GsonConverterFactory.create()) 
//网络请求执行器
.client(new OkHttpClient())       
.build();

所谓建造者模式就是有builder关键字的方式，就是这么简单！当然这是一个玩喜，建造者模式和我们以前 get/set 类的属性没有什么本质的区别，主要是将这些set方法全部提取出来形成一个抽象类或者内部类，然后在一个建造者类里面去设置属性，返回一个实体类对象，列如：

public abstract Builder{
public void BulidProperty(String url);
}
public class RealBuilder extends Builder{
private RealObject object;
public void BulidProperty(String url){
    object.SetProperty(url);
     }
 public RealObject build(){
     return RealObject;
     }
}

简单的思想大概是这样的，具体的我们可以看一下Retrofit中的源码。第一行代码

//第一行代码
Retrofit retrofit = new Retrofit.Builder()

很明显这个Builder是一个Retrofit的内部类，那说明建造者不是继承了抽象类，而是使用了内部类来设置属性。来看一下这个内部类，如下：


public static final class Builder { 
    //不知道这是什么东东先放在一边
    private final Platform platform;
    //很明显出现了okhttp，就知道它肯定负责去发请求
    private okhttp3.Call.Factory callFactory;  
    // 8必多说 大家都懂
    private HttpUrl baseUrl;
    //很明显它是存数据转换用的，但是为什么搞一个list 懵b？
    private final List converterFactories = new ArrayList<>(); 
    //很明显它存网络适配器用的，再次疑问这个网络适配器是什么东东？
    private final List adapterFactories = new ArrayList<>(); 
    //很明显他是一个回调执行器，这个有什么用呢？
    private Executor callbackExecutor; 
    //这肯定是校验Flag目前不知道有什么用
    private boolean validateEagerly;

里面看不懂的变量主要有adapterFactories存的网络适配器工厂（CallAdapter.Factory），很明显他后面会使用工厂设计模式去产生CallAdapter的对象，至于数据转换器（converter）我们都知道http请求返回来的是数据流InputStream方式的，转为Json，XML之类需要一个转换器，类似于一个double转int的工具类。

网络适配器的含义及其作用：网络适配器是我自己给他的定义，从命名上来看是叫：CallAdapter，Call肯定是来发请求的，Adapter忆往昔峥嵘岁月，在listView里面是界面和数据的桥梁，同理这里的CallAdapter应该是客户端和网络之间桥梁。客户端发请求的操作肯定是要通过它的。如图：

image.png

这样我们就可以清楚的看到了CallAdapter的作用了，它对OkHttp进行包装，我们调用请求方法的时候都要通过它。它同时持有了okHttp对象和回调执行器的对象，这样它通过Okhttp拿到数据之后，用回调执行器回调。

回调执行器：回调执行器就是在拿到数据结果之后，我们怎么返回结果的问题，主要的问题就是由于是异步请求，我们想要使用数据填充界面，需要切换到主线程。

  //再看看构造函数
  Retrofit retrofit = new Retrofit.Builder()

这个内部类的构造函数做了些什么内容？就一句调用自己的有参构造函数，佛了！

public Builder() {  this(Platform.get());}

我们来看看这个有参构造函数和Platform类是什么东东：

    //Platform类
class Platform {
  private static final Platform PLATFORM = findPlatform();
  static Platform get() {
  //f返回一个实例就完事了
    return PLATFORM;
  }
  //根据不同运行平台返回对应的Platforem对象 
     private static Platform findPlatform() {
    try {
      Class.forName("android.os.Build");
      if (Build.VERSION.SDK_INT != 0) {
        return new Android();
      }
    } catch (ClassNotFoundException ignored) {
    }
    try {
      Class.forName("java.util.Optional");
      return new Java8();
    } catch (ClassNotFoundException ignored) {
    }
    return new Platform();
  }

看到这里我们就明白了，他根据运行的平台不同来返回相应的对象，我们这里只分析 new Adnroid();看看里面有什么内容：

static class Android extends Platform {
 //一个默认的回调执行器
    @Override
     public Executor defaultCallbackExecutor() {
      return new MainThreadExecutor();
    }
    //很明显 很熟悉 ！创建了一个默认的CallAdapter（网络适配器），而且传入了一个回调执行器（回调执行器可以自定义，不然就是用默认绑定主线程）
    @Override 
    CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
      return new ExecutorCallAdapterFactory(callbackExecutor);
    }
     static class MainThreadExecutor implements Executor {
     //给力 绑定了主线程的 looper （关于Handler的详细内容可以自己查询）
      private final Handler handler = new Handler(Looper.getMainLooper());
      @Override 
      public void execute(Runnable r) {
        handler.post(r);
      }
    }
  }

到此我们明白了 Platfrom的作用了，它提供了一个默认的CallAdapter.Factory用来生产CallAdapter，还提供了一个绑定主线程的默认回调执行器。

再次回头看创建Retrofit的其他代码

Retrofit retrofit = new Retrofit.Builder() 
//基本URL
.baseUrl("https://www.baidu.com")
//可以自定义回调执行器，否则默认回调到主线程
.callbackExecutor("xxxx")
//网络请求适配器
.addCallAdapterFactory(RxJavaCallAdapterFactory.create()) 
//网络请求数据转换器
.addConverterFactory(GsonConverterFactory.create()) 
//网络请求执行器
.client(new OkHttpClient())       
.build();

baseUrl、add这些方法是给内部类属性赋值，我们主要来看build()方法。

 public Retrofit build() {
    //可见baseUrl 是必须的 使用的时候要注意
      if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
      }
      //很明显 生产网络请求的工厂，如果你不传入自定义的okHttp对象，他会默认使用okHttpclient
      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }
      //如果没有自定义，加入刚刚说过的默认调到到主线程
      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }
      //将传入到内部类callAdapter copy一份 传入到retrofit的构造函数
      List adapterFactories = new ArrayList<>(this.adapterFactories);
        //它会添加一个默认的网络适配器，这个网络适配器它持有callbackExecutor回调执行器的对象。
      callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
      //很明显类似adapterFactories 添加了一个默认，再copy一份到 retrofit的构造函数中。
      List converterFactories =new ArrayList<>(1 + this.converterFactories.size());
      converterFactories.add(new BuiltInConverters());
      converterFactories.addAll(this.converterFactories);
      //返回retrofit的实例对象就完事了
      return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
          callbackExecutor, validateEagerly);
    }
  }

这里的代码都很简单，但是有几个疑问？为什么这个adapterFactories和converterFactories都是list呢，它里面都存了些什么。

adapterFactories: 一个list集合，存储了网络适配器工厂，根据上面的代码我们可以看到它里面的内容是：先添加了自定义的、后面添加了一个默认的，总共两个元素。在Retrofit中提供了四种CallAdapterFactory： ExecutorCallAdapterFactory（默认）、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory。其他的没有用过，但是看到Rxjava我们就知道了，如果想要和Rxjava结合起来这个RxJavaCallAdapterFactory必须添加进去

//通过这个添加进去，是不是可以添加多个呢？
Retrofit retrofit = new Retrofit.Builder() 
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
//我们还可以添加
// adapterFactories里面顺序
// 自定义1-自定义2-.....默认。
addCallAdapterFactory(Java8CallAdapterFactory.create())
addCallAdapterFactory(GuavaCallAdapterFactory.create())
//converter 同理啊铁子！
.addConverterFactory(GsonConverterFactory.create())

也不会有问题，因为我们网络请求都是多种多样的，上面已经说得我们发请求就是操作CallAdapter，所以有结果返回的时候也需要通过CallAdapter。有时候我们需要Rxjava的observeable这种返回对象，有时候我们还是需要Call这种类型的返回对象，所以他需要一个list去组装对应的CalladapterFactory，Call代表了默认CallAapter返回出来的的，Observable代表了我们添加进去的RxJavaCallAdapter返回出来的。同理我们需要从CallAdapter得到想要的数据类型，converterFactories也需要多个。

    @GET
    //我想要Observable 需要相应的的CallAdapter
   Observable download(@Url String url);
    @GET
        //我想要Call 默认的CallAdapter就行
        //同时还需要将结果变成IModel 怎么说吧你
    Calldownload(@Url String url);

总结：我们清楚的看到了，retrofit的创建过程，主要的内容就是四个器的初始化，网络适配器（CallAdapter），数据转换器（conver），请求执行器（oKHttp），回调执行器（callbackExecutor）。关注点在我们发请求操作都是CallAdapter，它肯定持有其他三个的引用，就像吃鸡里面他是我们的角色，其他的是M4,头盔药品等。

1.3.2 创建网络请求接口的实例。

对我们的的注解定义的接口方法进行解析，从而创建实例，有点迷惑？什么实例，干什么用的？我们继续往下看。

retrofit.create(RetrofitService.class);

看到这种传入.class的，我们可以想到肯定会用到反射。

 public  T create(final Class service) {
    //校验接口正确性，是否符合注解规则
    Utils.validateServiceInterface(service);
    //validateEagerly 这个变量主要是作用是 是否提前加入缓存
    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 {
              //如果是java里面的基类不做处理 
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            // 这个没什么用android平台默认返回的是false的
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
           //非常重要的3行代码
           //解析方法的返回参数 请求参数 请求类型等
            ServiceMethod serviceMethod =(ServiceMethod) loadServiceMethod(method);
            //很明显OkHttp就知道他是一个网络执行器
            OkHttpCall