【译】Volley官方文档四：构建一个标准的Request

2016-03-20 本文已影响483人 Lshare_Blog

原文链接：Making a Standard Request

这节课教你：

请求一张图像
请求JSON

这节课阐述如何使用Volley支持的通用request：

StringRequest。指定一个URL，然后从响应获取一个原始的字符串。查看Setting Up a Request Queue中的例子。
ImageRequest。指定一个URL，然后从响应中获取图像。
JsonObjectRequest 和 JsonArrayRequest（两个都是JsonRequest的子类）。指定一个URL，然后从响应中获取一个JSON对象或数组。

如果你想要的响应是这些类型的一种，那么你大可不必实现自定义的request。这节课教你怎样使用标准的request类型。有关如何实现自定义的request的信息，参阅Implementing a Custom Request

请求一张图像

Volley提供了下面的类用来请求图像。这些类在彼此的顶部层，提供用于处理图像不同程度的支持：

ImageRequest -- 从一个给定的URL中获取一张图像发送的canned（这个词怎么翻译才对？） request，返回一个解码后的bitmap。它提供了便捷的特性，比如指定一个大小来调整图像的大小。它的主要特性是：Volley的线程调度保证了昂贵的图像操作（比如解码、调整大小）会自动在工作线程（worker thread）进行。
ImageLoader -- 一个帮助类，帮助处理从远端URL加载和缓存图像。ImageLoader是大量ImageRequest的协调者，比如当在ListView中放置了大量的缩略图时，ImageLoader 提供了一个内存缓存，置于普通的Volley缓存之上，这对于避免闪烁很重要。这使得实现高速缓存命中而不用中断或推迟主线程成为可能，而这在磁盘I/O中是不可能的。ImageLoader 还会进行响应联合（response coalescing），而不至于几乎每个response handler都为了在一个view上设置bitmap，导致一个布局经过了多个图像。联合使得同时传递多个响应成为可能，提供了性能。
NetworkImageView -- 建立在ImageLoader的基础上，并且能在图像是通过URL在网络中获取的情景下高效地替代ImageView。NetworkImageView也能在view从它的层级中失联时，控制取消即将发出的request。

使用ImageRequest

下面是一个使用ImageRequest的例子。它从指定的URL中检索图像，然后显示在app中。提示：下面的代码是通过单例类来跟RequestQueue相互作用（参阅Setting Up a RequestQueue 获取该话题的更多讨论）：

ImageView mImageView;
String url = "http://i.imgur.com/7spzG.png";
mImageView = (ImageView) findViewById(R.id.myImage);
...

// 获取URL指定的图像并显示在UI中
ImageRequest request = new ImageRequest(url,
    new Response.Listener<Bitmap>() {
        @Override
        public void onResponse(Bitmap bitmap) {
            mImageView.setImageBitmap(bitmap);
        }
    }, 0, 0, null,
    new Response.ErrorListener() {
        public void onErrorResponse(VolleyError error) {
            mImageView.setImageResource(R.drawable.image_load_error);
        }
    });
// 通过单例类进入RequestQueue
MySingleton.getInstance(this).addToRequestQueue(request);

使用ImageLoader和NetworkImageView

你可以使用ImageLoader和NetworkImageView来高效地管理多图显示，比如在ListView中。在布局文件中，使用NetworkImageView就跟使用ImageView一样，例如：

<com.android.volley.toolbox.NetworkImageView
        android:id="@+id/networkImageView"
        android:layout_width="150dp"
        android:layout_height="170dp"
        android:layout_centerHorizontal="true" />

你可以单独使用ImageLoader来显示图像，比如：

ImageLoader mImageLoader;
ImageView mImageView;
// 将要加载图片的URL 
private static final String IMAGE_URL =
    "http://developer.android.com/images/training/system-ui.png";
...
mImageView = (ImageView) findViewById(R.id.regularImageView);

// 通过单例类获取ImageLoader
mImageLoader = MySingleton.getInstance(this).getImageLoader();
mImageLoader.get(IMAGE_URL, ImageLoader.getImageListener(mImageView,
         R.drawable.def_image, R.drawable.err_image));

然而，如果你想做的仅仅是填入一个ImageView，那么NetworkImageView能帮你做这些。示例：

ImageLoader mImageLoader;
NetworkImageView mNetworkImageView;
private static final String IMAGE_URL =
    "http://developer.android.com/images/training/system-ui.png";
...

// 获取即将显示图片的NetworkImageView 
mNetworkImageView = (NetworkImageView) findViewById(R.id.networkImageView);

// 通过单例获取ImageLoader
mImageLoader = MySingleton.getInstance(this).getImageLoader();

// 设置将要加载图片的URL , 并
// 指定用来构建请求的ImageLoader 
mNetworkImageView.setImageUrl(IMAGE_URL, mImageLoader);

上面的代码片段使用了单例类中的RequestQueue和ImageLoader，这在Setting Up a RequestQueue中阐述过。该设计方法保证了你的app创建了这些类的唯一实例，伴随着app的整个生命周期。ImageLoader（处理加载和缓存图像的帮助类）之所以如此重要，是因为内存缓存的主要功能是允许无闪烁的设备旋转。使用单例模式允许bitmap cache比activity存活时间长。反之，如果在activity中创建ImageLoader，ImageLoader会伴随着activity因用户每次旋转设备重建而重建。这样就导致了闪烁。

LRU缓存示例

Volley工具箱（toolbox）提供了一个标准的缓存实现--通过DiskBasedCache。该类直接缓存文件到硬盘中的指定目录。然而为了使用ImageLoader，你应该提供一个自定义的内存LRU 位图缓存（bitmap cache），它实现自ImageLoader.ImageCache接口。你可能想要用单例构建你的缓存；更多关于此的讨论，见Setting Up a RequestQueue。

下面是一个对内存中的LruBitmapCache类的示例实现。它继承自LruCache类并实现了ImageLoader.ImageCache接口：

import android.graphics.Bitmap;
import android.support.v4.util.LruCache;
import android.util.DisplayMetrics;
import com.android.volley.toolbox.ImageLoader.ImageCache;

public class LruBitmapCache extends LruCache<String, Bitmap>
        implements ImageCache {

    public LruBitmapCache(int maxSize) {
        super(maxSize);
    }

    public LruBitmapCache(Context ctx) {
        this(getCacheSize(ctx));
    }

    @Override
    protected int sizeOf(String key, Bitmap value) {
        return value.getRowBytes() * value.getHeight();
    }

    @Override
    public Bitmap getBitmap(String url) {
        return get(url);
    }

    @Override
    public void putBitmap(String url, Bitmap bitmap) {
        put(url, bitmap);
    }

    // 返回一个缓存大小，约等于3倍的屏幕宽度
    public static int getCacheSize(Context ctx) {
        final DisplayMetrics displayMetrics = ctx.getResources().
                getDisplayMetrics();
        final int screenWidth = displayMetrics.widthPixels;
        final int screenHeight = displayMetrics.heightPixels;
        // 每个像素4位
        final int screenBytes = screenWidth * screenHeight * 4;

        return screenBytes * 3;
    }
}

下面是如何初始化ImageLoader来使用缓存的例子：

RequestQueue mRequestQueue; // 假定已经存在
ImageLoader mImageLoader = new ImageLoader(mRequestQueue, new LruBitmapCache(
            LruBitmapCache.getCacheSize()));

请求JSON

Volley为JSON请求提供了如下的类：

JsonArrayRequest -- 一个从给定URL中获取JSONArray响应体的请求
JsonObjectRequest-- 一个从给定URL中获取JSONObject响应体的请求，允许一个可选的JSONObject作为请求体的一部分传递。

这两个类都是具有共同的基类JsonRequest。你使用它们跟使用其它request有着相同的样板。比如，下面的代码片段展示了获取一条JSON数据并作为text显示在UI中：

TextView mTxtDisplay;
ImageView mImageView;
mTxtDisplay = (TextView) findViewById(R.id.txtDisplay);
String url = "http://my-json-feed";

JsonObjectRequest jsObjRequest = new JsonObjectRequest
        (Request.Method.GET, url, null, new Response.Listener<JSONObject>() {

    @Override
    public void onResponse(JSONObject response) {
        mTxtDisplay.setText("Response: " + response.toString());
    }
}, new Response.ErrorListener() {

    @Override
    public void onErrorResponse(VolleyError error) {
        // TODO 待办

    }
});

// 通过单例类使用RequestQueue
MySingleton.getInstance(this).addToRequestQueue(jsObjRequest);

项目源码下载 ：点击下载

系列索引

更新日志：

2016年03月21日：添加了系列索引
2016年03月20日：添加了源码