Retrofit源码学习之一

我们从简单的使用开始

implementation 'com.squareup.retrofit2:retrofit:2.4.0'

Retrofit 使用方法注解的方式把Java接口转化成HTTP请求

首先我们声明接口

public interface GitHubService {
   //获取github上用户信息
   @GET("users/{user}")
   Call userInfo(@Path("user") String user);
}

Retrofit使用四部曲

1. 构建一个Retrofit实例

Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("https://api.github.com/")
            .build();

2. 生成一个GitHubService接口的实现

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

3. 创建一个请求

Call call = service.userInfo("humanheima");

4.同步或者异步执行请求

4.1 同步请求

try {
    Response response = call.execute();
} catch (IOException e) {
    e.printStackTrace();
}

注意不要在主线程直接调用，不然会抛出android.os.NetworkOnMainThreadException

4.2 异步执行

call.enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {
            ResponseBody body = response.body();
            if (body != null) {
                try {
                    Log.d(TAG, "onResponse: " + body.string());
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

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

        }
});

1.构建一个Retrofit实例。

首先看一下Retrofit.Builder类的构造函数

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

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

Retrofit.Builder类的构造函数内部初始化了一个Platform实例。Platform代表Retrofit的使用平台。我们在Android中使用Retrofit,平台就是Android。

static class Android extends Platform {
    //默认的回调执行器
    @Override public Executor defaultCallbackExecutor() {
      return new MainThreadExecutor();
    }

    @Override CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
      if (callbackExecutor == null) throw new AssertionError();
      return new ExecutorCallAdapterFactory(callbackExecutor);
    }

    static class MainThreadExecutor implements Executor {
    //看到了Handler。可以猜想，回调之所以是在主线程执行，还是使用handler来实现的  
      private final Handler handler = new Handler(Looper.getMainLooper());

      @Override public void execute(Runnable r) {
          handler.post(r);
      }
    }
}

接下来看一下Retrofit.Builder类的build方法

public Retrofit build() {
    if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
    }
    //注释1处，初始化callFactory 
    okhttp3.Call.Factory callFactory = this.callFactory;
    if (callFactory == null) {
        callFactory = new OkHttpClient();
    }
    //初始化回调执行器
    Executor callbackExecutor = this.callbackExecutor;
    if (callbackExecutor == null) {
        //注释2处，使用平台默认的回调执行器
        callbackExecutor = platform.defaultCallbackExecutor();
    }

    //注释3处，防御性拷贝callAdapterFactories，并添加默认的CallAdapter.Factory
    List callAdapterFactories = new ArrayList<>
                                               (this.callAdapterFactories);
    callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

    //注释4处，防御性拷贝converters，并添加内置的converter factory 
    List converterFactories =
          new ArrayList<>(1 + this.converterFactories.size());
    //首先添加内置的converter factory到converter factory list中
    converterFactories.add(new BuiltInConverters());
    converterFactories.addAll(this.converterFactories);
    //创建Retrofit实例
    return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
          unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
}

注释1处，创建了一个OkHttpClient对象。

注释2处，如果没有传入回调执行器，则使用平台默认的回调执行器，在Android平台中就是一个MainThreadExecutor对象。

注释3处，添加了平台默认的CallAdapter.Factory。就是一个ExecutorCallAdapterFactory对象，传入的是MainThreadExecutor对象。

注释4处，首先添加了一个内置的Converter.Factory对象。是一个BuiltInConverters对象。

最后Retrofit.Builder类的build()方法返回了一个Retrofit实例。

Retrofit的构造函数

Retrofit(okhttp3.Call.Factory callFactory, HttpUrl baseUrl,
      List converterFactories, List callAdapterFactories,
      Executor callbackExecutor, boolean validateEagerly) {
    this.callFactory = callFactory;//是一个OkHttpClient对象
    this.baseUrl = baseUrl;
    this.converterFactories = converterFactories; 
    this.callAdapterFactories = callAdapterFactories; 
    this.callbackExecutor = callbackExecutor;
    this.validateEagerly = validateEagerly;
}

2. 生成一个GitHubService接口的实现

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

Retrofit的create 方法

public  T create(final Class service) {
    //1. 首先验证service是否合法
    Utils.validateServiceInterface(service);
    //2. 是否提前创建service里面的所有方法
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }
    //3. 创建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, Object[] args)throws Throwable {
             // service的所有方法调用，最终会转发到这里
            // 如果是Object的方法，就正常调用
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            //如果是default方法（Java8中的默认方法）,Android中不用管，一定是false
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            //3.1
            ServiceMethod serviceMethod =(ServiceMethod) 
                loadServiceMethod(method);
            //3.2
            OkHttpCall