Android 网络通信框架Volley基本介绍

Volley主页 https://android.googlesource.com/platform/frameworks/volley

http://www.youtube.com/watch?v=yhv8l9F44qo&feature=player_embedded

1. 什么是Volley

Google I/O 2013上。Volley公布了volley。在这之前,我们在程序中须要和网络通信的时候,大体使用的东西莫过于

  • AsyncTaskLoader
  • HttpURLConnection
  • AsyncTask
  • HTTPClient(Apache)等

Volley是Android平台上的网络通信库。能使网络通信更快,更简单,更健壮。

Volley名称的由来: a burst or emission of many things or a large amount at once

在Google IO的演讲上。其配图是一幅发射火弓箭的图。有点类似流星。见下图

Android 网络通信框架Volley基本介绍

watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvemhhb3lhemhpMjEyOQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="">

事实上。从这幅图,我们也能够看出来,Volley特别适合数据量不大可是通信频繁的场景。volley适合高速,简单的请求(Json对象,图片载入)。

Volley引入的背景

在曾经,我们可能面临例如以下非常多麻烦的问题。

比方曾经从网上下载图片的步骤可能是这种流程:

  • 在ListAdapter#getView()里開始图像的读取。
  • 通过AsyncTask等机制使用HttpURLConnection从server去的图片资源
  • 在AsyncTask#onPostExecute()里设置对应ImageView的属性。

而在Volley下,仅仅须要一个函数就可以,具体见后面的样例。

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

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

Volley提供的功能

简单来说,它提供了例如以下的便利功能:

  • JSON,图像等的异步下载;
  • 网络请求的排序(scheduling)
  • 网络请求的优先级处理
  • 缓存
  • 多级别取消请求
  • 和Activity和生命周期的联动(Activity结束时同一时候取消全部网络请求)

使用前的准备

引入Volley很easy,首先,从git库先克隆一个下来:

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

view

然后编译为jar包,再在自己的project里import进来。

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

使用样例

最简单的get请求

这个样例非常easy,从网络取得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的方法都须要从主线程里来调用。

使用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());  <span style="color:#000000;"><a target=_blank target="_blank" href="http://blog.csdn.net/t12x3456/article/details/9221611#" class="ViewSource" title="view plain" style="text-decoration: none; background-color: inherit; border: medium none; padding: 1px; margin: 0px 10px 0px 0px; font-size: 9px; display: inline-block; width: 16px; height: 16px; text-indent: -2000px;">ew plain</a></span>

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

使用自己定制的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();
}
}
}

Volley的架构设计

Volley使用了线程池来作为基础结构,主要分为主线程。cache线程和network线程。

主线程和cache线程都仅仅有一个。而NetworkDispatcher线程能够有多个。这样能解决比并行问题。

例如以下图:

Android 网络通信框架Volley基本介绍

其中蓝色部分代表主线程,绿色部分代表缓存线程,橙色部分代表网络线程。我们在主线程中调用RequestQueue的add()方法来增加一条网络请求。这条请求会先被增加到缓存队列其中,假设发现能够找到对应的缓存结果就直接读取缓存并解析。然后回调给主线程。假设在缓存中没有找到结果,则将这条请求增加到网络请求队列中,然后处理发送HTTP请求,解析响应结果,写入缓存,并回调主线程。

假设在一个Activity里面启动了网络请求,而在这个网络请求还没返回结果的时候。假设Activity被结束了。则我们须要写例如以下代码作为防守:

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

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

使用Volley的话,我们能够在Activity停止的时候,同一时候取消全部或部分未完毕的网络请求。

Volley里全部的请求结果会返回给主进程。假设在主进程里取消了某些请求,则这些请求将不会被返回给主线程。

比方。能够针对某些个request做取消操作y

    @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());
...

总结

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

  • JSON对象
  • 图片载入

可是这个东西也有不有用的地方,比方大数据(large payloads ),流媒体,这些case,还须要使用原始的方法,比方Download Manager等。

案例分析

接下来,我们来学习简单的使用下volley给我提供的API吧。

首先拿到一个请求队列

(RequestQueue仅仅须要一个实例就可以,不像AsyncTask每次使用都要new一个)

    // 初始化RequestQueue一个activity仅仅须要一个
private void initRequestQueue() {
mQueue = Volley.newRequestQueue(getApplicationContext());
}

实现volley的异步请求类

(JsonObjectRequest,JsonArrayRequest,StringRequest,ImageRequest)

因为使用方法都相差不大。我就不一一举例了。举几个经常使用有代表性的样例:

StringRequest的get请求
JsonObjectRequest的post请求:
    // post请求
private void loadPostJson(String url) {
// 第二个參数说明:
// Constructor which defaults to GET if jsonRequest is null, POST
// otherwise.
// 默认情况下设成null为get方法,否则为post方法。 JsonObjectRequest srReq = new JsonObjectRequest(url, null,
new JsonListener(), new StrErrListener()) { @Override
protected Map<String, String> getParams() throws AuthFailureError {
Map<String, String> map = new HashMap<String, String>();
map.put("w", "2459115");
map.put("u", "f");
return map;
}
};
srReq.setShouldCache(false); // 控制是否缓存
startVolley(srReq);
}

大家注意看的话,不管是JsonObjectReques的postt还是StringRequest的get都须要传入两个监听函数一个是成功一个是失败。成功监听他们会返回对应类型的数据:

    // Str请求成功回调
private class StrListener implements Listener<String> { @Override
public void onResponse(String arg0) {
Log.e(Tag, arg0); } } // Gson请求成功回调
private class GsonListener implements Listener<ErrorRsp> { @Override
public void onResponse(ErrorRsp arg0) {
Toast.makeText(mContext, arg0.toString(), Toast.LENGTH_LONG).show();
} }
// 共用失败回调
private class StrErrListener implements ErrorListener { @Override
public void onErrorResponse(VolleyError arg0) {
Toast.makeText(mContext,
VolleyErrorHelper.getMessage(arg0, mContext),
Toast.LENGTH_LONG).show();
} }
ImageRequest
    /**
* 第三第四个參数分别用于指定同意图片最大的宽度和高度。假设指定的网络图片的宽度或高度大于这里的最大值。则会对图片进行压缩,
* 指定成0的话就表示无论图片有多大。都不会进行压缩。
*
* @param url
* 图片地址
* @param listener
* @param maxWidth
* 指定同意图片最大的宽度
* @param maxHeight
* 指定同意图片最大的高度
* @param decodeConfig
* 指定图片的颜色属性。Bitmap.Config下的几个常量.
* @param errorListener
*/
private void getImageRequest(final ImageView iv, String url) {
ImageRequest imReq = new ImageRequest(url, new Listener<Bitmap>() { @Override
public void onResponse(Bitmap arg0) {
iv.setImageBitmap(arg0);
}
}, 60, 60, Bitmap.Config.ARGB_8888, new StrErrListener());
startVolley(imReq);
}

看到如今大家肯定会疑惑写了这么多不同类型的Request究竟怎样执行?接下请看:

    // 加入及開始请求
private void startVolley(Request req) { // 设置超时时间
// req.setRetryPolicy(new DefaultRetryPolicy(20 * 1000, 1, 1.0f));
// 将请求加入队列
mQueue.add(req);
// 開始发起请求
mQueue.start();
}

volley不仅提供了这些请求的方式。还提供了载入图片的一些方法和控件:

比方我们一个列表须要载入非常多图片我们能够使用volley给我们提供的ImageLoader( ImageLoader比ImageRequest更加高效,由于它不仅对图片进行缓存。还能够过滤掉反复的链接。避免反复发送请求。

    public class ImageAdapter extends ArrayAdapter<String> {  

        private RequestQueue mQueue;
private ImageLoader mImageLoader; public ImageAdapter(Context context, List<String> objects) {
super(context, 0, objects);
mQueue = Volley.newRequestQueue(getContext());
mImageLoader = new ImageLoader(mQueue, new BitmapCache());
} @Override
public View getView(int position, View convertView, ViewGroup parent) {
String url = getItem(position);
ImageView imageView;
if (convertView == null) {
imageView = new ImageView(getContext());
} else {
imageView = (ImageView) convertView;
}
// getImageListener(imageView控件对象。默认图片地址。失败图片地址);
ImageListener listener = ImageLoader.getImageListener(imageView, android.R.drawable.ic_menu_rotate, android.R.drawable.ic_delete);
// get(图片地址。listener。宽,高);自己主动帮你处理图片的宽高再也不怕大图片的oom了
mImageLoader.get(url, listener,100,200);
return imageView;
} }

当然还须要重写ImageCache这个类 //使用LruCache再也不用怕载入多张图片oom了

    public class <span style="font-family: Arial;">BitmapCache</span><span style="font-family: Arial;"> extends LruCache<String, Bitmap> implements ImageCache {</span>
// LruCache 原理:Cache保存一个强引用来限制内容数量,每当Item被訪问的时候,此Item就会移动到队列的头部。 当cache已满的时候增加新的item时,在队列尾部的item会被回收。
// 解释:当超出指定内存值则移除近期最少用的图片内存
public static int getDefaultLruCacheSize() {
// 拿到最大内存
final int maxMemory = (int) (Runtime.getRuntime().maxMemory() / 1024);
// 拿到内存的八分之中的一个来做图片内存缓存
final int cacheSize = maxMemory / 8; return cacheSize;
} public BitmapLruCache() {
this(getDefaultLruCacheSize());
} public BitmapLruCache(int sizeInKiloBytes) {
super(sizeInKiloBytes);
} @Override
protected int sizeOf(String key, Bitmap value) {
return value.getRowBytes() * value.getHeight() / 1024;
} @Override
public Bitmap getBitmap(String url) {
return get(url);
} @Override
public void putBitmap(String url, Bitmap bitmap) {
put(url, bitmap);
}
}

Volley还提供的载入图片的控件com.android.volley.NetworkImageView。(这个控件在被从父控件detach的时候。会自己主动取消网络请求的,即全然不用我们操心相关网络请求的生命周期问题。并且NetworkImageView还会依据你对图片设置的width和heigh自己主动压缩该图片不会产生多的内存,还有NetworkImageView在列表中使用不会图片错误)

<com.android.volley.toolbox.NetworkImageView
android:id="@+id/network_image_view"
android:layout_width="100dp"
android:layout_height="100dp" />

用法:

    private void networkImageViewUse(NetworkImageView iv, String url) {
ImageLoader imLoader = new ImageLoader(mQueue, new BitmapLruCache());
iv.setDefaultImageResId(R.drawable.ic_launcher);
iv.setErrorImageResId(R.drawable.ic_launcher);
iv.setImageUrl(url, imLoader);
}

我们说了这么多都是请求,那么怎样取消请求呢?

1.activity自己主动销毁时它会自定取消全部请求。

2.给请求设置标签:

    request.setTag("My Tag");  

取消全部指定标记的请求:

上一篇:Android 网络通信框架Volley简介


下一篇:Android 网络通信框架Volley(二)