面试官：关于 Retrofit 你知道多少？

最新推荐文章于 2024-05-09 18:24:01 发布

2401_84544780

最新推荐文章于 2024-05-09 18:24:01 发布

阅读量7

点赞数 20

分类专栏：程序员文章标签： retrofit

本文链接：https://blog.csdn.net/2401_84544780/article/details/138418684

版权

程序员专栏收录该内容

169 篇文章 0 订阅

订阅专栏

本文详细解释了Retrofit中ServiceMethod、OkHttpCall和CallAdapter的工作原理，涉及接口方法调用到HTTP请求的转换过程，包括缓存策略、callfactory、calladapter、responseconverter和parameterhandlers的角色。同时提到了RxJavaCallAdapterFactory在处理Observable返回类型时的适配逻辑。

摘要由CSDN通过智能技术生成

ServiceMethod serviceMethod = loadServiceMethod(method);

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

return serviceMethod.callAdapter.adapt(okHttpCall);

}

});

如果调用的是 Object 的方法，例如 equals， toString，那就直接调用。如果是default 方法（Java 8 引入），就调用 default 方法。这些我们都先不管，因为我们在安卓平台调用 listRepos ，肯定不是这两种情况，那这次调用真正干活的就是这三行代码了（好好记住这三行代码，因为接下来很长的篇幅都是在讲它们 😃 ）：

ServiceMethod serviceMethod = loadServiceMethod(method);

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

return serviceMethod.callAdapter.adapt(okHttpCall);

在继续分析这三行代码之前,先看一个流程图

这三行代码基本就是对应于流程图中轴上部了， ServiceMethod ， build OkHttpCall， CallAdapter adapt

2.4 ServiceMethod

ServiceMethod<T> 类的作用正如其 JavaDoc所言：

Adapts an invocation of an interface method into an HTTP call. 把对接口方法的调用转为一次 HTTP 调用。

一个 ServiceMethod 对象对应于一个 API interface 的一个方法， loadServiceMethod(method)方法负责加载 ServiceMethod ：

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;

}

这里实现了缓存逻辑，同一个 API 的同一个方法，只会创建一次。这里由于我们每次获取 API 实例都是传入的 class 对象，而 class 对象是进程内单例的，所以获取到它的同一个方法 Method 实例也是单例的，所以这里的缓存是有效的。

我们再看看 ServiceMethod 的构造函数：

ServiceMethod(Builder builder) {

this.callFactory = builder.retrofit.callFactory();

this.callAdapter = builder.callAdapter;

this.baseUrl = builder.retrofit.baseUrl();

this.responseConverter = builder.responseConverter;

this.httpMethod = builder.httpMethod;

this.relativeUrl = builder.relativeUrl;

this.headers = builder.headers;

this.contentType = builder.contentType;

this.hasBody = builder.hasBody;

this.isFormEncoded = builder.isFormEncoded;

this.isMultipart = builder.isMultipart;

this.parameterHandlers = builder.parameterHandlers;

}

成员很多，但这里我们重点关注四个成员： callFactory， callAdapter ， responseConverter 和 parameterHandlers 。

1.callFactory负责创建 HTTP 请求，HTTP 请求被抽象为了okhttp3.Call 类，它表示一个已经准备好，可以随时执行的 HTTP 请求；

2.callAdapter 把 retrofit2.Call<T>转为 T （注意和 okhttp3.Call 区分开来，retrofit2.Call<T>表示的是对一个 Retrofit 方法的调用），这个过程会发送一个 HTTP 请求，拿到服务器返回的数据（通过 okhttp3.Call实现），并把数据转换为声明的 T 类型对象（通过 Converter<F, T> 实现）；

3.responseConverter 是 Converter<ResponseBody, T> 类型，负责把服务器返回的数据（JSON、XML、二进制或者其他格式，由 ResponseBody封装）转化为 T 类型的对象；

4.parameterHandlers 则负责解析 API 定义时每个方法的参数，并在构造 HTTP 请求时设置参数；

它们的使用稍后再分析，这里先看看它们的创建（代码比较分散，就不贴太多代码了，大多是结论）：

2.4.1 callFactory

this.callFactory = builder.retrofit.callFactory()，所以 callFactory 实际上由 Retrofit 类提供，而我们在构造 Retrofit 对象时，可以指定 callFactory，如果不指定，将默认设置为一个 okhttp3.OkHttpClient。

2.4.2 callAdapter

private CallAdapter<?> createCallAdapter() {

// 省略检查性代码

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

}

可以看到， callAdapter 还是由 Retrofit 类提供。在 Retrofit 类内部，将遍历一个 CallAdapter.Factory 列表，让工厂们提供，如果最终没有工厂能（根据 returnType 和 annotations）提供需要的 CallAdapter，那将抛出异常。而这个工厂列表我们可以在构造 Retrofit 对象时进行添加。

2.4.3， responseConverter

private Converter<ResponseBody, T> createResponseConverter() {

Annotation[] annotations = method.getAnnotations();

try {

return retrofit.responseBodyConverter(responseType, annotati ons);

} catch (RuntimeException e) {

// Wide exception range because factories are user code.

throw methodError(e, “Unable to create converter for %s”, re sponseType);

}

同样，responseConverter 还是由 Retrofit 类提供，而在其内部，逻辑和创建 callAdapter 基本一致，通过遍历 Converter.Factory列表，看看有没有工厂能够提供需要的 responseBodyConverter。工厂列表同样可以在构造 Retrofit 对象时进行添加。

2.4.4 parameterHandlers

每个参数都会有一个 ParameterHandler，由 ServiceMethod#parseParameter方法负责创建，其主要内容就是解析每个参数使用的注解类型（诸如 Path ， Query ， Field 等），对每种类型进行单独的处理。构造 HTTP 请求时，我们传递的参数都是字符串，那 Retrofit 是如何把我们传递的各种参数都转化为 String 的呢？还是由 Retrofit 类提供 converter！

Converter.Factory 除了提供上一小节提到的 responseBodyConverter，还提供 requestBodyConverter和 stringConverter，API 方法中除了 @Body 和 @Part 类型的参数，都利用 stringConverter 进行转换，而 @Body 和 @Part 类型的参数则利用 requestBodyConverter进行转换。

这三种 converter 都是通过“询问”工厂列表进行提供，而工厂列表我们可以在构造 Retrofit 对象时进行添加。

2.4.5 工厂让各个模块得以高度解耦

上面提到了三种工厂： okhttp3.Call.Factory， CallAdapter.Factory 和 Converter.Factory，分别负责提供不同的模块，至于怎么提供、提供何种模块，统统交给工厂，Retrofit 完全不掺和，它只负责提供用于决策的信息，例如参数/返回值类型、注解等。

这不正是我们苦苦追求的高内聚低耦合效果吗？解耦的第一步就是面向接口编程，模块之间、类之间通过接口进行依赖，创建怎样的实例，则交给工厂负责，工厂同样也是接口，添加（Retrofit doc 中使用 install 安装一词，非常贴切）怎样的工厂，则在最初构造 Retrofit 对象时决定，各个模块之间完全解耦，每个模块只专注于自己的职责，全都是套路，值得反复玩味、学习与模仿。

除了上面重点分析的这四个成员， ServiceMethod中还包含了 API 方法的 url 解析等逻辑，包含了众多关于泛型和反射相关的代码，有类似需求的时候，也非常值得学习模仿

2.5 OkHttpCall

终于把 ServiceMethod 看了个大概，接下来我们看看 OkHttpCall 。 OkHttpCall 实现了 retrofit2.Call ，我们通常会使用它的 execute()和 enqueue(Callback<T> callback)接口。前者用于同步执行 HTTP 请求，后者用于异步执行。

2.5.1，先看 execute()

@Override

public Response execute() throws IOException {

okhttp3.Call call;

synchronized (this) {

// 省略部分检查代码

call = rawCall;

if (call == null) {

try {

call = rawCall = createRawCall();

} catch (IOException | RuntimeException e) {

creationFailure = e;

throw e;

}

return parseResponse(call.execute());

…

}

主要包括三步:

1.创建 okhttp3.Call ，包括构造参数；

2.执行网络请求；

3.解析网络请求返回的数据；

createRawCall() 函数中，我们调用了 serviceMethod.toRequest(args) 来创建 okhttp3.Request ，而在后者中，我们之前准备好的 parameterHandlers 就派上了用场。

然后我们再调用 serviceMethod.callFactory.newCall(request) 来创建 okhttp3.Call，这里之前准备好的 callFactory同样也派上了用场，由于工厂在构造 Retrofit 对象时可以指定，所以我们也可以指定其他的工厂（例如使用过时的 HttpURLConnection 的工厂），来使用其它的底层 HttpClient实现。

我们调用 okhttp3.Call#execute() 来执行网络请求，这个方法是阻塞的，执行完毕之后将返回收到的响应数据。收到响应数据之后，我们进行了状态码的检查，通过检查之后我们调用了 serviceMethod.toResponse(catchingBody) 来把响应数据转化为了我们需要的数据类型对象。在 toResponse 函数中，我们之前准备好的 responseConverter 也派上了用场。

好了，之前准备好的东西都派上了用场，还好没有白费 😃

2.5.2 再看 enqueue(Callback<T> callback)

这里的异步交给了 okhttp3.Call#enqueue(Callback responseCallback)来实现，并在它的 callback 中调用 parseResponse 解析响应数据，并转发给传入的 callback。

2.6 CallAdapter

终于到了最后一步了， CallAdapter<T>#adapt(Call<R> call)函数负责把 retrofit2.Call<R> 转为 T 。这里 T 当然可以就是 retrofit2.Call<R> ，这时我们直接返回参数就可以了，实际上这正是 DefaultCallAdapterFactory创建的 CallAdapter的行为。至于其他类型的工厂返回的 CallAdapter 的行为，这里暂且不表，后面再单独分析。

至此，一次对 API 方法的调用是如何构造并发起网络请求、以及解析返回数据，这整个过程大致是分析完毕了。对整个流程的概览非常重要，结合 stay 画的流程图，应该能够比较轻松地看清整个流程了。

虽然我们还没分析完，不过也相当于到了万里长征的遵义，终于可以舒一口气了 😃

三、`retrofit-adapters` 模块

retrofit 模块内置了 DefaultCallAdapterFactory和 ExecutorCallAdapterFactory，它们都适用于 API 方法得到的类型为 retrofit2.Call 的情形，前者生产的 adapter 啥也不做，直接把参数返回，后者生产的 adapter 则会在异步调用时在指定的 Executor 上执行回调。

retrofit-adapters 的各个子模块则实现了更多的工厂： GuavaCallAdapterFactory ， Java8CallAdapterFactory 和 RxJavaCallAdapterFactory 。这里我主要分析 RxJavaCallAdapterFactory，下面的内容就需要一些 RxJava 的知识了，不过我想使用 Retrofit 的你，肯定也在使用RxJava 😃

RxJavaCallAdapterFactory#get方法中对返回值的类型进行了检查，只支持 rx.Single ， rx.Completable 和 rx.Observable ，这里我主要关注对 rx.Observable 的支持。

RxJavaCallAdapterFactory#getCallAdapter 方法中对返回值的泛型类型进行了进一步检查，例如我们声明的返回值类型为 Observable<List<Repo>>，泛型类型就是 List<Repo> ，这里对 retrofit2.Response 和retrofit2.adapter.rxjava.Result 进行了特殊处理，有单独的 adapter 负责进行转换，其他所有类型都由 SimpleCallAdapter负责转换。

那我们就来看看 SimpleCallAdapter#adapt

@Override

public Observable adapt(Call call) {

Observable observable = Observable.create(new CallOnSubscri be<>(call))

.lift(OperatorMapResponseToBodyOrError.instance()); if (scheduler != null) {

return observable.subscribeOn(scheduler);

}

return observable;

}

这里创建了一个 Observable ，它的逻辑由 CallOnSubscribe 类实现，同时使用了一个 OperatorMapResponseToBodyOrError 操作符，用来把 retrofit2.Response 转为我们声明的类型，或者错误异常类型。

我们接着看 CallOnSubscribe#call ：

@Override

public void call(final Subscriber<? super Response> subscribe r) {

// Since Call is a one-shot type, clone it for each new subscr iber.

Call call = originalCall.clone();

// Wrap the call in a helper which handles both unsubscription and backpressure.

RequestArbiter requestArbiter = new RequestArbiter<>(call, subscriber);

subscriber.add(requestArbiter);

subscriber.setProducer(requestArbiter);

}

代码很简短，只干了三件事：

1.clone 了原来的 call，因为 okhttp3.Call 是只能用一次的，所以每次都是新 clone 一个进行网络请求；

2.创建了一个叫做 RequestArbiter 的 producer，别被它的名字吓懵了，它就是个 producer；

3.把这个 producer设置给 subscriber；

简言之，大部分情况下 Subscriber 都是被动接受 Observable push 过来的数据，但要是 Observable发得太快，Subscriber 处理不过来，那就有问题了，所以就有了一种 Subscriber 主动 pull 的机制，而这种机制就是通过 Producer 实现的。给 Subscriber 设置 Producer 之后（通过 Subscriber#setProducer 方法）， Subscriber 就会通过 Producer 向上游根据自己的能力请求数据（通过 Producer#request 方法），而 Producer 收到请求之后（通常都是 Observable 管理 Producer，所以“相当于”就是 Observable 收到了请求），再根据请求的量给 Subscriber 发数据。