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呢？