Retrofit源码学习笔记

时间  2019-11-29
标签 retrofit 源码 学习 笔记 繁體版
原文   原文链接

最近看了Retrofit（2.5.0）的部分源码，借此博客记录下本身对Retrofit的理解，功力善浅，若有错误欢迎各位大佬指正。java

一、简单使用Retrofit进行异步请求

image.png
image.png

Retrofit的请求分为四步设计模式

  • 一、建立Retrofit对象，在这里添加网络请求基地址，添加实际网络请求对象Okhttp,添加数据转换器工厂，支持Gson，JackSon，Guava，Java8等等，这里咱们使用的是Gson的转换器工厂。而后再添加CallAdapter工厂，支持Guava,Java8.Rxjava等，这里咱们用的是RxJava2的CallAdapter工厂。
  • 二、咱们是先建立一个管理网络请求的接口（RetrofitInterface），而后再这个接口里去定义网络请求。
  • 三、咱们根据RetrofitInterface定义的网络请求接口拿到Retrofit的Call对象。
  • 四、经过Call对象的enqueue方法执行网络请求。

二、Retorfit类分析

采用了构建者模式来构建，避免在构造方法传入过多参数致使使用者混淆。缓存

先分析Retrofit的内部类Builder

Builder成员变量
public static final class Builder {
    private final Platform platform;
    private @Nullable okhttp3.Call.Factory callFactory;
    private @Nullable HttpUrl baseUrl;
    private final List<Converter.Factory> converterFactories = new ArrayList<>();
    private final List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>();
    private @Nullable Executor callbackExecutor;
    private boolean validateEagerly;
    ......省略
    }
复制代码

这里只贴出了Builder类的成员变量，能够看出这个类的成员变量很少，也就是说Retrofit的配置并不像okhttp那么多安全

  • 一、platform表示的是平台，由于Retrofit不止支持Android平台他还支持Java8
  • 二、callFactory是Okhttp3.Call的Factory接口实例，这里咱们建立时传入的是OkhttpClient对象，默认也是OkhttpClient对象。
  • 三、baseUrl也就是咱们的网络请求基地址
  • 四、converterFactories 是一个存放数据转换器工厂的数据集合
  • 五、callAdapterFactories是一个存放callAdapter工厂的数据集合
  • 六、callbackExecutor默认是MainThreadExecutor这个类实例。里面有一个主线程的handler，因此很明显这个是作线程切换的。
  • 七、validateEagerly是一个标记位，在后面会被用到。
Builder构造方法
Builder(Platform platform) {
      this.platform = platform;
    }

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

    Builder(Retrofit retrofit) {
      platform = Platform.get();
      callFactory = retrofit.callFactory;
      baseUrl = retrofit.baseUrl;

      // Do not add the default BuiltIntConverters and platform-aware converters added by build().
      for (int i = 1,
          size = retrofit.converterFactories.size() - platform.defaultConverterFactoriesSize();
          i < size; i++) {
        converterFactories.add(retrofit.converterFactories.get(i));
      }

      // Do not add the default, platform-aware call adapters added by build().
      for (int i = 0,
          size = retrofit.callAdapterFactories.size() - platform.defaultCallAdapterFactoriesSize();
          i < size; i++) {
        callAdapterFactories.add(retrofit.callAdapterFactories.get(i));
      }

      callbackExecutor = retrofit.callbackExecutor;
      validateEagerly = retrofit.validateEagerly;
    }
复制代码
  • 一、默认的构造方法只是调用了平台参数的构造方法，并给platform赋值。因此在Android设备上platform是Platform的内部类Android类实例。
    image.png
  • 二、 咱们也能够经过传入Retrofit对象来初始化Builder，一样platform仍是根据平台来赋值。callFactory，baseUrl ，callbackExecutor ，validateEagerly 取的都是传入Retrofit实例的值。converterFactories和callAdapterFactories只添加经过Builder的addConverterFactory方法和addCallAdapterFactory方法添加的Converter.Factory和CallAdapter.Factory。由于Builder的build方法会添加默认的转换器和适配器到converterFactories和callAdapterFactories里。简而言之就是只添加使用者以前构建Retrofit时传入的Converter.Factory和CallAdapter.Factory。
Builder的build方法
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();
      }

      // Make a defensive copy of the adapters and add the default Call adapter.
      List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
      callAdapterFactories.addAll(platform.defaultCallAdapterFactories(callbackExecutor));

      // Make a defensive copy of the converters.
      List<Converter.Factory> converterFactories = new ArrayList<>(
          1 + this.converterFactories.size() + platform.defaultConverterFactoriesSize());

      // Add the built-in converter factory first. This prevents overriding its behavior but also
      // ensures correct behavior when using converters that consume all types.
      converterFactories.add(new BuiltInConverters());
      converterFactories.addAll(this.converterFactories);
      converterFactories.addAll(platform.defaultConverterFactories());

      return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
          unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
    }
复制代码
  • 一、检测BaseUrl是否为null，检测callFactory 是否为null，默认为构建的一个OkhttpClient实例。检测callbackExecutor 是否为null，默认为咱们前面提到的MainThreadExecutor实例。而后为callAdapterFactories添加传入的CallAdapter.Factory实例和平台默认的CallAdapter.Factory实例。为converterFactories 添加BuiltInConverters实例，传入的Converter.Factory实例和平台默认的Converter.Factory实例。
    image.png
    由上面代码咱们能够看出Android平台默认的CallAdapter.Factory在7.0以上为CompletableFutureCallAdapterFactory和ExecutorCallAdapterFactory，在7.0如下为ExecutorCallAdapterFactory。
    image.png
    由上面代码咱们能够看出Android平台默认的Converter.Factory在7.0以上为OptionalConverterFactory，在7.0如下为空集合。
  • 二、最后将经过这些参数构建Retrofit对象，这时会用调用Collections的unmodifiableList方法将converterFactories和callAdapterFactories都转换为一个只读的快速访问的list，UnmodifiableRandomAccessList实例。因此经过Builder构建的Retrofit对象里面的converterFactories和callAdapterFactories实例都是只读的，要是进行写操做会抛出UnsupportedOperationException异常。
    image.png

接着分析Retrofit

Retrofit的成员变量

Retrofit的成员变量和Retrofit的内部类Builder里面的成员变量是基本一致的，这里就不作阐述了。bash

Retrofit的create方法

咱们前面总结的Retrofit简单异步请求的第三步就是经过调用Retrofit的creat方法来建立RetrofitInterface接口实例。咱们如今来看下内部是如何工做的。 网络

image.png

  • 一、首先检测传入的Class是否是接口。
  • 二、而后接下来咱们能够看到validateEagerly这个参数的使用了，默认是false。若是咱们设置为true的话，会调用eagerlyValidateMethods方法。
    image.png
    这里会遍历传入的RetrofitInterface接口里面的全部方法，若是不是默认方法则继续走156行，调用Retrofit的loadServiceMethod方法。
    image.png
    这里能够看到原来Retrofit里面还有一个serviceMethodCache的成员变量，这个成员变量是一个ConcurrentHashMap，这是一个线程安全的map集合，看名字以及上面代码咱们明白了咱们这个集合就是用来缓存Method对应的Retrofit里面的ServiceMethod对象。最后跟踪源码发现经过Method构建了一个HttpServiceMethod实例。能够看出HttpServiceMethod的成员变量都是很重要的，这里就先不阐述了。从这里咱们也能够看出validateEagerly表明的含义是是否提早缓存RetrofitInterface中定义的方法到Retrofit中来。
    image.png
  • 三、咱们跳回到以前的Retrofit的create方法，Retrofit的133行建立了一个动态代理类。当RetrofitInterface接口中的方法经过代理执行的时候，便会执行这里面InvocationHandler匿名内部类的invoke方法。接着往下判断若是方法是来自Object的方法，则正常调用。若是是Andriod平台默认方法，则会抛出UnsupportedOperationException异常（下图是Platform的invokeDefaultMethod方法，内部类Android没有重写该方法。）
    image.png
  • 四、接下来是这个方法的核心147行，首先调用了loadServiceMethod方法，并经过ConcurrentHashMap获取有没有此method对应的HttpServiceMethod实例。有则直接返回，没有则建立对应的HttpServiceMethod，缓存后便返回对应的HttpServiceMethod实例。接着再调用invoke，这里咱们能够看到主要是构建了一个OkhttpCall对象，而后用咱们的calladapter也就是RxJava2CallAdapter的adapt方法去处理。因此这里咱们就能够看出Retrofit主要是对网络请求方法作了下封装，实际请求和处理仍是交给了咱们的OkhttpCall和传入的适配器和转换器。
    image.png

三、HttpServiceMethod类

从上面咱们知道了Retrofit的Creat方法建立了一个动态代理，当咱们调用请求接口方法时，代理的invoke方法便会执行，这时候主要是经过HttpServiceMethod来解析请求接口（RetrofitInterface）中定义的网络请求方法。因此，我这里想多多认识HttpServiceMethod。架构

基类ServiceMethod

前面咱们提到的Retrofit的loadServiceMethod方法中，用serviceMethodCache来缓存Method实例和对应的HttpServiceMethod实例，而这个HttpServiceMethod实例是经过ServiceMethod的parseAnnotations方法得到的。 dom

image.png
parseAnnotations方法首先构建一个RequestFactory实例
image.png
这里一样是采用了构建者模式
image.png
获取了method的注解，形参类型，形参注解。显而易见，RequestFactory类就是将咱们在RetroInteface接口中定义的请求方法注解，返回值，参数类型等等进行解析并存储。咱们接着看ServiceMethod的parseAnnotations方法，接下来是判断method的返回值是否合法，不能包括可变类型或者通配符，而且不能为空，不然抛出异常，也就是说咱们的网络请求方法的返回值不能包括可变类型或者通配符，而且不能为空。接着继续调用子类HttpServiceMethod的parseAnnotations方法

HttpServiceMethod的parseAnnotations方法

image.png
这里34行就是获取咱们添加到Retorfit成员变量callAdapterFactories中的RxJava2CallAdapterFactory实例而后来建立一个RxJava2CallAdapter实例返回。接下来就是处理method的返回值类型，再经过咱们添加到Retorfit成员变量converterFactories中的GsonConverterFactory实例来建立一个GsonResponseBodyConverter实例返回。最后再经过RequestFactory实例，okhttp3.Call.Factory实例，RxJava2CallAdapter实例和GsonResponseBodyConverter实例来构建一个HttpServiceMethod实例。 由上面的这些内容咱们能够明白HttpServiceMethod这个类的主要功能是经过RxJava2CallAdapter将获得的RequestFactory，okhttp3.Call.Factory，GsonResponseBodyConverter实例建立一个OkHttpCall实例。

四、总结

  • 一、Retrofit内部实际用的网络请求仍是OkHttp，咱们在接口中定义的请求方法经过反射得到注解，参数，返回值这些来建立RequestFactory实例，最后再经过RequestFactory实例来建立OkHttp的RealCall对象。
  • 二、Retrofit支持多平台，数据转换器和执行调度器，最大程度的知足不一样架构。
  • 三、validateEagerly的值表明是否一开始就直接缓存网络请求接口里面全部的对应的HttpServiceMethod实例。
  • 四、Retrofit主要是采用动态代理的方式在咱们执行网络请求方法的时候对其进行解析。
  • 五、Retrofit采用的大量的设计模式（构建者模式，代理模式，简单工程模式、策略模式，适配器模式等等）可供咱们参考学习。
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程