胡凯

Android Training - Volley(Lesson 4 - 实现自定义的请求)

| Comments

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

编写一个自定义的请求Write a Custom Request

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

对于那些你需要自定义的请求类型,下面是你需要做得步骤:

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

parseNetworkResponse

为了能够提交一种指定类型的数据(例如,string,image,JSON等),需要对解析后的结果进行封装。下面会演示如何实现parseNetworkResponse()

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

请注意:

  • parseNetworkResponse()的参数是类型是NetworkResponse,这种参数包含了的响应数据内容有一个byte[],HTTP status code以及response headers.
  • 你实现的方法必须返回一个Response,它包含了你响应对象与缓存metadata或者是一个错误。

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

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

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

deliverResponse

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

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

Example: GsonRequest

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
public class GsonRequest<T> extends Request<T> {
    private final Gson gson = new Gson();
    private final Class<T> clazz;
    private final Map<String, String> headers;
    private final Listener<T> listener;

    /**
     * Make a GET request and return a parsed object from JSON.
     *
     * @param url URL of the request to make
     * @param clazz Relevant class object, for Gson's reflection
     * @param headers Map of request headers
     */
    public GsonRequest(String url, Class<T> clazz, Map<String, String> headers,
            Listener<T> listener, ErrorListener errorListener) {
        super(Method.GET, url, errorListener);
        this.clazz = clazz;
        this.headers = headers;
        this.listener = listener;
    }

    @Override
    public Map<String, String> getHeaders() throws AuthFailureError {
        return headers != null ? headers : super.getHeaders();
    }

    @Override
    protected void deliverResponse(T response) {
        listener.onResponse(response);
    }

    @Override
    protected Response<T> 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));
        }
    }
}

如果你愿意使用的话,Volley提供了现成的JsonArrayRequestJsonArrayObject类。参考上一课:创建标准的请求


学习自http://developer.android.com/training/volley/request-custom.html,欢迎交流讨论

Comments