Android的HTTP类库Volley入门学习教程

1. 什么是Volley
我们平时在开发Android应用的时候不可避免地都需要用到网络技术，而多数情况下应用程序都会使用HTTP协议来发送和接收网络数据。Android系统中主要提供了两种方式来进行HTTP通信，HttpURLConnection和HttpClient，几乎在任何项目的代码中我们都能看到这两个类的身影，使用率非常高。

不过HttpURLConnection和HttpClient的用法还是稍微有些复杂的，如果不进行适当封装的话，很容易就会写出不少重复代码。于是乎，一些Android网络通信框架也就应运而生，比如说AsyncHttpClient，它把HTTP所有的通信细节全部封装在了内部，我们只需要简单调用几行代码就可以完成通信操作了。再比如Universal-Image-Loader，它使得在界面上显示网络图片的操作变得极度简单，开发者不用关心如何从网络上获取图片，也不用关心开启线程、回收图片资源等细节，Universal-Image-Loader已经把一切都做好了。

Android开发团队也是意识到了有必要将HTTP的通信操作再进行简单化，于是在2013年Google I/O大会上推出了一个新的网络通信框架——Volley。Volley可是说是把AsyncHttpClient和Universal-Image-Loader的优点集于了一身，既可以像AsyncHttpClient一样非常简单地进行HTTP通信，也可以像Universal-Image-Loader一样轻松加载网络上的图片。除了简单易用之外，Volley在性能方面也进行了大幅度的调整，它的设计目标就是非常适合去进行数据量不大，但通信频繁的网络操作，而对于大数据量的网络操作，比如说下载文件等，Volley的表现就会非常糟糕。
1.1. Volley引入的背景
在以前，我们可能面临如下很多麻烦的问题。

比如以前从网上下载图片的步骤可能是这样的流程：

• 在ListAdapter#getView()里开始图像的读取。
• 通过AsyncTask等机制使用HttpURLConnection从服务器去的图片资源
• 在AsyncTask#onPostExecute()里设置相应ImageView的属性。
• 而在Volley下，只需要一个函数即可，详细见后面的例子。

再比如，屏幕旋转的时候，有时候会导致再次从网络取得数据。为了避免这种不必要的网络访问，我们可能需要自己写很多针对各种情况的处理，比如cache什么的。

再有，比如ListView的时候，我们滚动过快，可能导致有些网络请求返回的时候，早已经滚过了当时的位置，根本没必要显示在list里了，虽然我们可以通过ViewHolder来保持url等来实现防止两次取得，但是那些已经没有必须要的数据，还是会浪费系统的各种资源。

1.2. Volley提供的功能
简单来说，它提供了如下的便利功能：

• JSON，图像等的异步下载；
• 网络请求的排序（scheduling）
• 网络请求的优先级处理
• 缓存
• 多级别取消请求
• Activity和生命周期的联动（Activity结束时同时取消所有网络请求）

2. 使用前的准备

引入Volley非常简单，首先，从git库先克隆一个下来：

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

然后编译为jar包，再在自己的工程里import进来。

注意，这个库要求最低SDK版本为Froyo，即至少要设置android:minSdkVersion为8以上。

3.使用例子
下面简单看看如何使用Volley

3.1. 最简单的get请求
这个例子很简单，从网络取得JSON对象，然后打印出来。

mQueue = Volley.newRequestQueue(getApplicationContext()); 
mQueue.add(new JsonObjectRequest(Method.GET, url, null, 
   new Listener() { 
    @Override 
    public void onResponse(JSONObject response) { 
     Log.d(TAG, "response : " + response.toString()); 
    } 
   }, null)); 
mQueue.start(); 

3.2. 给ImageView设置图片源

// imageView是一个ImageView实例 
// ImageLoader.getImageListener的第二个参数是默认的图片resource id 
// 第三个参数是请求失败时候的资源id，可以指定为0 
ImageListener listener = ImageLoader.getImageListener(imageView, android.R.drawable.ic_menu_rotate, android.R.drawable.ic_delete); 
mImageLoader.get(url, listener); 

ImageLoader的方法都需要从主线程里来调用。

3.3. 使用NetworkImageView

Volley提供了一个新的控件NetworkImageView来代替传统的ImageView，这个控件的图片属性可以通过

mImageView.setImageUrl(url, imageLoader) 

来设定。而且，这个控件在被从父控件detach的时候，会自动取消网络请求的，即完全不用我们担心相关网络请求的生命周期问题。
示例代码如下：

mImageLoader = new ImageLoader(mRequestQueue, new BitmapLruCache()); 
... ... 
 
if(holder.imageRequest != null) { 
 holder.imageRequest.cancel(); 
} 
holder.imageRequest = mImageLoader.get(BASE_UR + item.image_url, holder.imageView, R.drawable.loading, R.drawable.error); 

注意，这里使用的不是ImageView控件，而是Volley新提供的com.android.volley.NetworkImageView。

另外，注意这里：

mImageLoader = new ImageLoader(mRequestQueue, new BitmapLruCache()); 

ImageLoader构造函数的第二个参数是一个ImageCache的实例（严格来说，是实现ImageCache接口的某具体类的实例）
ImageCache的定义如下（在ImageLoader.java里）：

/** 
 * Simple cache adapter interface. If provided to the ImageLoader, it 
 * will be used as an L1 cache before dispatch to Volley. Implementations 
 * must not block. Implementation with an LruCache is recommended. 
 */ 
public interface ImageCache { 
 public Bitmap getBitmap(String url); 
 public void putBitmap(String url, Bitmap bitmap); 
} 

下面的网址一个lru的cache实现例子，请参考：
https://github.com/suwa-yuki/VolleySample/blob/master/src/jp/classmethod/android/sample/volley/BitmapCache.java

3.4 StringRequest的用法
发起一条HTTP请求，然后接收HTTP响应。首先需要获取到一个RequestQueue对象，可以调用如下方法获取到：

RequestQueue mQueue = Volley.newRequestQueue(context); 

注意这里拿到的RequestQueue是一个请求队列对象，它可以缓存所有的HTTP请求，然后按照一定的算法并发地发出这些请求。RequestQueue内部的设计就是非常合适高并发的，因此我们不必为每一次HTTP请求都创建一个RequestQueue对象，这是非常浪费资源的，基本上在每一个需要和网络交互的Activity中创建一个RequestQueue对象就足够了。

接下来为了要发出一条HTTP请求，我们还需要创建一个StringRequest对象，如下所示：

StringRequest stringRequest = new StringRequest("http://www.baidu.com", 
      new Response.Listener<String>() { 
       @Override 
       public void onResponse(String response) { 
        Log.d("TAG", response); 
       } 
      }, new Response.ErrorListener() { 
       @Override 
       public void onErrorResponse(VolleyError error) { 
        Log.e("TAG", error.getMessage(), error); 
       } 
      }); 

可以看到，这里new出了一个StringRequest对象，StringRequest的构造函数需要传入三个参数，第一个参数就是目标服务器的URL地址，第二个参数是服务器响应成功的回调，第三个参数是服务器响应失败的回调。其中，目标服务器地址我们填写的是百度的首页，然后在响应成功的回调里打印出服务器返回的内容，在响应失败的回调里打印出失败的详细信息。

最后，将这个StringRequest对象添加到RequestQueue里面就可以了，如下所示：

mQueue.add(stringRequest); 
另外，由于Volley是要访问网络的，因此不要忘记在你的AndroidManifest.xml中添加如下权限：

<uses-permission android:name="android.permission.INTERNET" /> 

好了，就是这么简单，如果你现在运行一下程序，并发出这样一条HTTP请求，就会看到LogCat中会打印出如下图所示的数据。

没错，百度返回给我们的就是这样一长串的HTML代码，虽然我们看起来会有些吃力，但是浏览器却可以轻松地对这段HTML代码进行解析，然后将百度的首页展现出来。

这样的话，一个最基本的HTTP发送与响应的功能就完成了。你会发现根本还没写几行代码就轻易实现了这个功能，主要就是进行了以下三步操作：

(1). 创建一个RequestQueue对象。

(2). 创建一个StringRequest对象。

(3). 将StringRequest对象添加到RequestQueue里面。

不过大家都知道，HTTP的请求类型通常有两种，GET和POST，刚才我们使用的明显是一个GET请求，那么如果想要发出一条POST请求应该怎么做呢？StringRequest中还提供了另外一种四个参数的构造函数，其中第一个参数就是指定请求类型的，我们可以使用如下方式进行指定：

StringRequest stringRequest = new StringRequest(Method.POST, url,  listener, errorListener); 
可是这只是指定了HTTP请求方式是POST，那么我们要提交给服务器的参数又该怎么设置呢？很遗憾，StringRequest中并没有提供设置POST参数的方法，但是当发出POST请求的时候，Volley会尝试调用StringRequest的父类——Request中的getParams()方法来获取POST参数，那么解决方法自然也就有了，我们只需要在StringRequest的匿名类中重写getParams()方法，在这里设置POST参数就可以了，代码如下所示：

StringRequest stringRequest = new StringRequest(Method.POST, url, listener, errorListener) { 
 @Override 
 protected Map<String, String> getParams() throws AuthFailureError { 
  Map<String, String> map = new HashMap<String, String>(); 
  map.put("params1", "value1"); 
  map.put("params2", "value2"); 
  return map; 
 } 
}; 

你可能会说，每次都这样用起来岂不是很累？连个设置POST参数的方法都没有。但是不要忘记，Volley是开源的，只要你愿意，你可以自由地在里面添加和修改任何的方法，轻松就能定制出一个属于你自己的Volley版本。

3.5 JsonRequest的用法
学完了最基本的StringRequest的用法，我们再来进阶学习一下JsonRequest的用法。类似于StringRequest，JsonRequest也是继承自Request类的，不过由于JsonRequest是一个抽象类，因此我们无法直接创建它的实例，那么只能从它的子类入手了。JsonRequest有两个直接的子类，JsonObjectRequest和JsonArrayRequest，从名字上你应该能就看出它们的区别了吧？一个是用于请求一段JSON数据的，一个是用于请求一段JSON数组的。

至于它们的用法也基本上没有什么特殊之处，先new出一个JsonObjectRequest对象，如下所示：

JsonObjectRequest jsonObjectRequest = new JsonObjectRequest("http://m.weather.com.cn/data/101010100.html", null, 
  new Response.Listener<JSONObject>() { 
   @Override 
   public void onResponse(JSONObject response) { 
    Log.d("TAG", response.toString()); 
   } 
  }, new Response.ErrorListener() { 
   @Override 
   public void onErrorResponse(VolleyError error) { 
    Log.e("TAG", error.getMessage(), error); 
   } 
  }); 

可以看到，这里我们填写的URL地址是http://m.weather.com.cn/data/101010100.html，这是中国天气网提供的一个查询天气信息的接口，响应的数据就是以JSON格式返回的，然后我们在onResponse()方法中将返回的数据打印出来。

最后再将这个JsonObjectRequest对象添加到RequestQueue里就可以了，如下所示：

mQueue.add(jsonObjectRequest); 

这样当HTTP通信完成之后，服务器响应的天气信息就会回调到onResponse()方法中，并打印出来。现在运行一下程序，发出这样一条HTTP请求，就会看到LogCat中会打印出如下图所示的数据。

3.6. 使用自己定制的request

我们也可以通过继承Request根据自己的需求来定制自己的request

@Override 
protected Response parseNetworkResponse(NetworkResponse response) { 
 try { 
  String json = new String( 
    response.data, HttpHeaderParser.parseCharset(response.headers)); 
  return Response.success( 
    gson.fromJson(json, clazz), HttpHeaderParser.parseCacheHeaders(response)); 
 } catch (UnsupportedEncodingException e) { 
  return Response.error(new ParseError(e)); 
 } catch (JsonSyntaxException e) { 
  return Response.error(new ParseError(e)); 
 } 
} 

这段代码节选自： https://gist.github.com/ficusk/5474673

里面使用的gson（com.google.gson.Gson）是JSON的序列化和反序列化的库，可以在JSON和java model object之间进行转换。

以下是使用自定制request的例子：

mRequestQueue.add( new GsonRequest(url, ListResponse.class, null, 
 new Listener() { 
  public void onResponse(ListResponse response) { 
   appendItemsToList(response.item); 
   notifyDataSetChanged(); 
  } 
 } 
} 

4. Volley的架构设计

Volley使用了线程池来作为基础结构，主要分为主线程，cache线程和network线程。
主线程和cache线程都只有一个，而NetworkDispatcher线程可以有多个，这样能解决比并行问题。如下图:

如果在一个Activity里面启动了网络请求，而在这个网络请求还没返回结果的时候，如果Activity被结束了，则我们需要写如下代码作为防守：

@Override public void onPostExecute(Result r) { 
 if (getActivity() == null) { 
  return; 
 } 
 // ... 
} 

Activity被终止之后，如果继续使用其中的Context等，除了无辜的浪费CPU，电池，网络等资源，有可能还会导致程序crash，所以，我们需要处理这种一场情况。

使用Volley的话，我们可以在Activity停止的时候，同时取消所有或部分未完成的网络请求。

Volley里所有的请求结果会返回给主进程，如果在主进程里取消了某些请求，则这些请求将不会被返回给主线程。
比如，可以针对某些个request做取消操作：

@Override 
public void onStop() { 
 for (Request <?> req : mInFlightRequests) { 
  req.cancel(); 
 } 
 ... 
} 

或者，取消这个队列里的所有请求：

@Override pubic void onStop() { 
 mRequestQueue.cancelAll(this); 
 ... 
} 

也可以根据RequestFilter或者Tag来终止某些请求：

@Override public void onStop() { 
 mRequestQueue.cancelAll( new RequestFilter() {}) 
 ... 
 // or 
 mRequestQueue.cancelAll(new Object()); 
 ... 

5.总结

从演讲的例子来看，Volley应该是简化了网络通信的一些开发，特别是针对如下两种情况：

• JSON对象
• 图片加载

但是这个东西也有不实用的地方，比如大数据（large payloads ），流媒体，这些case，还需要使用原始的方法，比如Download Manager等。

总之，如果你要编写网络程序，是不是可以考虑开始使用Volley呢？