[Android] Retrofit 源码分析之执行流程

前言

由于是第一次自己翻看源代码进行学习,加上基础不好,在看源代码的过程中简直痛苦不堪,但同时也暴露出了自己的许多问题。我觉得学习源代码是一件耗时但也收益颇多的学习方式,哪怕你暂时没有足够的时间自己去分析学习,也要擅于学习别人的经验总结。

Java 基础知识点

Retrofit 的功能涉及到了 Java 的『反射』、『注解』和『动态代理』。

公共技术点之 Java 反射 Reflection

公共技术点之 Java 注解 Annotation

公共技术点之 Java 动态代理

Retrofit 的主要接口和类

Retrofit 的代码并不是很多,其底层网络通信时交由 OkHttp 来完成的。其包结构如下图所示:



其中 retrofit2.http 包里面全部是用来定义 HTTP 请求的自定义注解。

接口

Call<T>

Call 接口的主要作用是发送一个 Http 请求,在 Retrofit 中的默认实现是 OkHttpCall<T>,也可以根据实际情况实现自己的 Call 类。Call 实现类需要实现两个请求发送方法:

// 同步请求方法,返回请求的结果
Response<T> execute() throws IOException;

// 异步请求方法,在 CallBack 中处理返回的结果
void enqueue(Callback<T> callback);

Callback

Call 的回调,该接口是 Retrofit 异步请求数据返回的接口,包含两个方法:

void onResponse(Call<T> call, Response<T> response);
void onFailure(Call<T> call, Throwable t);

Converter

数据转换器,该接口将 Http 请求返回的数据解析成 Java 对象,我们之前创建 Retrofit实例时有一句:

.addConverterFactory(GsonConverterFactory.create())

就是添加了一个 GsonConverter 来使用 Gson 将我们的结果转换成 Model 类。

CallAdapter

Call 的适配器,负责将 Call 对象转化成另一个对象,同样可在创建 Retrofit 实例时调用 .addCallAdapterFactory(Factory) 来添加。

Retrofit 执行步骤

在上一篇介绍 Retrofit 初步使用的文章里,已经知道 Retrofit 使用的基本步骤,这里再重新简单地介绍一遍:

// 创建接口
public interface APIInterface {
    @GET("/users/{user}")
    Call<TestModel> repo(@Path("user") String user);
  }

// 创建 Retrofit 实例
Retrofit retrofit= new Retrofit.Builder()
.baseUrl("https://api.github.com")
.addConverterFactory(GsonConverterFactory.create())
.build();

// 生成接口实现类
APIInterface service = retrofit.create(APIInterface.class);

// 调用接口实现类的请求方法,获取 Call 对象
Call<TestModel> model = service.repo("Guolei1130");

// 调用 Call 对象的异步执行方法
model.enqueue(Callback callback)

Retrofit 步骤分析

这里从代码层面来对上述步骤中的关键进行简要的分析:

创建 Retrofit 实例,生成接口的实现类

生成接口实现类时,编写了以下语句:

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

.create()的代码如下所示:

public <T> T create(final Class<T> 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, 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);
      }
    });
}

这里使用了『动态代理』,返回了一个 Proxy 代理类,调用接口中的任何方法都会调用 proxy 里的 invoke 方法。

调用接口实现类的请求方法,获取 Call 对象

接着上一步分析,我们知道当我们调用请求方法时:

Call<TestModel> model = service.repo("Guolei1130");

实际上会调用到 Proxy 的 invoke 方法。在该方法内,下面的三行代码是最为主要和重要的:

ServiceMethod serviceMethod = loadServiceMethod(method);
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
return serviceMethod.callAdapter.adapt(okHttpCall);

第一行 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;
}

该方法会根据 接口请求方法 method 来建造一个 ServiceMethod,put 到缓存里并返回。在建造 ServiceMethod时,会调用 createCallAdapter() 来为 ServiceMethod 添加一个 CallAdapter:

// ServiceMethod.Builder(this, method).build();
public ServiceMethod build() {
  callAdapter = createCallAdapter();
  ...
}

// ServiceMethod.createCallAdapter()
private CallAdapter<?> createCallAdapter() {
  Type returnType = method.getGenericReturnType();
  if (Utils.hasUnresolvableType(returnType)) {
    throw methodError(
        "Method return type must not include a type variable or wildcard: %s", returnType);
  }
  if (returnType == void.class) {
    throw methodError("Service methods cannot return void.");
  }
  Annotation[] annotations = method.getAnnotations();
  try {
    return retrofit.callAdapter(returnType, annotations);
  } catch (RuntimeException e) { // Wide exception range because factories are user code.
    throw methodError(e, "Unable to create call adapter for %s", returnType);
  }
}

这里会根据 method 的返回类型来创建相应的 CallAdapter,由于 Retrofit 的默认实现是 OkHttpCall,所以在这里会创建一个默认的 DefaultCallAdapter。至此,我们再回到 invoke() 的最后一行返回语句:

return serviceMethod.callAdapter.adapt(okHttpCall);

调用了 DefaultCallAdapter 不对传进来的 Call 对象做任何处理,所以我们通过调用接口实现类的方法,实际上最终获得了一个 OkHttpCall 对象,其具有两个请求执行方法,一个同步,一个异步。

调用同步方法时,会使用应用线程来发送请求;调用异步方法时会通过 OkHttp 的 Dispatcher 提供的线程来执行请求。

总结

通过本文,较为粗糙地从表层了解了 Retrofit 执行步骤中一步步在代码中传递的过程,尽管暂时没能深入代码内部透彻解析各个类和方法,但是通过这次分析,我自己对 Retrofit 的基本步骤已经有了更为深入的了解。

另外这种对框架,不能说了如指掌,但对他的实现多了一份认识的感觉,真的只有自己去研究过才能体会得到。

也希望各位大神能指出本文中结构或理解上的一些错误,同时希望这篇文章能帮助您粗略了解 Retrofit 的运行。

参考资料

Retrofit2 源码解析

Retrofit分析-漂亮的解耦套路

Retrofit2 源代码初步解读

Retrofit2 源码解析

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

推荐阅读更多精彩内容