源码走读之Retrofit 2.0

前言

源码解析看别人的就够了？我有几句话想说

这段时间在对项目进行组件化改造，期间又穿插了对各种设计模式的复习。于是想到别人的源码解析看了很多，一些作者写的也非常详细，包含了类图到时序图，但只有从自己出发感受一遍，才能体悟优秀框架蕴含的代码设计。网络框架是每个应用都会使用到的，故这次先拿Retrofit 2.0开刀，发现其中的闪光点。

框架介绍与体悟

Retrofit adapts a Java interface to HTTP calls by using annotations on the declared methods to
define how requests are made. Create instances using {@linkplain Builder
the builder} and pass your interface to {@link #create} to generate an implementation.

以前翻看源码时，喜欢直接顺着方法调用查找，忽略了每个类中作者详细的注释。其实除了代码，注释也是一种方便我们学习框架的重要资源，尤其是优秀的框架。如同Retrofit开头所介绍的，他与其他网络框架最与众不同的一点便是利用了注解——在给定的方法上添加注解，框架便会将接口转换为一个个HTTP请求。其次，我们也清晰了解到最终的调用分为两步:使用Builder构建Retrofit客户端；传入我们定义的接口，并调用create方法生成对应的请求实例。我们就会自然的产生两个疑问，即这两步具体是如何生成的？接下来，我们就从这两个疑问出发，进行源码的拆解

主要类拆解

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.example.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .build();

 MyApi api = retrofit.create(MyApi.class);

这是一段注释中的代码，也是我们大家都会使用的操作，这几个方法都在Retrofit.java中,接下来就结合代码进行具体分析。

Retrofit实例构建

public static final class Builder {
  //操作平台
  //具体见后续分析
  private final Platform platform;
  //网络请求的工厂（Retrofit默认使用okhttp）
  private @Nullable okhttp3.Call.Factory callFactory;
  //网络请求的baseUrl
  private HttpUrl baseUrl;
  //数据转换器工厂的集合
  //作用：放置数据转换器工厂
  private final List converterFactories = new ArrayList<>();
  //请求适配器工厂的集合
  private final List adapterFactories = new ArrayList<>();
  //回调方法执行器
  private @Nullable Executor callbackExecutor;
  //标志位
  //作用：根据业务接口创建请求时是否提前解析注解
  private boolean validateEagerly;


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

Builder(Platform platform) {
    this.platform = platform;
    // 提前添加build-in converter factory
    converterFactories.add(new BuiltInConverters());
  }
  
//构建Retrofit实例
public Retrofit build() {
    //必须传入baseUrl
    if (baseUrl == null) {
      throw new IllegalStateException("Base URL required.");
    }
    
    //默认使用OkHttpClient作为网络请求器工厂
    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);

    //根据建造者模式配置的参数创建Retrofit实例
    return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
        callbackExecutor, validateEagerly);
  }
  ...
}

可以知道Retrofti在这里使用了建造者模式完成实例的初始化配置，其中包含了以下重要的参数：

• 平台类型（platform）
• 网络请求器工厂（callFactory）
• 网络请求的baseUrl（baseUrl）
• 数据适配器工厂的集合（converterFactories）
• 请求适配器工厂的集合（adapterFactories）
• 回调执行器（callbackExecutor）
• 标志位（validateEagerly）

请求实例创建

 //根据请求接口创建对应的网络请求
 @SuppressWarnings("unchecked") // 
  public  T create(final Class service) {
    //验证类必须为接口，且不能继承于其他接口
    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 {
            //如果Method源自于普通Object类，则定义一个普通的调用
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            //若为Android平台，默认范围false
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            //根据method加载对应的ServiceMethod,注意loadServiceMethod方法
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);
            //创建网络请求
            OkHttpCall