Retrofit2使用与源码分析

一 、Retrofit2的基本使用

Reftofit2的基本使用详细参见

Android网络编程（九）Retrofit2前篇

Android网络编程（十）Retrofit2后篇[注解]

你真的会用Retrofit2吗?Retrofit2完全教程

二、Retrofit的创建过程

当我们使用Retrofit请求网络时，首先要写请求接口：

接着我们通过调用如下代码来创建Retrofit：

Retrofit 是通过建造者模式构建出来的，接下来查看Builder方法做了什么：

很简短，查看Platform的get方法，如下所示：

Platform的get方法最终调用的是findPlatform方法，根据不同的运行平台来提供不同的线程池。

接下来查看build方法，代码如下所示。

从源码中可以看出baseUrl 是必须指定的，Retrofit的默认的callFactory是OKHttpClient(),如果需要对OkHttpClient进行设置，则可以构建OkHttpClient对象，然后调用callFactory方法将设置好的OkHttpClient传进去。

callbackExecutor用来将回调传递到UI线程;

adapterFactories主要用于存储对Call进行转化的对象，后面在Call的创建过程会再次提到它.

converterFactories主要用于存储转化数据对象，后面也会提及到。此前在例子中调用的addConverterFactory(GsonConverterFactory.create())，就是设置返回的数据支持转换为Gson对象。

最终会返回配置好的Retrofit类。

三、Call的创建过程

紧接着我们创建Retrofit实例并调用如下代码来生成接口的动态代理对象：

接下来看Retrofit的create方法做了什么，代码如下所示。

可以看到create方法返回了一个Proxy.newProxyInstance动态代理对象，当我们调用IpService的getIpMsg方法最终会调用InvocationHandler的invoke

方法，它有3个参数，第一个是代理对象，第二个是调用的方法，第三个是方法的参数。loadServiceMethod(method)中的method就是我们定义的getIpMsg方法。接下来查看loadServiceMethod方法里做了什么：

Retrofit.java

首先会从serviceMethodCache查询传入的方法是否有缓存，如果有就用缓存的ServiceMethod，如果没有就创建一个，并加入serviceMethodCache缓存起来。接下来看ServiceMethod是如何构建的，代码如下所示。首先我们先介绍method的几个属性。

method.getAnnotations()：获取方法注解

method.getGenericParameterTypes()：获得一个方法参数数组

method.getParameterAnnotations()：获取方法参数上的注解

1、createCallAdapter

首先执行createCallAdapter方法，它最终会得到我们在构建Retrofit调用build方法时adapterFactories添加的对象的get方法，Retrofit的build方法部分代码：

adapterFactories列表默认会添加defaultCallAdapterFactory，defaultCallAdapterFactory指的是ExecutorCallAdapterFactory，ExecutorCallAdapterFactory的get方法如下所示。

2、ExecutorCallAdapterFactory.java

get方法会得到CallAdapter对象，它的responseType方法会返回数据的真实类型，比如Call，它就会返回IpModel。adapt方法会创建ExecutorCallbackCall，它会将call的回调转发至UI线程。

callAdapter.responseType()得到的是返回数据的真实类型。

3、createResponseConverter

createResponseConverter方法来遍历converterFactories列表中存储的Converter.Factory，并返回一个合适的Converter用来转换对象。此前我们在构建Retrofit

调用了addConverterFactory(GsonConverterFactory.create())将GsonConverterFactory（Converter.Factory的子类）添加到converterFactories列表中，表示返回的数据支持转换为Json对象。

4、parseMethodAnnotation

遍历parseMethodAnnotation方法来对请求方式（比如GET、POST）和请求地址进行解析。部分代码如下：

接下来我们以GET方法为例看一下parseHttpMethodAndPath（）方法，如下图：

5、Annotation[] parameterAnnotations =parameterAnnotationsArray[p];

此处对方法中的参数注解进行解析（比如@Query、@Part）。最后创建ServiceMethod类并返回。最后调用parseParameter（）方法对参数注解进行解析。

接下来回过头来查看Retrofit的create方法，在调用了loadServiceMethod方法后会创建OkHttpCall，OkHttpCall的构造函数只是进行了赋值操作。紧接着调用serviceMethod.callAdapter.adapt(okHttpCall)，callAdapter的adapt方法前面讲过，它会创建ExecutorCallbackCall，ExecutorCallbackCall的部分代码如下所示。

可以看出ExecutorCallbackCall是对Call的封装，它主要添加了通过callbackExecutor将请求回调到UI线程。

当我们得到Call对象后会调用它的enqueue方法，其实调用的是ExecutorCallbackCall的enqueue方法，而从注释1处可以看出ExecutorCallbackCall的enqueue方法最终调用的是delegate的enqueue方法。delegate从Retrofit的create方法的代码中我们知道它其实就是OkHttpCall。最终执行方法在OKHttpCall中。

四、Call的enqueue方法

接下来我们就来查看OkHttpCall的enqueue方法，代码如下所示。

可以看出，okhttpcall.enqueue()方法调用了okhttp3.Call的enqueue方法。response 调用了parseResponse(rawResponse);

根据返回的不同的状态码code值来做不同的操作，如果顺利则会调用serviceMethod.toResponse(catchingBody)，接下来看toResponse方法里做了什么：

这个responseConverter就是此前讲过在ServiceMethod的build方法调用createResponseConverter方法返回的Converter，

我们以GsonConverterFactory为例讲解一下：

在GsonConverterFactory 中有一个方法responseBodyConverter，它最终会创建GsonResponseBodyConverter：

在GsonResponseBodyConverter的convert方法里会将回调的数据转换为Json格式。因此我们也知道了此前调用responseConverter.convert是为了转换为特定的数据格式。

Call的enqueue方法主要做的就是用OKHttp来请求网络并将返回的Response进行数据转换并回调给UI线程。

大家可以仿造GsonConverterFactory的实现方法，自己实现一个ConverterFactory，比如fastJson等，或者使用原生的JSonObject，都可以。

至此，Retrofit的源码就讲到这里。