Android应用开发：网络工具——Volley（一）

引言

网络一直是我个人的盲点，前一阵子抽出时间学习了一下Volley网络工具的使用方法，也透过源码进行了进一步的学习，有一些心得想分享出来。在Android开发中，成熟的网络工具不少，Android自带了HttpClient，还有okhttp，还有koush大神创建的ion开源项目，然后就是google后来加入到Android项目源码中的Volley。为什么使用Volley，是因为Volley使用简单，逻辑清晰，即使在调试过程中出现了问题，也可以快速的通过源码进行定位。

Volley编译

因为已经习惯了使用Gradle构架应用，所以我在第一次想要使用Volley的时候尝试寻找是否可以通过gradle的配置文件进行库依赖。可惜的是，并没有。但即使这样Volley的库也很容易做出来加入到我们的工程中。

首先需要ant编译工具，然后如果有Android系统源码的话，Volley在frameworks/volley目录下。如果没有Android源码，也很好办，可以单独从Android的仓储中克隆出Volley源码：

1. git clone https://android.googlesource.com/platform/frameworks/volley  

不幸的是，volley库的源码Android并没有托管在其在Github的帐号上，所以只能在googlesource上进行克隆，当然在国内也就需要先FQ才可以了。

下图为Volley源码结构：

克隆成功后，可以方便的使用ant进行编译，当然，如果是在完整的Android源码下，也可以直接通过make进行编译，但是时间必然会长很多。这里使用ant编译为例，执行：

1. ant jar  

结果如图所示：

这样jar包就生成了，很方便吧，接下来将其添加到工程中就可以使用了。

Volley使用

Volley的网络请求父类为Request<T>，可以提供给开发者进行继承，同时也预置了几种开发中常用的请求类型，下边介绍两个：StringRequest和JsonObjectRequest。

为了更加贴近实际使用，下边将使用Volley与Cloudant进行通讯做示例。Cloudant是一家提供云服务业务的公司，其向开发者提供免费的云存储、云数据库服务。关于其注册等流程本文不做叙述，很简单的。直接从登录开始：

1. 申请网络请求队列

Volley的一个很大的特色，就是所有的网络请求无需开发者自己执行，而是在请求构造完成后扔到Volley的请求队列中，队列依次进行请求，这样就省去了很多麻烦，开发者也不用担心网络请求是否会冲突，是否会在主线程，这些烦心事Volley的网络队列都帮我们解决了。

一般来说，一个应用程序如果网络请求没有特别频繁则完全可以只有一个请求队列（对应Application），如果非常多或其他情况，则可以是一个Activity对应一个网络请求队列，具体情况具体分析。下边的代码展示了如何申请一个Volley网络请求队列：

1. RequestQueue mQueue;  
2. mQueue = Volley.newRequestQueue(getApplicationContext());  

这样就成功申请了一个网络请求队列，如果只有一个，则可以在Application中进行申请。

2. 使用Volley登录Cloudant

假设已经成功注册，登录名foo，密码bar。

通过查阅Cloudant的登录认证文档：https://docs.cloudant.com/api/authn.html。可以发现Cloudant登录认证相关接口有三个：

这里我们使用POST方法进行cookie登录认证。结合上边假设的用户名和密码可知：

1. 要访问的url为 foo.cloudant.com/_session  
2. 头信息为 Content-Type: application/x-www-form-urlencoded  
3. 参数为 name = foo, password = bar  

若访问成功，我们就可以在网络回应中获取cookie，以备之后其他操作使用。显然，这个请求跟json毫无关系，应该使用StringRequest，StringRequest有两种构造方法：

1. public StringRequest(int method, String url, Listener<String> listener, ErrorListener errorListener)  
2.   
3. public StringRequest(String url, Listener<String> listener, ErrorListener errorListener)  

第二个方法只有GET请求才可以使用，第一个方法的method参数可以用来自定义请求类型，这里我们需要的是POST，所以应该使用第一个构造方法：

1. StringRequest request = new StringRequest(  
2.                 Request.Method.POST,  
3.                 "http://foo.cloudant.com/_session",  
4.                 new Response.Listener<String>() {  
5.                     @Override  
6.                     public void onResponse(String s) {  //收到成功应答后会触发这里  
7.   
8.                     }  
9.                 },  
10.                 new Response.ErrorListener() {  
11.                     @Override  
12.                     public void onErrorResponse(VolleyError volleyError) { //出现连接错误会触发这里  
13.                     }  
14.                 }  
15.         );  

上边的代码中，我们成功构造了一个StringRequest，其中已经包含了我们需要的POST和正确的URL，同时还添加了网络回应监听器。但是，还缺少文档要求我们的头信息和参数。StringRequest在构造中并不提供这些信息的定义，这也是与其他常用网络工具不同的地方，刚接触的同学可能会很不适用，通过复写StringRequest的两个方法就可以将这些信息放进去了。下边来完善这个请求：

1. StringRequest request = new StringRequest(  
2.                 Request.Method.POST,  
3.                 "http://foo.cloudant.com/_session",  
4.                 new Response.Listener<String>() {  
5.                     @Override  
6.                     public void onResponse(String s) {  
7.   
8.                     }  
9.                 },  
10.                 new Response.ErrorListener() {  
11.                     @Override  
12.                     public void onErrorResponse(VolleyError volleyError) {  
13.   
14.                     }  
15.                 }  
16.         ) {  
17.             @Override  
18.             public Map<String, String> getHeaders() throws AuthFailureError {  //设置头信息  
19.                 Map<String, String> map = new HashMap<String, String>();  
20.                 map.put("Content-Type", "application/x-www-form-urldecoded");  
21.                 return map;  
22.             }  
23.   
24.             @Override  
25.             protected Map<String, String> getParams() throws AuthFailureError {  //设置参数  
26.                 Map<String, String> map = new HashMap<String, String>();  
27.                 map.put("name", "foo");  
28.                 map.put("password", "bar");  
29.                 return map;  
30.             }  
31.         };  

相比第一次我们的构造过程，这一次多了两个复写的方法来设置头信息和参数，很容易吧。这个时候请求基本完成了，但是却缺少另一个很重要的东西，我们的登录认证为的是拿回属于自己的cookie，如果不能获取cookie的话，多么正确的请求格式都是白费力气啊，想要拿到cookie一样也是通过复写另一个方法进行获取：

1. @Override  
2. protected Response<String> parseNetworkResponse(NetworkResponse response) {  
3.     for (String s : response.headers.keySet()) {  
4.         if (s.contains("Set-Cookie")) {  
5.             mCookie = response.headers.get(s);  
6.             break;  
7.         }  
8.     }  
9.     return super.parseNetworkResponse(response);  
10. }  

在网络请求成功后，服务端返回应答信息，而我们所需的Cookie信息就在这些应答信息中，通过对应答信息的遍历查找，很方便就可以找到我们所需的信息了。到这里，我们的登录认证请求就构造完成了，最后需要做的就是将这个StringRequest扔到我们的请求队列中去：

1. mQueue.add(request);  

网络通畅的情况下，很快就能够获取Cookie信息了。

3. 查看测试文档

在注册Cloudant成功后，Cloudant会在我们的帐号中创建一个默认数据库——crud，其中保存着一行测试数据welcome。

让我们用Volley来访问这条数据。查阅Cloudant API文档Documents相关可以发现：

通过简单的GET请求搭配正确的URL即可得到文件（数据）内容，当然，这一切的前提是我们已经掌握了正确的Cookie数据。那么，我们需要：

1. 1. 请求头数据中包含正确的Cookie信息  
2. 2. 访问正确的URL  
3. 3. 请求类型：GET  

假设通过上一步登陆认证后我们将Cookie信息保存在了mCookie字符串变量中。而我们需要访问的URL通过查阅文档也可以得出路径为 数据库名 + 文档名，即foo.cloudant.com/crud/welcome。万事俱备，使用StringRequest：

1. StringRequest request = new StringRequest(  
2.         "http://foo.cloudant.com/crud/welcome",  
3.         new Response.Listener<String>() {  
4.             @Override  
5.             public void onResponse(String s) {  
6.   
7.             }  
8.         },  
9.         new Response.ErrorListener() {  
10.             @Override  
11.             public void onErrorResponse(VolleyError volleyError) {  
12.   
13.             }  
14.         }  
15. ) {  
16.     @Override  
17.     public Map<String, String> getHeaders() throws AuthFailureError {  
18.         Map<String, String> map = new HashMap<String, String>();  
19.         map.put("Cookie", mCookie);  
20.         return map;  
21.     }  
22. };  
23. mQueue.add(request);  

在onResponse中我们会收到welcome这条数据的json形式字符串：

简单的网络请求StringRequest完全处理得来，使用也比较简单，就介绍到这里。下边介绍JsonObjectRequest应用方法。

4. 使用JsonObjectRequest创建新数据

首先看一下JsonObjectRequest的构造方法：

1. public JsonObjectRequest(int method, String url, JSONObject jsonRequest, Listener<JSONObject> listener, ErrorListener errorListener)  
2.   
3. public JsonObjectRequest(String url, JSONObject jsonRequest, Listener<JSONObject> listener, ErrorListener errorListener)  

第一种方法参数以此为：请求方法，访问的URL，Json数据对象，请求成功监听器，请求失败监听器。

第二种构造方法中，若jsonRequest为空，则方法自动为GET，不为空则自动切换为POST，其他参数含义相同。

Cloudant的文档（ https://docs.cloudant.com/api/documents.html ）要求创建文档可以使用POST或PUT方法进行，所携带的数据均为json格式。这样以来，StringRequest就显得力不从心了，我们需要使用到Volley的另一个自带请求类型：JsonObjectRequest。下边以POST方式创建数据为例，通过查看Cloudant文档，可知：

1. 1. 访问的URL path为数据库目录  
2. 2. Content-Type被要求为application/json  
3. 3. 携带的数据要求为json数据  

既然方法要求为POST，我们又是创建数据，肯定数据内容不会为空，所以我们选择第二种构造方法。首先，创建一个Json对象：

1. JSONObject jsonObject = new JSONObject();  
2. jsonObject.put("_id", "testinfo");  
3. jsonObject.put("person", "foo");  
4. jsonObject.put("phone", "bar");  

在Cloudant数据存储系统中，id可以由开发者指定。接下来进行JsonObjectRequest的构造和请求：

1. JsonObjectRequest request = new JsonObjectRequest(  
2.         "http://foo.cloudant.com/crud",  
3.         jsonObject,  
4.         new Response.Listener<JSONObject>() {  
5.             @Override  
6.             public void onResponse(JSONObject jsonObject) {  
7.   
8.             }  
9.         },  
10.         new Response.ErrorListener() {  
11.             @Override  
12.             public void onErrorResponse(VolleyError volleyError) {  
13.   
14.             }  
15.         }  
16. ) {  
17.     @Override  
18.     public Map<String, String> getHeaders() throws AuthFailureError {  
19.         Map<String, String> map = new HashMap<String, String>();  
20.         map.put("Cookie", mCookie);  
21.         return map;  
22.     }  
23. };  
24. mQueue.add(request);  

jsonObject数据不为空，所以请求方式自动切换为POST，url为所要创建数据所在的数据库所在路径，然后就是请求结果的监听器，最后别忘了将Cookie带上，否则会出现认证错误的。最后，将构造完成的请求丢进队列中，由Volley进行调度处理。这个时候不妨再回头看一看之前分析的请求所需要哪些元素，不难发现，Volley的json请求中，并没有对Content-Type进行特殊设定。JsonObjectRequest是继承于JsonRequest的，而JsonRequest已经帮我们完成了这个动作：

1. @Override  
2. public String getBodyContentType() {  
3.     return PROTOCOL_CONTENT_TYPE;  
4. }  

PS：设置Content-Type也可以通过复写getBodyContentType这个函数，而不用总是麻烦的使用getHeader中的map进行设定，两种设定方式效果一致。 而且也不用担心编码格式，因为默认就是utf-8的：

1. /** Charset for request. */  
2. private static final String PROTOCOL_CHARSET = "utf-8";  
3.   
4. /** Content type for request. */  
5. private static final String PROTOCOL_CONTENT_TYPE =  
6.     String.format("application/json; charset=%s", PROTOCOL_CHARSET);  

到这里，Json请求的相关用法也就介绍完了。下一节将会从源码角度分析一下Volley请求的逻辑顺序究竟是怎样的，如果我们需要书写自己的请求类型，都需要复写哪些函数，以及需要注意些什么。

源码

关于Volley和Cloudant更多的通信细节，见CloudantVolley项目：https://github.com/airk000/CloudantVolley