Retrofit跟OkHttp源码分析

• 网上已经有了相等多的分析博客,但终归是别人的知识点,倒不如自己走一遍流程,如果你看到了这篇博客,最好自己跟着思路对照源码过一遍哦!

Retrofit源码分析

Retrofit的构建

1. 在我们开发工作中使用Retrofit一般建立一个单例模式,避免每次请求都创建,Retrofit只是对OkHttp的封装,主要用了动态代理,并不涉及网络请求哦!

Retrofit retrofit = new Retrofit.Builder()
          .baseUrl(apiUrl) //网络头
          .client(getHttpClient()) //自己构建的okHttp对象
          .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //增加对Rxjava的支持,这里也是可以同时添加多个的支持
          .addConverterFactory(FastJsonConverterFactory.create()) //增加对阿里java对象转化支持,这里可以同时添加多个比如Gson等
          .build(); //开始构建Retrofit对象
  return retrofit;

• 注意: 这里可以通过client设置Okhttp对象,如果你没有设置,系统也会给你提供的,稍后分析,一般都需要自定义实现自定义拦截器功能,用于设置headers添加信息,日志打印,网络监听等操作,这些都是OkHttp做的事情,跟Retrofit无关

2. 查看Retrofit的Build中各个参数的含义: 构建者模式创建

private final Platform platform; //那个平台java/Android
private @Nullable okhttp3.Call.Factory callFactory; //okhttp网络请求,通过client传入
private HttpUrl baseUrl; //请求头
private final List converterFactories = new ArrayList<>(); //转换集合,用于requestBody转java对象
private final List callAdapterFactories = new ArrayList<>(); //适配器,一般是Rxjava支持链式调用
private @Nullable Executor callbackExecutor; //callBack的返回线程,对于Android来说通过MainHandler发送到UI线程的,默认的call返回在UI线程
private boolean validateEagerly; ////是否需要立即生效

3. 记住Build中各个参数的含义,通过build()方法构建一个Retrofit对象
   • 将通过Build添加的各种工厂实现类作为Retrofit对象的参数,构造一个Retrofit对象

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

okhttp3.Call.Factory callFactory = this.callFactory;
if (callFactory == null) { //如果没有创建OkHttpClient就新建,一般项目中都会自己创建用于拦截添加header等操作
  callFactory = new OkHttpClient();
}

Executor callbackExecutor = this.callbackExecutor;
if (callbackExecutor == null) { //没有指定callBack线程池Android默认MainThreadExecutor
  callbackExecutor = platform.defaultCallbackExecutor();
}

// 将RxJava2转化同原来Android默认转化添加到集合中,如果当前使用的是RxJava2的返回Observe对象,则使用RxJava2的线程池返回,
//如果返回的是Call对象,则使用默认的UI线程运行返回数据
List callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

// 返回值的适配器,使用谷歌的Gson,阿里的FastJson等,但是会加上默认的RequestBody直接返回
List converterFactories =
    new ArrayList<>(1 + this.converterFactories.size());

// 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()); //返回的是RequestBody
converterFactories.addAll(this.converterFactories);
//通过构建器中的各个参数传递给Retrofit创建对象
return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
    unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
}

4. 以上new Retrofit对象,其参数为:

Retrofit(okhttp3.Call.Factory callFactory, HttpUrl baseUrl,
List converterFactories, List callAdapterFactories,
@Nullable Executor callbackExecutor, boolean validateEagerly) {
  this.callFactory = callFactory;
  this.baseUrl = baseUrl;
  this.converterFactories = converterFactories; // Copy+unmodifiable at call site.
  this.callAdapterFactories = callAdapterFactories; // Copy+unmodifiable at call site.
  this.callbackExecutor = callbackExecutor;
  this.validateEagerly = validateEagerly;
}

5. 这里只是创建了一个Retrofit对象,而create()方法通过动态代理创建接口,仅当调用接口中的方法才会运行代理类中的invoke方法

mediaApi = RetrofitHelper.getInstance().getRetrofit(type).create(Class a);

//create方法分析
public  T create(final Class service) {
  //当前service类是否是接口
  Utils.validateServiceInterface(service);
  if (validateEagerly) { //是否提前加载service中声明的方法,如果需要,就调用下面方法
  //通过反射获取在service中声明的方法,并将所有方法缓存在serviceMethodCache集合中
  如果不需要缓存,则会在调用方法的时候在加载
    eagerlyValidateMethods(service);
  }
  //通过代理的方式实现http请求,返回一个代理对象.当通过代理对象调用我们声明方法时,会执行invocationHandler的invoke方法
  //对于retrofit.create(ApiInfo.class);只是返回newProxyInstance返回的类,并没有调用下面的invoke方法,只有在每次调用接口中的get/post方法时才会执行invoke方法,这个时候的method就是调用的接口方法
  return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class[] { service },
      new InvocationHandler() {
      //得到一个Android平台类型
        private final Platform platform = Platform.get();

        @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
            throws Throwable {
          // 方法是否来自Object,而不是接口的方法
          if (method.getDeclaringClass() == Object.class) {
            return method.invoke(this, args);
          }
          //Android中返回false,永远不会执行
          if (platform.isDefaultMethod(method)) {
            return platform.invokeDefaultMethod(method, service, proxy, args);
          }
          
          //这三句才是最重要的
          //1. 开始解析目前正在执行的方法,就是我们在接口中调用的get/post方法,loadServiceMethod解析get/post中的annocation
          ServiceMethod serviceMethod =
              (ServiceMethod) loadServiceMethod(method);
              //2. serviceMethod对象生成一个okHttpCall对象,serviceMethod中有网络的各种配置
          OkHttpCall