Retrofit2 源码解析

本文主要用于自我学习和交流，如有错误欢迎指正，不胜感激

先看一下我们通常的使用方法

// 1 初始化Retrofit,设置相关参数
Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .build();

// 2 通过动态代理创建解析出定义API接口中的方法和注解参数，并创建方法实例
GitHubService service = retrofit.create(GitHubService.class);
Call> repos = service.listRepos("octocat"); // 此处会执行动态代理InvokeHandler的invoke方法

// 3 最终调用执行方法，实际是调用的OkHttp3的网络请求，这里会在下一篇文章的解析
repos.enqueue(new Callback>() {
            @Override
            public void onResponse(Call> call, Response> response) {
            }
            @Override
            public void onFailure(Call> call, Throwable t) {
            }
        })

一、Retrofit初始化

==建造者模式==，使用Builder来创建复杂对象Retrofit

    Builder(Platform platform) {
      this.platform = platform;
      // 添加了默认的转换器工厂
      converterFactories.add(new BuiltInConverters());
    }

    public Builder() {
      // 无参构造方法，自动获取平台来初始化Android,Java8
      this(Platform.get());
    }

我们主要看一下Retrofit.Builder的==build==方法

/**
    * Create the {@link Retrofit} instance using the configured values.
    * 

    * Note: If neither {@link #client} nor {@link #callFactory} is called a default {@link
    * OkHttpClient} will be created and used.
    * 通过配置创建Retrofit实例，如果没有给Retrofit设置client或者callFactory,
    * 那么会创建并使用默认的OkHttpClient
    */

    public Retrofit build() {
      // 1.1 检验baseUrl是否为空
      if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
      }

      // 1.2 获取执行网络请求调用call的callFactory,如果没有则会使用默认的OkHttpClient
      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }

      // 1.3 获取默认的回调执行器，没有设置会使用默认平台的执行器,主要用于执行call中返回的execute,request,enqueue等方法
      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }

      // 1.4 制作适配器的防御副本并添加默认的呼叫适配器。
      // Make a defensive copy of the adapters and add the default Call adapter.
      List adapterFactories = new ArrayList<>(this.adapterFactories);
     adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

      // 1.5 制作转换器的防御副本
      // Make a defensive copy of the converters.
      List converterFactories = new ArrayList<>(this.converterFactories);

      // 1.6 使用上述参数创建retrofit对象
      return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
          callbackExecutor, validateEagerly);
    }

二、retrofit创建接口实例

下面我们先分析一下create中进行的操作

  @SuppressWarnings("unchecked") // Single-interface proxy creation guarded by parameter safety.
  public  T create(final Class service) {
    // 2.1 校验传入的参数是否是interface类型
    Utils.validateServiceInterface(service);

    // 这里validateEagerly默认初始化为false
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }

    // 2.2 使用动态代理，解析接口方法的注解和申明字段，并创建传入接口的实例
    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 {
            // 如果是继承自父类Object的方法
            // If the method is a method from Object then defer to normal invocation.
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }

            // 平台自带的方法
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }

            // 步骤一 ：Service接口上申明的方法, 这里会解析方法的注解，参数和返回值，并根据相关的信息找到对应的转换器Converter和CallAdapter，这些信息都将保存在ServiceMethod中,最后将方法参数和ServiceMethod存入OkHttpCall中
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);
            OkHttpCall