Retrofit2源码分析

Retrofit源码分析基于2.4.0。

关于Retrofit的基本使用可以参照 Retrofit官网。

Retrofit是Java及Android平台上类型安全的Http客户端。这是官方给出关于Retrofit的简介。

这里需要明确：Retrofit只是一个Http网络请求封装库，该库的主要工作是对网络请求进行封装，最终实现网络请求的操作是由Okhttp完成的。

基本使用

使用Retrofit发起一次网络请求，只需要以下流程即可:

1. 定义一个网络请求接口。
2. 创建Retrofit实例
3. 通过Retrofit创建网络请求接口的动态代理类
4. 通过动态代理类获取Call对象，用于网络请求
5. 通过Call对象实现网络请求(同步/异步)

代码演示：

1、定义一个网络请求接口实现用户登录功能

public interface ILoginService {

    @POST("user/login")
    Call Login(@Body User user);
}

2、通过Retrofit完成网络请求

// 2、创建一个Retrofit对象
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://localhost:8080/testRetrofit/")
        .addConverterFactory(GsonConverterFactory.create())
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .build();

// 3、通过Retrofit创建Retrofit的代理实例
ILoginService loginService = retrofit.create(ILoginService.class);


User user = new User();
user.setUsername("jack");
user.setPassword("123456");
// 4、获取实现网络请求的Call对象
Call call = loginService.login(user);

// 5、实现异步网络请求
call.enqueue(new Callback() {
    @Override
    public void onResponse(Call call, Response response) {
        // 获取用户信息
        User body = response.body();
    }

    @Override
    public void onFailure(Call call, Throwable t) {

    }
});
        // 5、同步请求获取响应
//        Response execute = call.execute();
//        User body = execute.body();

源码分析

针对上文中提到的Retrofit的使用流程，这里将对这些流程的源码逐一分析。

创建Retrofit实例

Retrofit实例的创建主要是通过内部类Retrofit.Buidler实现的。很明显，这里使用了建造者模式。

这里看下Builder的构造方法:

    Builder(Platform platform) {
      this.platform = platform;
    }

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

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

      converterFactories.addAll(retrofit.converterFactories);
      // Remove the default BuiltInConverters instance added by build().
      converterFactories.remove(0);

      callAdapterFactories.addAll(retrofit.callAdapterFactories);
      // Remove the default, platform-aware call adapter added by build().
      callAdapterFactories.remove(callAdapterFactories.size() - 1);

      callbackExecutor = retrofit.callbackExecutor;
      validateEagerly = retrofit.validateEagerly;
    }

从源码可知，Retrofit有三个构造方法，但是两个具有包级访问权限，所以外部能使用的就只有无参数构造方法。

这种构造方法的设计和Okhttp是相同的。

在上面的无参构造方法中，内部通过Platform.get()方法获取一个Platform实例以完成Retrofit的创建。

Platform将在下章节中通CallAdapter一同讲解，这里只需要知道在Android平台中该Platform的作用就是提供一个CallAdapter工厂用于创建CallAdapter即可。

接着看下Builder.build()方法，build()方法主要是对Retrofit中一些属性做初始化操作。

Retrofit声明的属性

 private final Map> serviceMethodCache = new ConcurrentHashMap<>();

  final okhttp3.Call.Factory callFactory;
  final HttpUrl baseUrl;
  final List converterFactories;
  final List callAdapterFactories;
  final @Nullable Executor callbackExecutor;
  final boolean validateEagerly;

build()方法：

public Retrofit build() {

      // 设置baseUrl，必填
      if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
      }

      // 设置callFactory，用于创建Call实例，这里默认使用的是OkHttpClient
      // 所以通过这里可以看出
      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }

      // 设置异步回调请求执行器，没有设置就使用默认的，在Platform.Android下默认返回主线程(UI线程)执行器
      // 主要在异步请求中会使用到
      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }


      // 创建CallAdapter集合，用于存放所有的callAdapter网络请求适配器
      List callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
      callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

      // 创建数据解析器。gson、jaskson等
      List converterFactories =
          new ArrayList<>(1 + this.converterFactories.size());
      // 首先会添加一个默认的BuiltInConverters
      converterFactories.add(new BuiltInConverters());
      converterFactories.addAll(this.converterFactories);

      // 创建Retrofit实例
      return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
          unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
    }

其实，build()方法中主要就是完成了Retrofit的一些配置，这个从最后Retrofit的构造方法中可以看出。

设置baseUrl

在Retrofit实例的创建中，baseUrl为必填属性，这里我们看下Builder.baseUrl()的实现。

public Builder baseUrl(String baseUrl) {
  // 非空判断
  checkNotNull(baseUrl, "baseUrl == null");
  // 根据传入的url生成一个HttpUrl对象，这个类主要是对http的url做一些封装
  HttpUrl httpUrl = HttpUrl.parse(baseUrl);
  if (httpUrl == null) {
    throw new IllegalArgumentException("Illegal URL: " + baseUrl);
  }
  return baseUrl(httpUrl);
}

public Builder baseUrl(HttpUrl baseUrl) {

  checkNotNull(baseUrl, "baseUrl == null");
  // 下面整个逻辑判断传入的url是否是以"/"结尾
  List pathSegments = baseUrl.pathSegments();
  if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
    throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
  }
  this.baseUrl = baseUrl;
  return this;
}

在上面baseUrl()方法中可知，url必须要以“/”结尾,这个也是在使用Retrofit中必须要注意的一点。

创建网络接口代理类

在Retrofit.create()中主要使用到了Java动态代理，如果对动态代理的实现机制不清楚的话，请自行学习，这里就不对动态代理做深入分析了。

在完成了Retrofit实例的创建后，就要通过Retrofit.create()方法创建一个网络请求代理类，这个类根据定义的网络请求接口生成。

ILoginService loginService = retrofit.create(ILoginService.class);

这里看下Retrofit.create()方法的具体实现:

  public  T create(final Class service) {

    // 1、首先判断类service是不是一个接口
    Utils.validateServiceInterface(service);
    // 2、validateEagerly默认是false
    if (validateEagerly) {
      // 3、提前加载method,这个方法的内部会调用loadServiceMethod()方法，所以这个将会在下面的动态代理中一并讲解。
      eagerlyValidateMethods(service);
    }

    // 4、创建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 {
            // 5、如果方法是来自对象的方法，则正常调用。像equal()、hashcode()等，在网络请求中这种情况一般不会发生。
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            
            // 6、在Android.Platform中isDefaultMethod()方法默认返回false，这里就忽略该方法。
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            
            // 7，这是动态代理方法中的核心，也是Retrofi他中的核心代码，这里将创建并最终返回网络请求调用的Call实例
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);
            OkHttpCall