Retrofit基本原理——入门+源码解析

Retrofit是一个Android网络框架。是一个对OKHttp框架的简单封装。所以其内部实现原理实际上也是基于OkHttp的请求方式的。Retrofit采用注解方式开发。通过注解构建不同的请求和请求的参数，省去了创建大量类似的请求与方法，实际上这些参数最终都会在OkHttp中组合成一个完整的Http的请求（包括请求的头和请求体），并通过OkHttp框架进行发送。下面将简单介绍一下Retrofit的内部实现以及使用。

Retrofit引入

在Android Studio中添加Retrofit引用

在Android Studio中使用Retrofit提供的框架，需要引用Retrofit。引用的方式为在app的build.gradle中的dependencies中添加引用项，如下所示：

图一

上述引用的是retrofit2.2版本的Jar包，这样Android

Studio将自动下载Retrofit的Jar包以及其所引用的Jar包（OkHttp的Jar包）。

Retrofit相关类

图二

上图为Retrofit包所包含的类，其中http中包含了有关注解的定义。包括Body、DELETE、Field、FieldMap、FormUrlEncoded、GET、HEAD、Header、HeaderMap、Headers、HTTP、Multipart、OPTIONS、Part、PartMap、PATCH、Path、POST、PUT、Query、QueryMap、QueryName、Streaming、Url。其中较为常用的有GET、POST、Url、Streaming、Header等。

后面将会谈到这些注释的用法，暂时可看成是一种声明，这种声明可以针对方法，也可以针对方法中的参数。

Retrofit使用举例及说明

假设现在有一个需求，要从一个Url指定的地址中下载一个文件（比较通常的情况）。首先，要创建一个接口，接口名称取为ApiService（可随便取），并且定义一个接口方法：

图三

这个方法有几个地方需要注意：方法上方的注解@Streaming，@GET；方法的返回值Call，还有这个泛型的实例类型ResponseBody。

创建了接口之后，就可以创建Retrofit实例：

图四

Retrofit的创建与接口方法的返回值有关，Retrofit.Builder()可调用addCallAdapterFactory方法和addCoverterFactory方法，都是针对返回值的一些转换。所以现在这个Retrofit的创建是最简单的一种形式。其他形式在后面会再作介绍。

另外值得注意的是baseUrl这个方法。其参数是一个Url字符串，而且必须以“/”作为结尾，这个字符串与上面@GET注解的参数“file/test.txt”共同组成一个完整的URL，downloaFile()方法将要访问的就是“https://api.git.com/file/test.txt”这个URL。Retrofit的这种设定将网络文件的域和文件在域中的路径作了分离，对同一个域中的多个文件访问有一种比较统一的形式。但对于动态获得的URL访问则会存在一点问题，因为baseUrl不能以完整的URL作为参数传入，必须只传一个域（因为必须以”/”作为结尾，不然报错）。幸好Retrofit还提供了一个注解@URL。只要在方法中声明一个参数，并加上@URL注解，就可以动态地将完整的URL作为请求的参数。如下所示：

图五

这样，无论BaseUrl传入什么参数，都不起作用，而是用downloadFile的参数fileUrl作为请求的URL。

获得retrofit实例之后，就需要获得接口实例：

图六

得到实例后，就可以调用接口的方法来获取Call对象。即：

图七

整体流程如下图：

图八

获得了这个call对象就可以开始访问网络了。Call接口提供enqueue(Callback callback)方法，其中泛型T即Call的泛型，在这里就是ResponseBody。Callback接口包含两个方法，OnResponse和onFailure，分别在请求成功和失败的时候回调。于是call调用的形式如下：

图九

注意上述下载方法省略了，并且inputStream也没进行相关的try-catch处理。只是为了介绍retrofit的使用，实际上获取了输入流，就可以从流中读取文件的内容。

总结一下这个流程：

1.创建一个接口，以及接口的方法，使用注解标识该方法的请求参数。

2.创建Retrofit实例。

3.通过retrofit实例创建接口实例，调用接口实例的接口方法，获得call对象。

4.调用call对象的enqueue方法，并且传入Callback参数，实现onResponse方法和onFailure方法，表示请求成功和失败时候的回调。

Retrofit内部实现说明

以上面的例子作为分析对象，简要分析一下Retrofit的内部实现。

上面的例子可能会有点让人疑惑，创建的接口ApiService怎么使用Retrofit的create方法就可以创建一个ApiService的实例，并且可以调用其没有经过我们具体实现的方法downloadFile呢？这里使用了反射和代理的设计模式，ApiService的实例实际上Retrofit创建的一个代理，而接口方法downloadFile的实现其实是经过Retrofit内部特殊处理的，个人觉得可以这样理解，这个downloadFile可以看成是一个标识，是Retrofit内部一段逻辑的调用接口，其方法参数都需要添加注解，因此不是随意的想要添加任意参数都可以的。这个接口ApiService看起来是我们自己创建的，连接口方法也是我们定义的，实际上，它只是为了声明我们对网络请求的一个简化形式，这需要跟以往创建接口并自己实现的思路区分开来。这个接口的方法不需要我们实现，它已经在Retrofit内实现好了，我们只需要添加参数，就可以调用网络请求。下面先来看这个代理和方法是怎样实现的。

先来看一下Retrofit的创建，它是通过内部类Builder的build()方法创建的，build()方法代码如下：

图十

Retrofit的构造方法如下：

图十一

就是一些对Retrofit内参的赋值。上面代码比较简单，下面来看Retrofit的create方法：

图十二

上面的代码主要关注粗体部分。当调用接口方法时，方法的实现就在这里。联系上面的例子，接口方法是需要返回Call这个接口对象的。而OkHttpCall则是Call的实现类，注意到返回的是callAdapter.adapt(okHttpCall)，而当我们没有添加callAdapter的时候，使用Retrofit默认的callAdapter，而这个默认的callAdapter实际上就是返回传入的okHttpCall。因此，方法最后返回的即创建的okHttpCall。callAdapter就是对返回的Call对象的一个转化类，在后面会谈到RxJava和Retrofit的结合使用，就需要将这个okHttpCall转换成Rxjava的Observable，这个时候就需要使用RxJava的callAdapter，对call进行转化。

loadServiceMethod会对method（即我们定义的接口方法）进行处理，构成ServiceMethod对象，这个对象在OkHttpCall进行网络请求时会用到，使用ServiceMethod的内参组成网络请求。Retrofit内部使用serviceMethodCache这个表缓存serviceMethod，如果从serviceMethodCache中没有method对应的serviceMethod，则会通过ServiceMethod的Buidler创建一个。

ServiceMethod的创建是通过Buidler生成的，主要是生成一些内参：

图十三

这些参数大部分都是在接口方法中定义的注解以及参数类型获得的，比如像上例中定义了一个@GET注解的方法，那么ServiceMethod就会解释到这个@GET注解，并得出这个方法的httpMethod为GET类型。由于对注解以及参数类型的解释代码篇幅较长，这里不一一列出来。ServiceMethod可以看成是Method经过参数解释的参数结合，它没有真正的网络处理逻辑，但对参数类型已经作了相关的解释，作好了调用的前置准备（注意参数还没准备好，只是参数类型作了解释，因为这个时候真实的参数还没有传入，在Retrofit的create方法中可以看到，参数args是传给了OkHttpCall中的，不需要传给ServiceMethod）。

接着来看接口方法的返回值，即Call对象。Call是一个接口，其实现类为OkHttpCall。上面说过如果没有添加CallAdapter，那最终返回的就是这个OkHttpCall。OkHttpCall的构造方法也比较简单，就是保存了前面获得的ServiceMethod以及调用接口方法时传入的参数，上面的例子中的downloadFile由于没有参数，因此这里传入的就是空。

如前面例子所示，获得了Call对象后，调用了其enqueue方法，将网络请求放入到队列中，等待响应。enqueue方法如下：

图十四

图十五

从enqueue方法可知，我们得到的OkHttpCall实际上是对OKHttp请求的封装，实际的网络实现还是要通过OKHttp中的相关类来实现。这里体现了Retrofit的思想，即对OkHttp的封装，以及简化其使用。

注意到在OkHttpCall的enqueue方法内部，调用RealCall（OkHttp的相关类）的enqueue方法时，同样会使用一个Callback，这个Callback不同于Retrofit提供的Callbcak（实际上Retrofit和OkHttp有很多同名类，需要注意使用的究竟是Retrofit还是OkHttp的，可以使用包名作为区分）。OkHttp的Call和Response均不支持泛型，它是为了获得最原始的数据而来的，而Retrofit却可以对返回的信息进行整理，置换成其他的类型（最为典型的就是将数据体转成JSON类型的数据）。

简单总结一下Retrofit的主要内部实现：

1.Retrofit实例的构造，填充一些参数，比如将在后面谈到的callAdapterFactory、convertFactory，以及baseUrl，callFactory（与callAdapterFactory作区分，若不指定，则为一个默认的OkHttpClient，可以根据需要创建一个OkHttpClient，然后对这个OkHttpClient添加对应的属性，以实现不同的网络处理机制）。

2.Retrofit调用create创建一个代理实体，而代理关键部分在于创建一个ServiceMethod，ServiceMethod收集接口方法的参数类型以及对应的注解，组成一个有关网络请求的参数类型集合。

3.ServiceMethod与接口方法传入的参数共同作用传入OkHttpCall，构成一个Call对象，经过CallAdapterFactory的适配，返回。因此接口方法可以理解为最后获得这个Call对象（真实来说应该是OkHttpCall）。

4.Call对象调用enqueue实际使用的是OkHttp的RealCall的enqueue方法，因此Retrofit的Call对象可以看成是OkHttp的Call的一个封装。当然，这不是一个简单的封装，在网络请求获得响应后，OkHttpCall还会对返回的信息进行转置，根据ConvertFactory定义的转置模式进行转换。