Retrofit源码解析

前言

retrofit作为最近非常火的一个网络请求框架,已经被很多同学应用到了项目中。但是同学们都知道它运作的一个流程吗?我们不仅要知其然,更要知其所以然。看过很多人都写过了对retrofit的解析,而且都写的特别不错。但是别人写的始终是别人写的(包括我这篇),同学们一定要自己跟踪一遍执行的流程,相信一定会有很大的收获。之前总是看别人对源码的分析,过不了几天就忘了,但是这次把流程过了一遍,对我产生了很大的帮助。毕竟最快的学习方法出了多敲代码之外就是阅读优秀的开源代码了。

retrofit简介

retrofit官方介绍:“A type-safe REST client for Android and Java.”它可以通过注解来描述Http请求,URL参数,查询参数,同时,它还支持多个请求体和文件上传。

使用retrofit的好处:

1.底层进行网络请求的是okhttp,retrofit是对okhttp进行了一个上层的封装,okhttp在android 4.4已经被加入源码,所以它的强大就不用我多说了吧

2.使用灵活,支持多种数据的解析,无间配合rxjaxa

3.功能模块高度封装,解耦彻底

retrofit网络请求流程

retrofit网络请求流程图

从图中可以看出retrofit起到的是一个中间者的作用,app应用层通过retrofit请求网络,实际上是retrofit对请求的url、请求头等信息进行一层封装之后交给okhttp去请求服务器,之后服务器返回原始数据给okhttp,okhttp再交给retrofit进行数据转换,最终在应用层就看到了我们想要的结果。

Retrofit实例创建代码

Retrofit使用建造者模式创建所需对象,接下来结合源码分析:

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());
    }

public Builder() {
     //通过构造函数找到运行平台
      this(Platform.get());
    }

private static final Platform PLATFORM = findPlatform();

  static Platform get() {
    return PLATFORM;
  }

  private static Platform findPlatform() {
    try {
     //要求jvm查找并加载指定类,jvm会执行改类的静态代码块
      Class.forName("android.os.Build");
      if (Build.VERSION.SDK_INT != 0) {
        return new Android();
      }
    } catch (ClassNotFoundException ignored) {
    }
    try {
      Class.forName("java.util.Optional");
      return new Java8();
    } catch (ClassNotFoundException ignored) {
    }
    try {
      Class.forName("org.robovm.apple.foundation.NSObject");
      return new IOS();
    } catch (ClassNotFoundException ignored) {
    }
    return new Platform();
  }

上面代码是通过Retrofit.Builder的构造方法找到运行平台,在这里肯定返回的是Android平台;

public Builder baseUrl(String baseUrl) {
      //对baseUrl进行非空检查,为空抛出一个异常
      checkNotNull(baseUrl, "baseUrl == null");
      //将baseUrl转换为HttpUrl对象,这里会验证baseUrl是否为一个合法的Url地址
      HttpUrl httpUrl = HttpUrl.parse(baseUrl);
      if (httpUrl == null) {
        throw new IllegalArgumentException("Illegal URL: " + baseUrl);
      }
      return baseUrl(httpUrl);
    }

public Builder baseUrl(HttpUrl baseUrl) {
      checkNotNull(baseUrl, "baseUrl == null");
      List<String> pathSegments = baseUrl.pathSegments();
      //baseUrl是否以"/"结尾
      if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
        throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
      }
      this.baseUrl = baseUrl;
      return this;
    }

static <T> T checkNotNull(T object, String message) {
    if (object == null) {
      throw new NullPointerException(message);
    }
    return object;
  }

上面代码是build.baseUrl()方法的源码,主要进行的工作是检查url地址是否为空且是否合法

接下来是添加转换器和rajaxa适配器,代码很简单

 /** Add converter factory for serialization and deserialization of objects. */
    public Builder addConverterFactory(Converter.Factory factory) {
      converterFactories.add(checkNotNull(factory, "factory == null"));
      return this;
    }

    /**
     * Add a call adapter factory for supporting service method return types other than {@link
     * Call}.
     */
    public Builder addCallAdapterFactory(CallAdapter.Factory factory) {
      adapterFactories.add(checkNotNull(factory, "factory == null"));
      return this;
    }

至于validateEagerly()这个方法,我觉得大部分同学都没用过,我也是看了源码才知道有这个方法,那么这个方法用什么作用呢?

public Builder validateEagerly(boolean validateEagerly) {
      this.validateEagerly = validateEagerly;
      return this;
    }

点进去看发现也只是将validateEagerly的值改变了,那么它的作用是什么,我后面讲retrofit.create()方法的时候再说。
参数都设置好呢,接下来就要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<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
      adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

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

      return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
          callbackExecutor, validateEagerly);
    }
okhttp3.Call.Factory callFactory 的实现

从 okhttp3.Call.Factory callFactory = this.callFactory(创建一个okhttpCilent对象)可以看出默认的网络请求是通过okhttp进行的。以上retrofit就把参数都配置好了,接下来是retrofit对接口的提供信息进行包装。

对接口中的注解、方法和参数进行包装

接下来就是重点了,retrofit通过create方法对接口中的注解、方法和参数进行包装

public <T> T create(final Class<T> service) {
    Utils.validateServiceInterface(service);
   //是否验证在生成Retrofit实例时提供的配置
    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, 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 = loadServiceMethod(method);
            OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
            return serviceMethod.callAdapter.adapt(okHttpCall);
          }
        });
  }

private void eagerlyValidateMethods(Class<?> service) {
    Platform platform = Platform.get();
    //遍历接口中的方法
    for (Method method : service.getDeclaredMethods()) {
      if (!platform.isDefaultMethod(method)) {
        loadServiceMethod(method);
      }
    }
  }

  ServiceMethod loadServiceMethod(Method method) {
    ServiceMethod result;
    synchronized (serviceMethodCache) {
      result = serviceMethodCache.get(method);
      if (result == null) {
        result = new ServiceMethod.Builder(this, method).build();
        //将请求添加到缓存
        serviceMethodCache.put(method, result);
      }
    }
    return result;
  }

其实validateEagerly为true时就是提前验证在生成Retrofit实例时提供的配置。可以看到它最终是生成了一个ServiceMethod对象,而动态代理中也是要生成ServiceMethod对象。
ServiceMethod就是对接口中的方法进行验证后包装成了一个HTTP请求。
来看一下 Proxy.newProxyInstance(
service.getClassLoader(),
new Class<?>[] { service },
new InvocationHandler())三个参数的意义

  • ClassLoader loader:定义了由哪个ClassLoader对象来对生成的代理对象进行加载

  • Class<?>[] interfaces:一个Interface对象的数组,表示的是我将要给我需要代理的对象提供一组什么接口,如果我提供了一组接口给它,那么这个代理对象就宣称实现了该接口(多态),这样我就能调用这组接口中的方法了

  • InvocationHandler handler:一个InvocationHandler对象,表示的是当我这个动态代理对象在调用方法的时候,会关联到哪一个InvocationHandler对象上

再看一下 invoke(Object proxy, Method method, Object... args)中的三个参数

  • Object proxy:指代我们所代理的那个真实对象
  • Method method:指代的是我们所要调用真实对象的某个方法的Method对象
  • Object[] args:指代的是调用真实对象某个方法时接受的参数

代理的作用是:当我们把包含网络请求接口的类传入到Retrofit的create方法后,就会利用动态代理模式,将接口解析包装成ServiceMethod,再转化成OkHttpCall供OKhttp调用。

最后通过okhttp发送给服务器,就完成了一次网络请求。
还有许多细节没有讲到,比如为什么通过注解就可以决定post、get等请求及添加head。这里就交给同学们自己去摸索啦

喜欢本文的朋友请点个赞,谢谢啦

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容