备注

原发表于2016.05.03,资料已过时,仅作备份,谨慎参考

前言

大家好,我又来学习 Retrofit 了,可能这是最后一篇关于 Retrofit 框架的文章了。我发现源码分析这回事,当时看明白了,过些时候再看就想这写的啥玩意。所以大家还是多看多学多分析。

另外跟我自己文章结构组织也有很大关系,我尽量在以后加强这点,做到简洁清晰有层次。

这周我们要分析一下 ServiceMethod。

ServiceMethod 是什么

ServiceMethod 会将你的接口方法调用转化为一个 Call 对象。也就说对于每一个接口方法,他都会创建一个与之对应的 ServiceMethod,实际上上篇文章也有提到。

那么 ServiceMethod 是从哪开始的呢?

MyApi api = retrofit.create(MyApi.class);

这句代码总没有忘记吧?

create 方法根据你的『Http 接口』返回了一个『动态代理』,当我们调用接口方法时,会转发到『动态代理』的 invoke 方法。内有三句重点:

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

最后一句就不说了,把你的 OkHttpCall 转化适配成指定类型的 Call 对象。我们主要分析其余两句。

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

当接口方法调用时,会先从缓存(一个 Map)中找,如果没有的话就新建一个,我们看到 ServiceMethod 也是用到建造者模式:

result = new ServiceMethod.Builder(this, method).build();

传入了 retrofit 对象和我们调用的方法 method 作为参数创建了一个 ServiceMethod:

public Builder(Retrofit retrofit, Method method) {
this.retrofit = retrofit;
this.method = method;
// 获取 method 中的所有注解
this.methodAnnotations = method.getAnnotations();
// 获取 method 中方法的参数类型
this.parameterTypes = method.getGenericParameterTypes();
// 获得参数的值
this.parameterAnnotationsArray = method.getParameterAnnotations();
}

build() 方法

然后调用 build() 方法。

build() 方法内容比较多,主要是一些判断并根据 retrofit 对象的实例变量状态创建 ServiceMethod 的变量。关键是一下几行代码:

// 根据 retrofit 对象的 CallAdapterFactory 为 ServiceMethod 创建一个 callAdapter
callAdapter = createCallAdapter();
// 根据 retrofit 对象创建一个 responseConverter,默认是一个 BuildInConveter
responseConverter = createResponseConverter();
// 解析 method 的所有注解
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}

前两句代码都很好理解,这里讲一下 parseMethodAnnotation 方法,该方法内容是许多个判断语句,这里我们看其中一个判断:

if (annotation instanceof DELETE) {
parseHttpMethodAndPath("DELETE", ((DELETE) annotation).value(), false);
} else if (annotation instanceof GET) {
parseHttpMethodAndPath("GET", ((GET) annotation).value(), false);
} else if ...

可以看出就是对注解的类型进行判断,如果是 DELETE、POST、PATCH 等这样的 Http 请求方式,则调用 parseHttpMethodAndPath 设置 ServiceMethod 实例的 httpMethod 变量。

例如我们的接口是这样的:

@GET("/users/{user}")
Call<TestModel> repo(@Path("user") String user);

那么当我们调用 repo 方法时,会将 GET 设置到 httpMethod 中,将其值 "/users/{user}" 进一步解析,设置到 relativeUrl 中。

那么 repo(@Path("user") String user) 里的参数呢?我们之前创建 method 时获取了方法的『参数类型』和『参数值』,所以在解析过外层的想 @GET,@Headers 这样的注解后,就会进行方法参数注解的解析:

parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);

具体逻辑就不多说了,这里通过 Java 的 『反射机制』和『自定义注解』特性,使得我们能够通过一种简单的方式,把我们编写在 Http 接口的信息,都转化为了 ServiceMethod 所必要的变量值。

OkHttpCall

现在 ServiceMethod 创建好了,我们学习到他包含了许多东西,包括了我们要请求的地址,请求的方式以及 CallAdapter、Converter 等等。

现在我们要用他来构造一个 okHttpCall:

OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);

当你调用 okHttpCall 的 enqueue 方法或 execute 方法时,如果还没生成一个 okhttp3.Call 对象则会调用以下方法:

private okhttp3.Call createRawCall() throws IOException {
Request request = serviceMethod.toRequest(args);
okhttp3.Call call = serviceMethod.callFactory.newCall(request);
if (call == null) {
throw new NullPointerException("Call.Factory returned null.");
}
return call;
}

这里创建了调用了 ServiceMethod.toRequest(args) 方法构建了一个 HTTP Request 对象:

RequestBuilder requestBuilder = new RequestBuilder(httpMethod, baseUrl, relativeUrl, headers,
contentType, hasBody, isFormEncoded, isMultipart);

可以看到就是把我们编写的信息作为参数去构建的。

这里的 Request 对象和 Call 对象实际上都属于 okHttp 的范畴了,也就是说至此我们的『Http 接口』最终转化为了一个『okhttp3.Call』并将工作交给了 okHttp 去执行。

那么 Retrofit 框架的工作也就大体完成了。

结语

实际上这节的内容并不复杂,只是细节的东西太多了,有许多 Retrofit 框架以外的内容,我自己也并不熟悉。所以其实内容比较杂乱,但是 Retrofit 的主要思想就是利用 Java 的特性,来减少了编写代码时的工作量。

这确实是一个框架设计的经典作品,值得大家去深入学习。

[旧][Android] Retrofit 源码分析之 ServiceMethod 对象的更多相关文章

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

    备注 原发表于2016.04.23,资料已过时,仅作备份,谨慎参考 前言 由于是第一次自己翻看源代码进行学习,加上基础不好,在看源代码的过程中简直痛苦不堪,但同时也暴露出了自己的许多问题.我觉得学习源 ...

  2. [旧][Android] Retrofit 源码分析之 Retrofit 对象

    备注 原发表于2016.04.27,资料已过时,仅作备份,谨慎参考 前言 在上一周学习了一下 Retrofit 的执行流程.接下来的文章要更为深入地学习 Retrofit 的各个类,这次我们先学习一下 ...

  3. Retrofit源码分析(一)

    1.基本用法 创建接口 public interface GitHubService { @GET("users/{user}/repos") Observable<List ...

  4. Appium Android Bootstrap源码分析之启动运行

    通过前面的两篇文章<Appium Android Bootstrap源码分析之控件AndroidElement>和<Appium Android Bootstrap源码分析之命令解析 ...

  5. Appium Android Bootstrap源码分析之命令解析执行

    通过上一篇文章<Appium Android Bootstrap源码分析之控件AndroidElement>我们知道了Appium从pc端发送过来的命令如果是控件相关的话,最终目标控件在b ...

  6. Appium Android Bootstrap源码分析之控件AndroidElement

    通过上一篇文章<Appium Android Bootstrap源码分析之简介>我们对bootstrap的定义以及其在appium和uiautomator处于一个什么样的位置有了一个初步的 ...

  7. Android HandlerThread 源码分析

    HandlerThread 简介: 我们知道Thread线程是一次性消费品,当Thread线程执行完一个耗时的任务之后,线程就会被自动销毁了.如果此时我又有一 个耗时任务需要执行,我们不得不重新创建线 ...

  8. Android Choreographer 源码分析

    Choreographer 的作用主要是配合 Vsync ,给上层 App 的渲染提供一个稳定的 Message 处理的时机,也就是 Vsync 到来的时候 ,系统通过对 Vsync 信号周期的调整, ...

  9. Spring AOP 源码分析 - 创建代理对象

    1.简介 在上一篇文章中,我分析了 Spring 是如何为目标 bean 筛选合适的通知器的.现在通知器选好了,接下来就要通过代理的方式将通知器(Advisor)所持有的通知(Advice)织入到 b ...

随机推荐

  1. Solon Web 开发,八、校验、及定制与扩展

    Solon Web 开发 一.开始 二.开发知识准备 三.打包与运行 四.请求上下文 五.数据访问.事务与缓存应用 六.过滤器.处理.拦截器 七.视图模板与Mvc注解 八.校验.及定制与扩展 九.跨域 ...

  2. 乡亲们,我们创建了 Dapr 中文交流频道

    我们创建了 Dapr 中文交流 QQ 频道,欢迎大家加入!加入方式在文章最后一节. 为什么要创建频道? 解决什么问题 专业性,"你可以在我们群里面钓鱼,因为都是水" 你肯定加过非常 ...

  3. golang中的标准库context解读

    简介 golang 中的创建一个新的 goroutine , 并不会返回像c语言类似的pid,所有我们不能从外部杀死某个goroutine,所有我就得让它自己结束,之前我们用 channel + se ...

  4. python 爬虫爬取历年双色球开奖信息

    目前写的这些爬虫都是些静态网页,对于一些高级网页(像经过JS渲染过的页面),目前技术并不能解决,自己也是在慢慢学习过程中,如有错误,欢迎指正: 对面前端知识本人并不懂,过程中如果涉及到前端知识,也是百 ...

  5. For Update 加锁分析

    MySQL InnoDB 锁 - For Update 加锁分析: 1. InnoDB锁 简单介绍 2. 当前读加锁分析:REPEATABLE-READ 可重复读.READ-COMMITTED 读已提 ...

  6. python19day

    内容回顾 软件开发规范 预计 递归函数1天 re模块2天 logging模块+包的导入+带参数的装饰器1-2天 面向对象6天 网络编程4天 并发编程5-6天 数据库5天 今日内容 模块和实际工作之间的 ...

  7. 基于Python的某大学某学院新生高考成绩分析

    # coding=gbk import pandas as pd import numpy as np import matplotlib.pyplot as plt from pylab impor ...

  8. Linux 配置mysql 免安装版。

    二.Linux配置 mysql ? 1.linux配置mysql(要求全部使用免安装版) 5.1.从官网下载mysql5.tar.gz 5.2.使用xftp把mysql的压缩包上传到服务器上 5.3. ...

  9. 【ASP.NET Core】设置Web API 响应的数据格式——Produces 特性篇

    开春首文,今天老周就跟各位大伙伴们聊一个很简单的话题:怎么设定API响应的数据格式. 说本质一点,就是设置所返回内容的 MIME 类型(Content-Type 头).当然了,咱们不会使用在HTTP管 ...

  10. mac 下载MySQL后,需要这样打开

    1.打开mac终端 2.输入 export PATH=${PATH}:/usr/local/mysql/bin 3.输入mysql -u root -p 4输入密码