实现自定义的网络请求

编写:kesenhoo - 原文:http://developer.android.com/training/volley/request-custom.html

这节课会介绍如何实现自定义的请求类型，这些自定义的类型不属于 Volley 内置支持包里面。

编写一个自定义请求

大多数的请求类型都已经包含在 Volley 的工具箱里面。如果我们的请求返回数值是一个 string，image 或者 JSON，那么是不需要自己去实现请求类的。

对于那些需要自定义的请求类型，我们需要执行以下操作：

  • 继承 Request<T> 类，<T> 表示解析过的响应请求预期的数据类型。因此如果我们需要解析的响应类型是一个 String，可以通过继承 Request<String> 来创建自定义的请求。请参考 Volley 工具类中的 StringRequest 与 ImageRequest 来学习如何继承 Request<T>。
  • 实现抽象方法 parseNetworkResponse() 与 deliverResponse()，下面会详细介绍。

parseNetworkResponse

一个 Response 封装了用于发送的给定类型（例如，string、image、JSON等）解析过的响应。下面会演示如何实现 parseNetworkResponse()：

  1. @Override
  2. protected Response<T> parseNetworkResponse(
  3.         NetworkResponse response) {
  4.     try {
  5.         String json = new String(response.data,
  6.         HttpHeaderParser.parseCharset(response.headers));
  7.     return Response.success(gson.fromJson(json, clazz),
  8.     HttpHeaderParser.parseCacheHeaders(response));
  9.     }
  10.     // handle errors
  11. ...
  12. }

请注意：

  • parseNetworkResponse() 的参数是类型是 NetworkResponse，这种参数以 byte[]、HTTP status code 以及 response headers 的形式包含响应负载。
  • 我们实现的方法必须返回一个 Response<T>，它包含了我们指定类型的响应对象与缓存 metadata 或者是一个错误。

如果我们的协议没有标准的缓存机制，那么我们可以自己建立一个 Cache.Entry, 但是大多数请求都可以用下面的方式来处理:

  1. return Response.success(myDecodedObject,
  2.         HttpHeaderParser.parseCacheHeaders(response));

Volley 在工作线程中执行 parseNetworkResponse() 方法。这确保了耗时的解析操作，例如 decode 一张 JPEG 图片成 bitmap，不会阻塞 UI 线程。

deliverResponse

Volley 会把 parseNetworkResponse() 方法返回的数据带到主线程的回调中。如下所示：

  1. protected void deliverResponse(T response) {
  2.         listener.onResponse(response);

Example: GsonRequest

Gson 是一个使用映射支持 JSON 与 Java 对象之间相互转换的库文件。我们可以定义与 JSON keys 相对应名称的 Java 对象。把对象传递给 Gson，然后 Gson 会帮我们为对象填充字段值。下面是一个完整的示例：演示了使用 Gson 解析 Volley 数据：

  1. public class GsonRequest<T> extends Request<T> {
  2.     private final Gson gson = new Gson();
  3.     private final Class<T> clazz;
  4.     private final Map<String, String> headers;
  5.     private final Listener<T> listener;
  7.     /**
  8.      * Make a GET request and return a parsed object from JSON.
  9.      *
  10.      * @param url URL of the request to make
  11.      * @param clazz Relevant class object, for Gson's reflection
  12.      * @param headers Map of request headers
  13.      */
  14.     public GsonRequest(String url, Class<T> clazz, Map<String, String> headers,
  15.             Listener<T> listener, ErrorListener errorListener) {
  16.         super(Method.GET, url, errorListener);
  17.         this.clazz = clazz;
  18.         this.headers = headers;
  19.         this.listener = listener;
  20.     }
  22.     @Override
  23.     public Map<String, String> getHeaders() throws AuthFailureError {
  24.         return headers != null ? headers : super.getHeaders();
  25.     }
  27.     @Override
  28.     protected void deliverResponse(T response) {
  29.         listener.onResponse(response);
  30.     }
  32.     @Override
  33.     protected Response<T> parseNetworkResponse(NetworkResponse response) {
  34.         try {
  35.             String json = new String(
  36.                     response.data,
  37.                     HttpHeaderParser.parseCharset(response.headers));
  38.             return Response.success(
  39.                     gson.fromJson(json, clazz),
  40.                     HttpHeaderParser.parseCacheHeaders(response));
  41.         } catch (UnsupportedEncodingException e) {
  42.             return Response.error(new ParseError(e));
  43.         } catch (JsonSyntaxException e) {
  44.             return Response.error(new ParseError(e));
  45.         }
  46.     }
  47. }

如果你愿意使用的话，Volley 提供了现成的 JsonArrayRequest 与 JsonArrayObject类。参考上一课创建标准的网络请求。