开源框架 | Retrofit 源码解析

对于 Retrofit 应该是再熟悉不过了，都知道它是一个网络框架，但是为什么它还要基于 OkHttp 呢？了解 Retrofit 后会发现，它虽是网络框架却不做任何网络请求，网络请求任务都是交给 OkHttp 去执行的。Retrofit 使用动态代理、建造者、工厂、外观、适配器等设计模式，实现了自身的高度解耦以及在实际在网络请求中的高扩展性，例如多种类型 CallAdapter 和 Converter 支持。先来看看 Retrofit 的基本使用：

1. 使用步骤

• 创建请求的接口类 IService 和请求方法

  设置请求方法类型，动态设置请求的 url、参数

  public interface IService {
      @GET("JakeWharton")
      Call getResult();
  }
  

• 创建 Retrofit

    Retrofit RETROFIT_CLIENT = new Retrofit.Builder()
            .baseUrl("https://github.com/")
            .client(OKHttpHolder.OK_HTTP_CLIENT)
            .addConverterFactory(GsonConverterFactory.create()) //数据转换器
            .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //Retrofit配合RxJava使用
            .build();
  

• 创建请求方法接口类（代理类）对象

  IService service = retrofit.create(IService.class);
  

• 创建 Call

  Call call1 = service.get();
  Call call2 = service.post();
  

• 执行请求（同步/异步）

  call.enqueue()/call.execute()
  

• 处理请求响应 Callback

        call.enqueue(new Callback() {
            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) {
                //请求成功
            }
  
            @Override
            public void onFailure(@NonNull Call call, @NonNull Throwable t) {
                //请求失败
            }
        });
  

2. 源码解析

2.1 Retrofit.Builder

Retrofit 的创建使用了建造者模式，调用 Retorfit.Builder() 时，首先会找到一个 Platform 即代码的执行平台，例如 Android平台、Java平台。

• Retrofit.Bulider() 构造方法

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

• Platform.get()

  findPlatform() 方法中实现了平台创建，由于我们是在 Android 平台使用 Retorfit，直接来看看 Android 平台做了些什么处理：

  private static final Platform PLATFORM = findPlatform();
  
  static Platform get() {
    return PLATFORM;
  }
  
  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();
  }
  

• Android 平台

  有一个内部类 MainThreadExecutor，创建了一个主线程的 Handler，ececute() 方法中通过 handler 发送消息，用于将请求的回调切回主线程，在主线程处理响应的数据。

  static class Android extends Platform {
    @Override public Executor defaultCallbackExecutor() {
      return new MainThreadExecutor();
    }
  
    @Override CallAdapter.Factory defaultCallAdapterFactory(@Nullable Executor callbackExecutor) {
      if (callbackExecutor == null) throw new AssertionError();
      return new ExecutorCallAdapterFactory(callbackExecutor);
    }
  
    static class MainThreadExecutor implements Executor {
      private final Handler handler = new Handler(Looper.getMainLooper());
  
      @Override public void execute(Runnable r) {
        handler.post(r);
      }
    }
  }
  

• baseUrl(String baseUrl)

  这里的 baseUrl 是我们的主机地址，通常是使用绝对路径，例如请求地址为：https://github.com/square/retrofit，那么 baseUrl 即为 https://github.com/，注意 baseUrl 必须以 / 结尾。

• client()

  添加一个 OkHttpClient，默认是一个不带任何配置的 OkHttpClient，如果我们想自定义 OkHttpClient 的连接时长、读/写时长以及拦截器时，可以通过 client() 传入我们自定义的 OkHttpClient。

• addConverterFactory()

  用于添加数据的转换器工厂，实现对象的序列化和反序列化，可以是基本数据类型的转换器工厂，也可以是 Gson、FastJson等；例如GsonConverterFactory，请求时 GsonRequestBodyConverter 将我们自己定义 JavaBean 或者一些基本的数据类型写入 Gson 中并转换成请求体 RequestBody 发送给服务器，响应返回时 GsonResponseBodyConverter 首先将响应体 ResponseBody 转换为 Gson，Gson 再转换为我们需要的 JavaBean 类型，省去了我们自己对数据的解析便于直接提取数据。

• addCallAdapterFactory()

  用于添加请求适配器工厂，默认请求适配默认使用 OkHttpCall，也可以是 RxJava 的 Observer 或者 Flowable（都是通过请求适配器将 OkHttpCall 转换得来的），Retrofit 中有三种请求适配器工厂类:

  • DefaultCallAdapterFactory

  • ExecutorCallAdapterFactory（ 默认的）

    将 OkHttpCall 转换为 ExecutorCallbackCall，ExecutorCallbackCall 是 DefaultCallAdapterFactory 的内部类实现了 retrofit2.Call 接口；

  • RxJava2CallAdapterFactory

    创建 RxJava2CallAdapter ，将 OkHttpCall 转换为 Observer 或者 Flowable；

  @Override public Object adapt(Call call) {
    ...
    Observable observable;
    if (isFlowable) {
        return observable.toFlowable(BackpressureStrategy.LATEST);
    }
    ...
    return observable;
  }
  

  CallAdapter 的 adapt() 方法的作用是将默认的 OkHttpCall 转换为我们指定的请求类型，比如 RxJava 的 Observer 类型。

• build()

2.2 Retrofit

• create()

  create() 用于动态返回请求接口类的代理类对象，代理类对象调用接口类中的方法时会调用代理类对象的 InvocationHandler 的 invoke() 方法，invoke() 方法的参数 method 即调用的接口方法，数组 args 即接口方法的参数，在这里通过反射我们的接口方法去调用 HTTP 请求方法，反射是在 ServiceMethod 中实现。
  其中Proxy.newProxyInstance() 有三个参数：
  • service.getClassLoader()：service 的 ClassLoader，service 就是我们调用 create() 传进来的自定义的接口类；
  • new Class[] { service }：代理类要实现的接口列表，即我们在自定义的接口类中的接口方法；
  • new InvocationHandler(){}：代理类要执行的调用程序，在代理类对象调用接口方法时执行；

  public  T create(final Class service) {
    ...//省略内容主要用于检测 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 {
            ...
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);
            OkHttpCall