Volley 源码解析

本文转载于：http://a.codekk.com/detail/Android/grumoon/Volley%20%E6%BA%90%E7%A0%81%E8%A7%A3%E6%9E%90

很喜欢，写的灰常好

本文为 Android 开源项目源码解析 中 Volley 部分

项目地址：Volley，分析的版本：35ce778，Demo 地址：Volley Demo

分析者：grumoon，校对者：huxian99、Trinea，校对状态：完成

1. 功能介绍

1.1. Volley

Volley 是 Google 推出的 Android 异步网络请求框架和图片加载框架。在 Google I/O 2013 大会上发布。

名字由来：a burst or emission of many things or a large amount at once

发布演讲时候的配

从名字由来和配图中无数急促的火箭可以看出 Volley 的特点：特别适合数据量小，通信频繁的网络操作。（个人认为 Android 应用中绝大多数的网络操作都属于这种类型）。

1.2 Volley 的主要特点

(1). 扩展性强。Volley 中大多是基于接口的设计，可配置性强。

(2). 一定程度符合 Http 规范，包括返回 ResponseCode(2xx、3xx、4xx、5xx）的处理，请求头的处理，缓存机制的支持等。并支持重试及优先级定义。

(3). 默认 Android2.3 及以上基于 HttpURLConnection，2.3 以下基于 HttpClient 实现，这两者的区别及优劣在中具体介绍。

(4). 提供简便的图片加载工具。

2. 总体设计

2.1 总体设计图

上面是 Volley 的总体设计图，主要是通过两种不断从中取出请求，根据是否已缓存调用或这两类数据获取接口之一，从内存缓存或是服务器取得请求的数据，然后交由去做结果分发及回调处理。

2.2 Volley 中的概念

简单介绍一些概念，在中会仔细介绍。

Volley 的调用比较简单，通过 newRequestQueue(…) 函数新建并启动一个请求队列后，只需要往这个不断 add Request 即可。

Volley：Volley 对外暴露的 API，通过 newRequestQueue(…) 函数新建并启动一个请求队列。

Request：表示一个请求的抽象类。、、 都是它的子类，表示某种类型的请求。

RequestQueue：表示请求队列，里面包含一个(用于处理走缓存请求的调度线程)、数组(用于处理走网络请求的调度线程)，一个(返回结果分发接口)，通过 start() 函数启动时会启动和。

CacheDispatcher：一个线程，用于调度处理走缓存的请求。启动后会不断从缓存请求队列中取请求处理，队列为空则等待，请求处理结束则将结果传递给去执行后续处理。当结果未缓存过、缓存失效或缓存需要刷新的情况下，该请求都需要重新进入去调度处理。

NetworkDispatcher：一个线程，用于调度处理走网络的请求。启动后会不断从网络请求队列中取请求处理，队列为空则等待，请求处理结束则将结果传递给去执行后续处理，并判断结果是否要进行缓存。

ResponseDelivery：返回结果分发接口，目前只有基于的在入参 handler 对应线程内进行分发。

HttpStack：处理 Http 请求，返回请求结果。目前 Volley 中有基于 HttpURLConnection 的和 基于 Apache HttpClient 的。

Network：调用处理请求，并将结果转换为可被处理的。

Cache：缓存请求结果，Volley 默认使用的是基于 sdcard 的。得到请求结果后判断是否需要存储在 Cache，会从 Cache 中取缓存结果。

3. 流程图

Volley 请求流程图

上图是 Volley 请求时的流程图，在 Volley 的发布演讲中给出，我在这里将其用中文重新画出。

4. 详细设计

4.1 类关系图

这是 Volley 框架的主要类关系图

图中红色圈内的部分，组成了 Volley 框架的核心，围绕 RequestQueue 类，将各个功能点以组合的方式结合在了一起。各个功能点也都是以接口或者抽象类的形式提供。

红色圈外面的部分，在 Volley 源码中放在了 toolbox 包中，作为 Volley 为各个功能点提供的默认的具体实现。

通过类图我们看出， Volley 有着非常好的拓展性。通过各个功能点的接口，我们可以给出自定义的，更符合我们需求的具体实现。

多用组合，少用继承；针对接口编程，不针对具体实现编程。

优秀框架的设计，令人叫绝，受益良多。

4.2 核心类功能介绍

4.2.1 Volley.java

这个和 Volley 框架同名的类，其实是个工具类，作用是构建一个可用于添加网络请求的对象。

(1). 主要函数

Volley.java 有两个重载的静态方法。

第一个方法的实现调用了第二个方法，传 HttpStack 参数为 null。

第二个方法中，如果 HttpStatck 参数为 null，则如果系统在 Gingerbread 及之后(即 API Level >= 9)，采用基于 HttpURLConnection 的 HurlStack，如果小于 9，采用基于 HttpClient 的 HttpClientStack。

得到了 HttpStack,然后通过它构造一个代表网络（Network）的具体实现。

接着构造一个代表缓存（Cache）的基于 Disk 的具体实现。

最后将网络（Network）对象和缓存（Cache）对象传入构建一个 RequestQueue，启动这个 RequestQueue，并返回。

我们平时大多采用的默认实现，构建 RequestQueue。

通过源码可以看出，我们可以抛开 Volley 工具类构建自定义的 RequestQueue，采用自定义的，采用自定义的实现，采用自定义的 Cache 实现等来构建。

优秀框架的高可拓展性的魅力来源于此啊

(2). HttpURLConnection 和 AndroidHttpClient(HttpClient 的封装)如何选择及原因：

在 Froyo(2.2) 之前，HttpURLConnection 有个重大 Bug，调用 close() 函数会影响连接池，导致连接复用失效，所以在 Froyo 之前使用 HttpURLConnection 需要关闭 keepAlive。

另外在 Gingerbread(2.3) HttpURLConnection 默认开启了 gzip 压缩，提高了 HTTPS 的性能，Ice Cream Sandwich(4.0) HttpURLConnection 支持了请求结果缓存。

再加上 HttpURLConnection 本身 API 相对简单，所以对 Android 来说，在 2.3 之后建议使用 HttpURLConnection，之前建议使用 AndroidHttpClient。

(3). 关于 User Agent

通过代码我们发现如果是使用 AndroidHttpClient，Volley 还会将请求头中的 User-Agent 字段设置为 App 的 $/$，如果异常则使用 "volley/0"，不过这个获取 User-Agent 的操作应该放到 if else 内部更合适。而对于 HttpURLConnection 却没有任何操作，为什么呢？

如果用 Fiddler 或 Charles 对数据抓包我们会发现，我们会发现 HttpURLConnection 默认是有 User-Agent 的，类似：

经常用 WebView 的同学会也许会发现似曾相识，是的，WebView 默认的 User-Agent 也是这个。实际在请求发出之前，会检测 User-Agent 是否为空，如果不为空，则加上系统默认 User-Agent。在 Android 2.1 之后，我们可以通过

得到系统默认的 User-Agent，Volley 如果希望自定义 User-Agent，可在自定义 Request 中重写 getHeaders() 函数

4.2.2 Request.java

代表一个网络请求的抽象类。我们通过构建一个类的非抽象子类(StringRequest、JsonRequest、ImageRequest 或自定义)对象，并将其加入到·RequestQueue·中来完成一次网络请求操作。

Volley 支持 8 种 Http 请求方式GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, PATCH

Request 类中包含了请求 url，请求请求方式，请求 Header，请求 Body，请求的优先级等信息。

因为是抽象类，子类必须重写的两个方法。

子类重写此方法，将网络返回的原生字节内容，转换成合适的类型。此方法会在工作线程中被调用。

子类重写此方法，将解析成合适类型的内容传递给它们的监听回调。

以下两个方法也经常会被重写

重写此方法，可以构建用于 POST、PUT、PATCH 请求方式的 Body 内容。

在上面函数没有被重写情况下，此方法的返回值会被 key、value 分别编码后拼装起来转换为字节码作为 Body 内容。

4.2.3 RequestQueue.java

Volley 框架的核心类，将请求 Request 加入到一个运行的中，来完成请求操作。

(1). 主要成员变量

RequestQueue 中维护了两个基于优先级的 Request 队列，缓存请求队列和网络请求队列。

放在缓存请求队列中的 Request，将通过缓存获取数据；放在网络请求队列中的 Request，将通过网络获取数据。

维护了一个正在进行中，尚未完成的请求集合。

维护了一个等待请求的集合，如果一个请求正在被处理并且可以被缓存，后续的相同 url 的请求，将进入此等待队列。

(2). 启动队列

创建出 RequestQueue 以后，调用 start 方法，启动队列。

start 方法中，开启一个缓存调度线程和 n 个网络调度线程，这里 n 默认为 4，存在优化的余地，比如可以根据 CPU 核数以及网络类型计算更合适的并发数。

缓存调度线程不断的从缓存请求队列中取出 Request 去处理，网络调度线程不断的从网络请求队列中取出 Request 去处理。

(3). 加入请求

流程图如下

(4). 请求完成

Request 请求结束

(1). 首先从正在进行中请求集合中移除该请求。

(2). 然后查找请求等待集合中是否存在等待的请求，如果存在，则将等待队列移除，并将等待队列所有的请求添加到缓存请求队列中，让缓存请求处理线程自动处理。

(5). 请求取消

取消当前请求集合中所有符合条件的请求。

filter 参数表示可以按照自定义的过滤器过滤需要取消的请求。

tag 表示按照设置好的 tag 取消请求，比如同属于某个 Activity 的。

4.2.4 CacheDispatcher.java

一个线程，用于调度处理走缓存的请求。启动后会不断从缓存请求队列中取请求处理，队列为空则等待，请求处理结束则将结果传递给 去执行后续处理。当结果未缓存过、缓存失效或缓存需要刷新的情况下，该请求都需要重新进入去调度处理。

(1). 成员变量

缓存请求队列

网络请求队列

缓存类，代表了一个可以获取请求结果，存储请求结果的缓存

请求结果传递类

(2). 处理流程图

4.2.5 NetworkDispatcher.java

一个线程，用于调度处理走网络的请求。启动后会不断从网络请求队列中取请求处理，队列为空则等待，请求处理结束则将结果传递给 ResponseDelivery 去执行后续处理，并判断结果是否要进行缓存。

(1). 成员变量

网络请求队列

网络类，代表了一个可以执行请求的网络

缓存类，代表了一个可以获取请求结果，存储请求结果的缓存

请求结果传递类，可以传递请求的结果或者错误到调用者

(2). 处理流程图

4.2.6 Cache.java

缓存接口，代表了一个可以获取请求结果，存储请求结果的缓存。

(1). 主要方法：

通过 key 获取请求的缓存实体

存入一个请求的缓存实体

移除指定的缓存实体

清空缓存

(2). 代表缓存实体的内部类 Entry

成员变量和方法

请求返回的数据（Body 实体）

Http 响应首部中用于缓存新鲜度验证的 ETag

Http 响应首部中的响应产生时间

缓存的过期时间

缓存的新鲜时间

响应的 Headers

判断缓存是否过期，过期缓存不能继续使用

判断缓存是否新鲜，不新鲜的缓存需要发到服务端做新鲜度的检测

4.2.7 DiskBasedCache.java

继承 Cache 类，基于 Disk 的缓存实现类。

(1). 主要方法：

初始化，扫描缓存目录得到所有缓存数据摘要信息放入内存。

从缓存中得到数据。先从摘要信息中得到摘要信息，然后读取缓存数据文件得到内容。

将数据存入缓存内。先检查缓存是否会满，会则先删除缓存中部分数据，然后再新建缓存文件。

检查是否能再分配 neededSpace 字节的空间，如果不能则删除缓存中部分数据。

清空缓存。 删除缓存中某个元素。

(2). CacheHeader 类

CacheHeader 是缓存文件摘要信息，存储在缓存文件的头部，与上面的相似。

4.2.8 NoCache.java

继承 Cache 类，不做任何操作的缓存实现类，可将它作为构建的参数以实现一个不带缓存的请求队列。

4.2.9 Network.java

代表网络的接口，处理网络请求。

唯一的方法，用于执行特定请求。

4.2.10 NetworkResponse.java

中方法 performRequest 的返回值，的 parseNetworkResponse(…) 方法入参，是 Volley 中用于内部 Response 转换的一级。

封装了网络请求响应的 StatusCode，Headers 和 Body 等。

(1). 成员变量

Http 响应状态码

Body 数据

响应 Headers

表示是否为 304 响应

请求耗时

(2). Volley 的内部 Response 转换流程图

从上到下表示从得到数据后一步步的处理，箭头旁的注释表示该步处理后的实体类。

4.2.11 BasicNetwork.java

实现 Network，Volley 中默认的网络接口实现类。调用处理请求，并将结果转换为可被处理的。

主要实现了以下功能：

(1). 利用 HttpStack 执行网络请求。

(2). 如果 Request 中带有实体信息，如 Etag,Last-Modify 等，则进行缓存新鲜度的验证，并处理 304（Not Modify）响应。

(3). 如果发生超时，认证失败等错误，进行重试操作，直到成功、抛出异常(不满足重试策略等)结束。

4.2.12 HttpStack.java

用于处理 Http 请求，返回请求结果的接口。目前 Volley 中的实现有基于 HttpURLConnection 的 HurlStack 和 基于 Apache HttpClient 的 HttpClientStack。

唯一方法，执行请求

执行 Request 代表的请求，第二个参数表示发起请求之前，添加额外的请求 Headers。

4.2.13 HttpClientStack.java4.2.14 HurlStack.java

实现 HttpStack 接口，利用 Java 的 HttpURLConnection 进行各种请求方式的请求。

4.2.15 Response.java

封装了经过解析后的数据，用于传输。并且有两个内部接口 Listener 和 ErrorListener 分别可表示请求失败和成功后的回调。

Response 的构造函数被私有化，而通过两个函数名更易懂的静态方法构建对象。

4.2.16 ByteArrayPool.java

byte[] 的回收池，用于 byte[] 的回收再利用，减少了内存的分配和回收。 主要通过一个元素长度从小到大排序的作为 byte[] 的缓存，另有一个按使用时间先后排序的属性用于缓存满时清理元素。

将用过的 byte[] 回收，根据 byte[] 长度按照从小到大的排序将 byte[] 插入到缓存中合适位置。

获取长度不小于 len 的 byte[]，遍历缓存，找出第一个长度大于传入参数的 byte[]，并返回；如果最终没有合适的 byte[]，new 一个返回。

当缓存的 byte 超过预先设置的大小时，按照先进先出的顺序删除最早的 byte[]。

4.2.17 PoolingByteArrayOutputStream.java

继承 ByteArrayOutputStream，原始 ByteArrayOutputStream 中用于接受写入 bytes 的 buf，每次空间不足时便会 new 更大容量的 byte[]，而 PoolingByteArrayOutputStream 使用了 ByteArrayPool 作为 Byte[] 缓存来减少这种操作，从而提高性能。

4.2.18 HttpHeaderParser.java

Http header 的解析工具类，在 Volley 中主要作用是用于解析 Header 从而判断返回结果是否需要缓存，如果需要返回 Header 中相关信息。

有三个方法

解析时间，将 RFC1123 的时间格式，解析成 epoch 时间

解析编码集，在 Content-Type 首部中获取编码集，如果没有找到，默认返回 ISO-8859-1

比较重要的方法，通过网络响应中的缓存控制 Header 和 Body 内容，构建缓存实体。如果 Header 的 Cache-Control 字段含有或表示不缓存，返回 null。

(1). 根据 Date 首部，获取响应生成时间

(2). 根据 ETag 首部，获取响应实体标签

(3). 根据 Cache－Control 和 Expires 首部，计算出缓存的过期时间，和缓存的新鲜度时间

两点需要说明下：

1.没有处理首部，而是处理存储了首部，并在后续的新鲜度验证时，使用来构建。 这与 Http 1.1 的语义有些违背。

2.计算过期时间，Cache－Control 首部优先于 Expires 首部。

4.2.19 RetryPolicy.java

重试策略接口

有三个方法：

获取当前请求用时（用于 Log）

获取已经重试的次数（用于 Log）

确定是否重试，参数为这次异常的具体信息。在请求异常时此接口会被调用，可在此函数实现中抛出传入的异常表示停止重试。

4.2.20 DefaultRetryPolicy.java

实现 RetryPolicy，Volley 默认的重试策略实现类。主要通过在 retry(…) 函数中判断重试次数是否达到上限确定是否继续重试。

其中变量表示已经重试次数。

表示每次重试之前的 timeout 该乘以的因子。

变量表示当前重试的 timeout 时间，会以作为因子累计前几次重试的 timeout。

4.2.21 ResponseDelivery.java

请求结果的传输接口，用于传递请求结果或者请求错误。

有三个方法：

此方法用于传递请求结果， 和 参数分别表示请求信息和返回结果信息。

此方法用于传递请求结果，并在完成传递后执行 Runnable。

此方法用于传输请求错误。

4.2.22 ExecutorDelivery.java

请求结果传输接口具体实现类。

在 Handler 对应线程中传输缓存调度线程或者网络调度线程中产生的请求结果或请求错误，会在请求成功的情况下调用 Request.deliverResponse(…) 函数，失败时调用 Request.deliverError(…) 函数。

4.2.23 StringRequest.java

继承 Request 类,代表了一个返回值为 String 的请求。将网络返回的结果数据解析为 String 类型。通过构造函数的 listener 传参，支持请求成功后的 onResponse(…) 回调。

4.2.24 JsonRequest.java

抽象类，继承自 Request，代表了 body 为 JSON 的请求。提供了构建 JSON 请求参数的方法。

4.2.25 JsonObjectRequest.java

继承自 JsonRequest，将网络返回的结果数据解析为 JSONObject 类型。

4.2.26 JsonArrayRequest.java

继承自 JsonRequest，将网络返回的结果数据解析为 JSONArray 类型。

4.2.27 ImageRequest.java

继承 Request 类，代表了一个返回值为 Image 的请求。将网络返回的结果数据解析为 Bitmap 类型。

可以设置图片的最大宽度和最大高度，并计算出合适尺寸返回。每次最多解析一张图片防止 OOM。

4.2.28 ImageLoader.java

封装了 ImageRequst 的方便使用的图片加载工具类。

1.可以设置自定义的，可以是内存缓存，也可以是 Disk 缓存，将获取的图片缓存起来，重复利用，减少请求。

2.可以定义图片请求过程中显示的图片和请求失败后显示的图片。

3.相同请求（相同地址，相同大小）只发送一个，可以避免重复请求。

// TODO

4.2.29 NetworkImageView.java

利用 ImageLoader，可以加载网络图片的 ImageView

有三个公开的方法：

设置默认图片，加载图片过程中显示。

设置错误图片，加载图片失败后显示。

设置网络图片的 Url 和 ImageLoader，将利用这个 ImageLoader 去获取网络图片。

如果有新的图片加载请求，会把这个 ImageView 上旧的加载请求取消。

4.2.30 ClearCacheRequest.java

用于人为清空 Http 缓存的请求。

添加到 RequestQueue 后能很快执行，因为优先级很高，为。并且清空缓存的方法写在了方法体中，能最早的得到执行。

ClearCacheRequest 的写法不敢苟同，目前看来唯一的好处就是可以将清空缓存操作也当做一个请求。而在中做清空操作本身就造成了歧义，不看源码没人知道在 run 方法循环的过程中，这个读操作竟然做了可能造成缓存被清空。只能跟源码的解释一样当做一个 Hack 操作。

4.2.31 Authenticator.java

身份认证接口，用于基本认证或者摘要认证。这个类是 Volley 用于和身份验证打通的接口，比如 OAuth，不过目前的使用不是特别广泛和 Volley 的内部结合也不是特别紧密。

4.2.32 AndroidAuthenticator.java

继承 Authenticator，基于 Android AccountManager 的认证交互实现类。

4.2.33 VolleyLog.java

Volley 的 Log 工具类。

4.2.34 VolleyError.java

Volley 中所有错误异常的父类，继承自 Exception，可通过此类设置和获取 NetworkResponse 或者请求的耗时。

4.2.35 AuthFailureError.java

继承自 VolleyError，代表请求认证失败错误，如 RespondeCode 的 401 和 403。

4.2.36 NetworkError.java

继承自 VolleyError，代表网络错误。

4.2.37 ParseError.java

继承自 VolleyError，代表内容解析错误。

4.2.38 ServerError.java

继承自 VolleyError，代表服务端错误。

4.2.39 TimeoutError.java

继承自 VolleyError，代表请求超时错误。

4.2.40 NoConnectionError.java

继承自 NetworkError，代表无法建立连接错误。

5. 杂谈

5.1 关于 Http 缓存

Volley 构建了一套相对完整的符合 Http 语义的缓存机制。

优点和特点

(1). 根据和首部来计算缓存的过期时间。如果两个首部都存在情况下，以为准。

(2). 利用和对过期缓存或者不新鲜缓存，进行请求再验证，并处理 304 响应，更新缓存。

(3). 默认的缓存实现，将缓存以文件的形式存储在 Disk，程序退出后不会丢失。

我个人认为的不足之处

缓存的再验证方面，在构建请求首部时，Volley 使用了服务端响应的首部，没有使用首部。整个框架没有使用首部。这与 Http 语义不符。

服务端根据请求时通过首部传过来的时间，判断资源文件是否在时间以后有改动，如果有改动，返回新的请求结果。如果没有改动，返回 304 not modified。

代表了资源文件的最后修改时间。通常使用这个首部构建的时间。

代表了响应产生的时间，正常情况下时间在时间之后。也就是>=。

通过以上原理，既然>=。那么我利用构建，也是完全正确的。

可能的问题出在服务端的 Http 实现上，如果服务端完全遵守 Http 语义，采用时间比较的方式来验证，判断服务器资源文件修改时间是不是在之后。那么使用完全正确。

可是有的服务端实现不是比较时间，而是直接的判断服务器资源文件修改时间，是否和所传时间相等。这样使用就不能实现正确的再验证，因为的时间总不会和服务器资源文件修改时间相等。

尽管使用可能出现的不正确情况，归结于服务端没有正确的实现 Http 语义。

但我还是希望 Volley 也能完全正确的实现 Http 语义，至少同时处理和,并且优先使用。

5.2 Bug(1). BasicNetwork.performRequest(…)

如下代码：

BasicNetwork.performRequest(…) 最后的

应该是

更合理。