[Android]Volley的使用

Volley是Google I/O 2013上提出来的为Android提供简单快速网络访问的项目。Volley特别适合数据量不大但是通信频繁的场景。

优势

0. https://www.captechconsulting.com/blog/raymond-robinson/google-io-2013-volley-image-cache-tutorial

Volley是Android开发者新的瑞士军刀，它提供了优美的框架，使得Android应用程序网络访问更容易和更快。 Volley抽象实现了底层的HTTP Client库，让你不关注HTTP Client细节，专注于写出更加漂亮、干净的RESTful HTTP请求。另外，Volley请求会异步执行，不阻挡主线程。

Volley提供的功能

为什么使用异步HTTP请求？

Android中要求HTTP请求异步执行，如果在主线程执行HTTP请求，可能会抛出android.os.NetworkOnMainThreadException 异常。阻塞主线程有一些严重的后果，它阻碍UI渲染，用户体验不流畅，它可能会导致可怕的ANR（Application Not Responding）。要避免这些陷阱，作为一个开发者，应该始终确保HTTP请求是在一个不同的线程。

怎样使用Volley

这篇博客将会详细的介绍在应用程程中怎么使用volley，它将包括一下几方面：

安装和使用Volley库

使用请求队列

Volley的所有请求都放在一个队列，然后进行处理，这里是你如何将创建一个请求队列：

理想的情况是把请求队列集中放到一个地方，最好是初始化应用程序类中初始化请求队列，下面类做到了这一点：

异步的JSON、String请求

JsonObjectRequest

这个类可以用来发送和接收JSON对象。这个类的一个重载构造函数允许设置适当的请求方法（DELETE，GET，POST和PUT）。如果您正在使用一个RESTful服务端，可以使用这个类。下面的示例显示如何使GET和POST请求。

JsonArrayRequest

这个类可以用来接受 JSON Arrary，不支持JSON Object。这个类现在只支持 HTTP GET。由于支持GET，你可以在URL的后面加上请求参数。类的构造函数不支持请求参数。

StringRequest

这个类可以用来从服务器获取String，如果想自己解析请求响应可以使用这个类，例如返回xml数据。它还可以使用重载的构造函数定制请求。

取消请求

Volley提供了强大的API取消未处理或正在处理的请求。取消请求最简单的方法是调用请求队列cancelAll（tag）的方法，前提是你在添加请求时设置了标记。这样就能使标签标记的请求挂起。

重试失败的请求，自定义请求超时

Volley中没有指定的方法来设置请求超时时间，可以设置RetryPolicy 来变通实现。DefaultRetryPolicy类有个initialTimeout参数，可以设置超时时间。要确保最大重试次数为1，以保证超时后不重新请求。

如果你想失败后重新请求（因超时），您可以指定使用上面的代码，增加重试次数。注意最后一个参数，它允许你指定一个退避乘数可以用来实现“指数退避”来从RESTful服务器请求数据。

设置请求头（HTTP headers）

有时候需要给HTTP请求添加额外的头信息，一个常用的例子是添加 “Authorization”到HTTP 请求的头信息。Volley请求类提供了一个 getHeaers（）的方法，重载这个方法可以自定义HTTP 的头信息。

使用Cookies

Volley中没有直接的API来设置cookies，Volley的设计理念就是提供干净、简洁的API来实现RESTful HTTP请求，不提供设置cookies是合理的。

下面是修改后的ApplicationController类，这个类修改了getRequestQueue()方法，包含了设置cookie方法，这些修改还是有些粗糙。

错误处理

正如前面代码看到的，在创建一个请求时，需要添加一个错误监听onErrorResponse。如果请求发生异常，会返回一个VolleyError实例。

总结：

Volley是一个非常好的库，你可以尝试使用一下，它会帮助你简化网络请求，带来更多的益处。

我也希望更加全面的介绍Volley，以后可能会介绍使用volley加载图像的内容，欢迎关注。

http://www.inferjay.com/blog/2013/08/03/google-i-o-2013-volley-image-cache-tutorial/ Inferjay的技术博客

Gooogle I/O 2013已经结束了，并且对于Android开发的未来它给我们留下了更大的期望。令人非常兴奋的是在今年的I/O大会上展示了一个叫Volley的库。Volley是一个处理和缓存网络请求的库，减少开发人员在实际的每一个应用中写同样的样板代码。写样板代码是很无聊的并且也增加了开发人员出错的几率。Google是出于这些考虑创建了Volley。

如果你还没有看过Gooogle　I/O中关于Volley的介绍，在继续这篇文章之前我建议你先去看看关于Volley的介绍，对它有一些基本的理解。

在Google I/O介绍的时候，Ficus Kirpatrick讲了很多关于Volley如何的有助于图片加载。你会发现在Volley作为你的图片加载解决方案的时候，虽然Volley自己处理了L2的缓存，它需要但是没有包含L1的缓存。许多人会使用像Universal Image Loader或者Square`s newer Picasso这些第三方的库去处理图片的加载；然而这些库通常已经同时处理了图片的加载和缓存。所以，我们如何使用Volley来替换图片的加载和缓存呢？首先，让我们看看Volley提供的便利的加载方法，我们稍后再看他们的不同之处。

ImageLoader

ImageLoader这个类需要一个Request的实例以及一个ImageCache的实例。图片通过一个URL和一个ImageListener实例的get()方法就可以被加载。从哪里，ImageLoader会检查ImageCache,而且如果缓存里没有图片就会从网络上获取。

NetworkImageView

这个类在布局文件中替换ImageViews，并且将使用ImageLoader。NetworkImageView的setUrl()这个方法需要一个字符串的URL路径以及一个ImageLoader的实例。然后它使用ImageLoader的get()方法获取图片数据。

<com.android.volley.toolbox.NetworkImageView
    android:id="@+id/twitterUserImage"
    android:layout_alignParentLeft="true"
    android:layout_alignParentTop="true"
    android:layout_width="40dp"
    android:layout_height="40dp"
    android:padding="5dp"
    />

ImageCache

Volley的ImageCache接口允许你使用你喜欢的L1缓存实现。不幸的是Volley没有提供默认的实现。在I/O的介绍中展示了BitmapLruCache的一点代码片段，但是Volley这个库本身并不包含任何相关的实现。

ImageCache接口有两个方法，getBitmap(String url)和putBitmap(String url, Bitmap bitmap).这两个方法足够简单直白，他们可以添加任何的缓存实现。

在Volley中添加图片缓存

对于这个例子，我创建了一个简单的应用，它从Twitter上搜索提取“CapTech”这个词的推文，并且把包含这个词的推文的用户名和照片显示在一个ListView中，在你滑动这个列表的时候将自动加载以前的记录，并根据需要从缓存中拉取图片。

alt text

例子里有２个可用的缓存实现。一个基于内存的LRU缓存。对于磁盘缓存实现我选择使用由Jake Wharton写的DiskLruCache。我只所以选择这个实现是因为他在Android社区中被经常使用和推荐的并且有一些人试图去改进它。使用一个基于磁盘的L1缓存有可能导致i/o阻塞的问题。Volley已经内置了一个磁盘L2缓存。磁盘L1缓存包括在内了，由于我原来不知道Volley是如何处理图片请求缓存的。

在这个例子中主要的组件实现如下:

RequestManager

RequestManager维护了我们的一个RequestQueue的引用。Volley使用RequestQueue不仅处理了我们给Twitter的数据请求，而且也处理了我的的图片加载。

RequestQueue

这个类虽然跟图片加载没有直接的关系，但是它是具有代表性，它是如何继承Volley的Request类去处理你的JSON解析。它使用GET请求到Twtter并获取TwitterData对象。

BitmapLruImageCache

这是一个基于“least recently used(最近最少使用算法,简称LRU)”内存缓存实现。它是快速的并且不会引起I/O阻塞的。推荐这种方法。

DiskLruImageCache

DiskLruImageCache是一个DiskLruCache和bitmap-centered的包装实现。它从DiskLruCache中获取和添加bitmaps，并且处理缓存的实例。一个磁盘缓存或许会引起I/O的阻塞。

ImageCacheManager

ImageCacheManager持有一个我们的ImageCache和Volley ImageLoader的引用。

有一件事情你要注意，在ImageCacheManager中我们使用了字符串URL的hashCode()值作为缓存的Key。这么做是因为在URL中的某些字符不能作为缓存的Key。

BuzzArrayAdapter

这是一个简单的Adapter。这里唯一要注意的是我们实现了Volley的Listener和ErrListener接口并且将这个 Adapter作为 NetworkImageView’s的setUrl(String string , Listener listener, ErrorListener errorListener) 方法的Listener。这个Adapter还有一点额外的代码，用来在滚动的时候加载老的推文。

Tweet tweet = mData.get(position);
if(tweet != null){
viewHolder.twitterUserImage.setImageUrl(tweet.getUserImageUrl(),ImageCacheManager.getInstance().getImageLoader());
	viewHolder.userNameTextView.setText("@" + tweet.getUsername());
	viewHolder.messageTextView.setText(tweet.getMessage());
	viewHolder.tweetTimeTextView.setText(formatDisplayDate(tweet.getCreatedDate()));
	viewHolder.destinationUrl = tweet.getDestinationUrl();
}

Putting it all together

把这些组件组合在一起，图片加载和缓存是如此的简单。在启动时，在MainApplication这个类中初始化RequestManager和ImageCacheManager。在那里你可以定义你想要的L1缓存类型。内存缓存是默认的。

在MainActivity中我们调用TwitterManager并且加载我们的的初始数据集。一旦我们接收到响应我们就把这个响应传递给一个BuzzArrayAdapter并把这个Adapter设置到我们的ListView上。

正如我们已经在上面看到了BuzzArrayAdapter的代码,对于NetworkImageView所有繁重的图片加载操作我们仅仅需要从我们的ImageCacheManager中获取一个ImageLoader的实例传递给它就可以了。

ImageCacheManager会检查我的LRU缓存实现并且如果这个图片是可用的就会返回它。如果这个图片不在在缓存中那么就从网络获取它。

当你滚动ListView的时候BuzzArrayAdapter将一起加载额外的推文和图片，并且重用在缓存中已经存在的图片。

Closing Thoughts on Volley

虽然Volley是好用的，快速的，很容易实现的；但他也有一些不足的地方:

这个库没有任何的文档和例子。
比如缓存配置组件，他们为什么不做成可配置的。
从以上可以看出，除了一个比较奇怪的基本图片缓存实现以外,它甚至可能有使用NoImageCache的实现,或者在缓存完全可选的时候，你只是想从网络上获取任何东西。

关于Volley在开发者社区中有很多令人激动的事情，并且有很的好的理由。感觉它就像一个库，它包含了一部分旧的Android API.像在I/O上公布的新的定位API,它是非常纯净的~~~~

Github上的例子源码

VolleyImageCacheExample

附件:

VolleyImageCacheExample-master.zip

原文作者:

Trey Robinson

原文地址:

http://blogs.captechconsulting.com/blog/raymond-robinson/google-io-2013-volley-image-cache-tutorial

关于本文

前端时间偶然间看到了Volley，最近开始做一个新项目又重新去看了看I/O中关于Volley的介绍,感觉Volley很牛逼，于是就想在新项目中试试Volley,找来找去关于Volley的资料几乎没有，在Google中找到了这篇文章，看了觉得不错，于是就决定翻译一下，一来加深自己的理解，二来呢顺便补一下自己那惨不忍睹的英语。由于本人英语水平比较烂，翻译的时候有可能会曲解原作者的意思，建议英语好的大牛飘过此文去看作者的原文，欢迎大家吐槽和拍砖，觉得译文中有那些地方我翻译的不妥的地方欢迎回复指正，我们相互学习～～～

声明

3. Android开源框架Volley(Google IO 2013)源代码及内部实现分析

http://my.oschina.net/u/1420982/blog/184209

1.Volley概述

在项目开发过程中，博主曾写过大量的访问网络重复代码，特别是ListView adapter很难避免getView()方法不被重复调用，如果ImageView不利用缓存机制，那么网络的负荷就会更大！曾将访问网络代码和缓存封装起来使用，但是中间仍存在不少瑕疵！今年的Google I/O 2013上，Volley发布了！Volley是Android平台上的网络通信库，能使网络通信更快，更简单，更健壮

SouthEast.jpg (145.72 KB, 下载次数: 0)

下载附件保存到相册

昨天 16:24 上传

Volley特别适合数据量不大但是通信频繁的场景，现在android提供的源码已经包含Volley，以后在项目中，可以根据需求引入Volley jar文件！

2.Volley源码分析 (1).Volley.java Volley.newRequestQueue()方法在一个app最好执行一次，可以使用单例设计模式或者在application完成初始化，具体原因请查看代码分析

/**
* @author zimo2013
* [url=home.php?mod=space&uid=189949]@See[/url] http://blog.csdn.net/zimo2013
*/
public static RequestQueue newRequestQueue(Context context, HttpStack stack) {
File cacheDir = new File(context.getCacheDir(), DEFAULT_CACHE_DIR);
String userAgent = "volley/0";
try {
String packageName = context.getPackageName();
PackageInfo info = context.getPackageManager().getPackageInfo(packageName, 0);
userAgent = packageName + "/" + info.versionCode;
} catch (NameNotFoundException e) {
}
if (stack == null) {
if (Build.VERSION.SDK_INT >= 9) {
stack = new HurlStack();
} else {
stack = new HttpClientStack(AndroidHttpClient.newInstance(userAgent));
}
}
Network network = new BasicNetwork(stack);
//cacheDir 缓存路径 /data/data/<pkg name>/cache/<name>
RequestQueue queue = new RequestQueue(new DiskBasedCache(cacheDir), network);
queue.start();
/*
* 实例化一个RequestQueue，其中start()主要完成相关工作线程的开启，
* 比如开启缓存线程CacheDispatcher先完成缓存文件的扫描，还包括开启多个NetworkDispatcher访问网络线程，
* 该多个网络线程将从同一个网络阻塞队列中读取消息
*
* 此处可见，start()已经开启，所有我们不用手动的去调用该方法，在start()方法中如果存在工作线程应该首先终止，并重新实例化工作线程并开启
* 在访问网络很频繁，而又重复调用start()，势必会导致性能的消耗；但是如果在访问网络很少时，调用stop()方法，停止多个线程，然后调用start(),反而又可以提高性能，具体可折中选择
*/
return queue;
}

复制代码

(2).RequestQueue.java

/**
* RequestQueue类存在2个非常重要的PriorityBlockingQueue类型的成员字段mCacheQueue mNetworkQueue ，该PriorityBlockingQueue为java1.5并发库提供的新类
* 其中有几个重要的方法，比如take()为从队列中取得对象，如果队列不存在对象，将会被阻塞，直到队列中存在有对象，类似于Looper.loop()
*
* 实例化一个request对象，调用RequestQueue.add(request),该request如果不允许被缓存，将会被添加至mNetworkQueue队列中，待多个NetworkDispatcher线程take()取出对象
* 如果该request可以被缓存，该request将会被添加至mCacheQueue队列中，待mCacheDispatcher线程从mCacheQueue.take()取出对象，
* 如果该request在mCache中不存在匹配的缓存时，该request将会被移交添加至mNetworkQueue队列中，待网络访问完成后，将关键头信息添加至mCache缓存中去！
*
* @author zimo2013
* @see http://blog.csdn.net/zimo2013
*/
public void start() {
stop();
mCacheDispatcher = new CacheDispatcher(mCacheQueue, mNetworkQueue, mCache, mDelivery);
mCacheDispatcher.start();
// Create network dispatchers (and corresponding threads) up to the pool size.
for (int i = 0; i < mDispatchers.length; i++) {
NetworkDispatcher networkDispatcher = new NetworkDispatcher(mNetworkQueue, mNetwork,
mCache, mDelivery);
mDispatchers[i] = networkDispatcher;
networkDispatcher.start();
}
}

复制代码

(3).CacheDispatcher.java

/**
* @author zimo2013
* @see http://blog.csdn.net/zimo2013
*/
@Override
public void run() {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
//缓存初始化，会遍历整个缓存文件夹
mCache.initialize();
{
//执行代码
/*if (!mRootDirectory.exists()) {
if (!mRootDirectory.mkdirs()) {
VolleyLog.e("Unable to create cache dir %s", mRootDirectory.getAbsolutePath());
}
return;
}
File[] files = mRootDirectory.listFiles();
if (files == null) {
return;
}
for (File file : files) {
FileInputStream fis = null;
try {
fis = new FileInputStream(file);
CacheHeader entry = CacheHeader.readHeader(fis);
entry.size = file.length();
putEntry(entry.key, entry);
} catch (IOException e) {
if (file != null) {
file.delete();
}
} finally {
try {
if (fis != null) {
fis.close();
}
} catch (IOException ignored) { }
}
}*/
}
while (true) {
try {
//该方法可能会被阻塞
final Request request = mCacheQueue.take();
Cache.Entry entry = mCache.get(request.getCacheKey());
if (entry == null) {
//缓存不存在，则将该request添加至网络队列中
mNetworkQueue.put(request);
continue;
}
//是否已经过期
if (entry.isExpired()) {
request.setCacheEntry(entry);
mNetworkQueue.put(request);
continue;
}
Response<?> response = request.parseNetworkResponse(
new NetworkResponse(entry.data, entry.responseHeaders));
//存在缓存，执行相关操作
} catch (InterruptedException e) {
}
}
}

复制代码

(4).NetworkDispatcher.java

/**
* @author zimo2013
* @see http://blog.csdn.net/zimo2013
*/
@Override
public void run() {
Request request;
while (true) {
try {
//可能会被
request = mQueue.take();
} catch (InterruptedException e) {
// We may have been interrupted because it was time to quit.
if (mQuit) {
return;
}
continue;
}
try {
//访问网络，得到数据
NetworkResponse networkResponse = mNetwork.performRequest(request);
if (networkResponse.notModified && request.hasHadResponseDelivered()) {
request.finish("not-modified");
continue;
}
// Parse the response here on the worker thread.
Response<?> response = request.parseNetworkResponse(networkResponse);
// 写入缓存
if (request.shouldCache() && response.cacheEntry != null) {
mCache.put(request.getCacheKey(), response.cacheEntry);
request.addMarker("network-cache-written");
}
// Post the response back.
request.markDelivered();
mDelivery.postResponse(request, response);
} catch (VolleyError volleyError) {
parseAndDeliverNetworkError(request, volleyError);
} catch (Exception e) {
VolleyLog.e(e, "Unhandled exception %s", e.toString());
mDelivery.postError(request, new VolleyError(e));
}
}
}

复制代码

(5).StringRequest.java

其中在parseNetworkResponse()中，完成将byte[]到String的转化,可能会出现字符乱码，HttpHeaderParser.parseCharset(response.headers)方法在尚未指定是返回为ISO-8859-1，可以修改为 utf-8

public class StringRequest extends Request<String> {
private final Listener<String> mListener;
/**
* Creates a new request with the given method.
*
* @param method the request {@link Method} to use
* @param url URL to fetch the string at
* @param listener Listener to receive the String response
* @param errorListener Error listener, or null to ignore errors
*/
public StringRequest(int method, String url, Listener<String> listener,
ErrorListener errorListener) {
super(method, url, errorListener);
mListener = listener;
}
public StringRequest(String url, Listener<String> listener, ErrorListener errorListener) {
this(Method.GET, url, listener, errorListener);
}
@Override
protected void deliverResponse(String response) {
mListener.onResponse(response);
}
@Override
protected Response<String> parseNetworkResponse(NetworkResponse response) {
String parsed;
try {
//将data字节数据转化为String对象
parsed = new String(response.data, HttpHeaderParser.parseCharset(response.headers));
} catch (UnsupportedEncodingException e) {
parsed = new String(response.data);
}
//返回Response对象，其中该对象包含访问相关数据
return Response.success(parsed, HttpHeaderParser.parseCacheHeaders(response));
}
}

复制代码

(6).ImageLoader.java

/**
* @author zimo2013
* @see http://blog.csdn.net/zimo2013
*/
public ImageContainer get(String requestUrl, ImageListener imageListener,
int maxWidth, int maxHeight) {
throwIfNotOnMainThread();
final String cacheKey = getCacheKey(requestUrl, maxWidth, maxHeight);
//从mCache得到bitmap对象，因此可以覆写ImageCache，完成图片的三级缓存，即在原有的LruCache添加一个软引用缓存
Bitmap cachedBitmap = mCache.getBitmap(cacheKey);
if (cachedBitmap != null) {
//得到缓存对象
ImageContainer container = new ImageContainer(cachedBitmap, requestUrl, null, null);
imageListener.onResponse(container, true);
return container;
}
ImageContainer imageContainer =
new ImageContainer(null, requestUrl, cacheKey, imageListener);
// 首先更新该view，其指定了defaultImage
imageListener.onResponse(imageContainer, true);
// 根据可以去检查该请求是否已经发起过
BatchedImageRequest request = mInFlightRequests.get(cacheKey);
if (request != null) {
request.addContainer(imageContainer);
return imageContainer;
}
Request<?> newRequest =
new ImageRequest(requestUrl, new Listener<Bitmap>() {
@Override
public void onResponse(Bitmap response) {
//如果请求成功
onGetImageSuccess(cacheKey, response);
}
}, maxWidth, maxHeight,
Config.RGB_565, new ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
onGetImageError(cacheKey, error);
}
});
//添加至请求队列中
mRequestQueue.add(newRequest);
//同一添加进map集合，以方便检查该request是否正在请求网络，可以节约资源
mInFlightRequests.put(cacheKey, new BatchedImageRequest(newRequest, imageContainer));
return imageContainer;
}

复制代码

private void onGetImageSuccess(String cacheKey, Bitmap response) {
//缓存对象
mCache.putBitmap(cacheKey, response);
// 请求完成，不需要检测
BatchedImageRequest request = mInFlightRequests.remove(cacheKey);
if (request != null) {
request.mResponseBitmap = response;
//处理结果
batchResponse(cacheKey, request);
}
}

复制代码

private void batchResponse(String cacheKey, BatchedImageRequest request) {
mBatchedResponses.put(cacheKey, request);
//通过handler，发送一个操作
if (mRunnable == null) {
mRunnable = new Runnable() {
@Override
public void run() {
for (BatchedImageRequest bir : mBatchedResponses.values()) {
for (ImageContainer container : bir.mContainers) {
if (container.mListener == null) {
continue;
}
if (bir.getError() == null) {
container.mBitmap = bir.mResponseBitmap;
//更新结果
container.mListener.onResponse(container, false);
} else {
container.mListener.onErrorResponse(bir.getError());
}
}
}
mBatchedResponses.clear();
mRunnable = null;
}
};
// mHandler对应的looper是MainLooper，因此被MainLooper.loop()得到该message，故该runnable操作在主线程中执行，
mHandler.postDelayed(mRunnable, mBatchResponseDelayMs);
}
}

复制代码

3.总结

SouthEast.jpg (187.99 KB, 下载次数: 0)

下载附件保存到相册

昨天 16:24 上传

RequestQueue类存在2个非常重要的PriorityBlockingQueue类型的成员字段mCacheQueue mNetworkQueue ，该PriorityBlockingQueue为java1.5并发库提供的！其中有几个重要的方法，比如take()为从队列中取得对象，如果队列不存在对象，将会被阻塞，直到队列中存在有对象，类似于Looper.loop()。实例化一个request对象，调用 RequestQueue.add(request),该request如果不允许被缓存，将会被添加至mNetworkQueue队列中，待多个 NetworkDispatcher线程从mNetworkQueue中take()取出对象。如果该request可以被缓存，该request将会被添加至mCacheQueue队列中，待mCacheDispatcher线程从mCacheQueue.take()取出对象，如果该request在 mCache中不存在匹配的缓存时，该request将会被移交添加至mNetworkQueue队列中，待网络访问完成后，将关键头信息添加至 mCache缓存中去，并通过ResponseDelivery主线程调用request的相关方法！Volley实例