Retrofit 学习笔记

前言

Retrofit是个极其优秀的库,特别是和rxjava结合起来，使用起来那是一个丝滑般爽。不过使用了一两年，现在才好好想起总结总结，下面直接用实际项目中的部分代码来进行分析Retrofit帮我们做了什么。

简单的使用

1. 创建Retrofit

        Retrofit.Builder().baseUrl(BuildConfig.HOST)
                .client(OKHTTP_CLIENT_NO_TOKEN)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build()

2. 创建含有网络请求信息的ApiService
3. 获取ApiService
   fun getApiService(): ApiService = RETROFIT.create(ApiService::class.java)
4. 调用ApiService 接口方法

Builder 过程

Retrofit 通过 Builder 模式创建：
先来直接看 Builder.build方法：

    public Retrofit build() {
      if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
      }

      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }

      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }

      // Make a defensive copy of the adapters and add the default Call adapter.
      List adapterFactories = new ArrayList<>(this.adapterFactories);
      adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

      // Make a defensive copy of the converters.
      List converterFactories = new ArrayList<>(this.converterFactories);

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

这是标准的build函数，检测一些可配置参数，没有设置就是赋默认值，然后创建目标对象。

创建Retrofit对象6个参数

这里创建Retrofit需要6个参数：

1. callFactory：okhttp3.Call.Factory

这里是我们传入的OkHttpClient 对象，如果我们没有传入，build方法会为我们创建一个默认的OkhttpClient对象。

2. baseUrl：HttpUrl

我们传入host字符串后会经过HttpUrl.parse(baseUrl);处理后转换为HttpUrl对象。

3. converterFactories：List

1. Converter.Factory 是什么？。
   CallAdapter.Factory是个抽象类：
   里面有三个方法：

   • responseBodyConverter（）返回Converter对象（负责把ResponseBody对象转为其他对象）
   • requestBodyConverter（）返回Converter对象（负责把其他对象转为RequestBody）
   • stringConverter（）返回Converter对象（把其他对象转为String对象）

   其中Converter对象是个转换接口，里面convert方法，负责把F转换为T对象。

2. converterFactories 里面有哪些对象？

   1. BuiltInConverters 对象
      在builder的构造方法里面创建了BuiltInConverters对象并添加到集合里面

   Builder(Platform platform) {
      this.platform = platform;
      // Add the built-in converter factory first. This prevents overriding its behavior but also
      // ensures correct behavior when using converters that consume all types.
      converterFactories.add(new BuiltInConverters());
    }
   

   2. GsonConverterFactory 对象
      在上面配置中我们添加了GsonConverterFactory.create() 实际是GsonConverterFactory 对象

4. adapterFactories：List

1. CallAdapter.Factory 是什么？
   一个抽象类，里面也是3个方法
   a. get():CallAdapter 返回一个CallAdapter 适配器对象（有两个方法，一返回Type，二把Call转为其他对象的adapter方法）
   b. getParameterUpperBound（） ：Type 返回参数上限类型
   c. getRawType 获取原始类型

2. adapterFactories里面对象是什么？
   a. RxJava2CallAdapterFactory 对象
   在前面配置中.addCallAdapterFactory(RxJava2CallAdapterFactory.create())实际是RxJava2CallAdapterFactory对象
   b. ExecutorCallAdapterFactory 对象
   在build方法中会执行adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor)); ，里面实际创建的是ExecutorCallAdapterFactory对象。

5. callbackExecutor：Executor

回调执行者。

      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }

而platform变量在builder构造方法中被初始化，Android平台下是Android对象，而platform.defaultCallbackExecutor();获得的是MainThreadExecutor对象

  static class Android extends Platform {
    @Override public Executor defaultCallbackExecutor() {
      return new MainThreadExecutor();
    }

    @Override CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
      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);
      }
    }
  }
}

6. validateEagerly：boolean

默认为false

create 方法做了什么

在刚开始用Retrofit时候一直很好奇，我们创建ApiService接口，没有创建任何实现对象，经过Create方法就可以直接调用接口的方法。
它这个方法里面做了什么呢。
来看下create的代码：

  public  T create(final Class service) {
  //验证是否是接口
    Utils.validateServiceInterface(service);
    //前面传入的参数，为false
    if (validateEagerly) {
     // 如果为true，会执行eagerlyValidateMethods方法，
     //里面会遍历接口的方法，创建对应的ServiceMethod对象并加到换成中
      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, 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