阅读 78

Retrofit源码学习笔记

最近看了Retrofit(2.5.0)的部分源码,借此博客记录下自己对Retrofit的理解,功力善浅,如有错误欢迎各位大佬指正。

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

image.png
image.png

Retrofit的请求分为四步

  • 1、创建Retrofit对象,在这里添加网络请求基地址,添加实际网络请求对象Okhttp,添加数据转换器工厂,支持Gson,JackSon,Guava,Java8等等,这里我们使用的是Gson的转换器工厂。然后再添加CallAdapter工厂,支持Guava,Java8.Rxjava等,这里我们用的是RxJava2的CallAdapter工厂。
  • 2、我们是先创建一个管理网络请求的接口(RetrofitInterface),然后再这个接口里去定义网络请求。
  • 3、我们根据RetrofitInterface定义的网络请求接口拿到Retrofit的Call对象。
  • 4、通过Call对象的enqueue方法执行网络请求。

2、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那么多

  • 1、platform表示的是平台,因为Retrofit不止支持Android平台他还支持Java8
  • 2、callFactory是Okhttp3.Call的Factory接口实例,这里我们创建时传入的是OkhttpClient对象,默认也是OkhttpClient对象。
  • 3、baseUrl也就是我们的网络请求基地址
  • 4、converterFactories 是一个存放数据转换器工厂的数据集合
  • 5、callAdapterFactories是一个存放callAdapter工厂的数据集合
  • 6、callbackExecutor默认是MainThreadExecutor这个类实例。里面有一个主线程的handler,所以很明显这个是做线程切换的。
  • 7、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;
    }
复制代码
  • 1、默认的构造方法只是调用了平台参数的构造方法,并给platform赋值。所以在Android设备上platform是Platform的内部类Android类实例。
    image.png
  • 2、 我们也可以通过传入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);
    }
复制代码
  • 1、检测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以下为空集合。
  • 2、最后将通过这些参数构建Retrofit对象,这时会用调用Collections的unmodifiableList方法将converterFactories和callAdapterFactories都转换为一个只读的快速访问的list,UnmodifiableRandomAccessList实例。所以通过Builder构建的Retrofit对象里面的converterFactories和callAdapterFactories实例都是只读的,要是进行写操作会抛出UnsupportedOperationException异常。
    image.png

接着分析Retrofit

Retrofit的成员变量

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

Retrofit的create方法

我们前面总结的Retrofit简单异步请求的第三步就是通过调用Retrofit的creat方法来创建RetrofitInterface接口实例。我们现在来看下内部是如何工作的。

image.png

  • 1、首先检测传入的Class是不是接口。
  • 2、然后接下来我们可以看到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
  • 3、我们跳回到之前的Retrofit的create方法,Retrofit的133行创建了一个动态代理类。当RetrofitInterface接口中的方法通过代理执行的时候,便会执行这里面InvocationHandler匿名内部类的invoke方法。接着往下判断如果方法是来自Object的方法,则正常调用。如果是Andriod平台默认方法,则会抛出UnsupportedOperationException异常(下图是Platform的invokeDefaultMethod方法,内部类Android没有重写该方法。)
    image.png
  • 4、接下来是这个方法的核心147行,首先调用了loadServiceMethod方法,并通过ConcurrentHashMap获取有没有此method对应的HttpServiceMethod实例。有则直接返回,没有则创建对应的HttpServiceMethod,缓存后便返回对应的HttpServiceMethod实例。接着再调用invoke,这里我们可以看到主要是构建了一个OkhttpCall对象,然后用我们的calladapter也就是RxJava2CallAdapter的adapt方法去处理。所以这里我们就可以看出Retrofit主要是对网络请求方法做了下封装,实际请求和处理还是交给了我们的OkhttpCall和传入的适配器和转换器。
    image.png

3、HttpServiceMethod类

从上面我们知道了Retrofit的Creat方法创建了一个动态代理,当我们调用请求接口方法时,代理的invoke方法便会执行,这时候主要是通过HttpServiceMethod来解析请求接口(RetrofitInterface)中定义的网络请求方法。所以,我这里想多多认识HttpServiceMethod。

基类ServiceMethod

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

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实例。

4、总结

  • 1、Retrofit内部实际用的网络请求还是OkHttp,我们在接口中定义的请求方法通过反射获得注解,参数,返回值这些来创建RequestFactory实例,最后再通过RequestFactory实例来创建OkHttp的RealCall对象。
  • 2、Retrofit支持多平台,数据转换器和执行调度器,最大程度的满足不同架构。
  • 3、validateEagerly的值代表是否一开始就直接缓存网络请求接口里面所有的对应的HttpServiceMethod实例。
  • 4、Retrofit主要是采用动态代理的方式在我们执行网络请求方法的时候对其进行解析。
  • 5、Retrofit采用的大量的设计模式(构建者模式,代理模式,简单工程模式、策略模式,适配器模式等等)可供我们参考学习。
关注下面的标签,发现更多相似文章
评论