Retrofit源码解析

本文基于Retrofit 2.3.0，OkHttp 3.8.0进行分析。

使用示例

public class GitHubRetrofit {

    private Retrofit retrofit;

    public static GitHubRetrofit newInstance() {
        return new GitHubRetrofit();
    }

    private GitHubRetrofit() {
        OkHttpClient okHttpClient = new OkHttpClient.Builder()
                .build();
        retrofit = new Retrofit.Builder()
                .baseUrl("http://www.github.com/")
                .client(okHttpClient)
                .build();
    }

    public Call createPop() {
        Pop pop = retrofit.create(Pop.class);
        return pop.robots();
    }

    public interface Pop {
        @GET("robots.txt")
        Call robots();
    }
}

Response execute = GitHubRetrofit.newInstance().createPop().execute();

以上是Retrofit的简单使用示例，下面从以上代码为入口分析其内部实现。

源码分析

Retrofit实例化

先来分析下Retrofit的实例化过程

retrofit = new Retrofit.Builder()
                .baseUrl("http://www.github.com/")
                .client(okHttpClient)
                .build();

很明显Retrofit实例的创建采用了建造者模式。

通过baseUrl方法设置网络请求的base url。

client方法接收OkHttpClient实例，整个网路请求是由Retrofit和OkHttp结合完成的，关于OkHttp的内容本文不做深入讲解。

接下来看Builder类的build方法，以下是代码实现

public Retrofit build() {
    ...
      // 检查是否设置OkHttp实例，如果没有，提供默认实现
      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }

      // 检查是否设置callback executor
      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }

      // Make a defensive copy of the adapters and add the default Call adapter.
      // 使用集合保存所有通过addCallAdapterFactory方法添加的CallAdapter.Factory实现类实例，并保存默认实现
      List adapterFactories = new ArrayList<>(this.adapterFactories);
      adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

      // Make a defensive copy of the converters.
      // 使用集合保存所以通过addConverterFactory方法添加的Converter.Factory实现类实例
      List converterFactories = new ArrayList<>(this.converterFactories);

      return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
          callbackExecutor, validateEagerly);
    }

Retrofit中的CallAdapter.Factory，Converter.Factory成员变量都采用了面向接口编程的方式，极大的提高了程序的可扩展性。

比如CallAdapter.Factory，框架提供了默认实现类ExecutorCallAdapterFactory来支持Call返回类型。如果想要支持Observable为返回类型，只需要调用addCallAdapterFactory(RxJavaCallAdapterFactory.create())。

platform.defaultCallbackExecutor()，返回的是MainThreadExecutor实例，内部使用Handler实现

platform.defaultCallAdapterFactory()，返回的是ExecutorCallAdapterFactory实例

Retrofit创建接口实现类及实例

Retrofit.create

GitHubRetrofit.newInstance().createPop().execute();

public Call createPop() {
        Pop pop = retrofit.create(Pop.class);
        return pop.robots();
}

以上代码表明Retrofit的create方法创建并返回了一个Pop接口的实例

接下来分析create方法，源码如下

public  T create(final Class service) {
    // 校验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 {
            // 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);
            }
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);
            OkHttpCall