Volley的自定义请求: GsonRequest

上一节 中写道, 可以利用Volley来获取网络Json数据, 但是使用获取到Json后再去解析是很麻烦的事情, 这一节我们仿照这JsonObjectRequest的写法, 来创造自己的GsonRequest.

JsonObjectRequest源码

笔者使用的Volley的依赖为:
compile 'com.mcxiaoke.volley:library:1.0.19'
查看JsonObjectRequest的源码, 可以看到, 只有短短的112行(包含注释).

• 其中包含了5个构造函数, 一个parseNetworkResponse方法,
  其中的构造函数均调用了父类的5参构造方法.
  剩下的parseNetworkResponse方法返回的是一个JsonObject, 一看就知道, 这个就是生成返回值的东西了.
• 父类为抽象类:JsonRequest, 其中也是一些构造方法, 直接看5参构造函数, 发现其为一些参数的初始化, 在往父类走, 发现是Request类.
  其实这个Request类就是所有请求的父类, 我们姑且不管他, 直接新建GsonRequest类并继承Request, 因为返回值为gson对象, 所以用泛型代替.

开始搞事情####

1. 创建GsonRequest类并继承Request, 使用泛型做为参数, 之后重写抽象类的方法, 以及构造函数

   
   
   1 新建GsonRequest
2. 在构造函数中初始化

• 因为使用到了Gson, 所以先要初始化Gson, 以及Gson对象
• 仿照JsonObject的初始化, 还需要添加Listener<T>

这时候, 你会发现构造函数的参数不够用了, 怕啥, 改! 重新生成构造函数, 并把Gson对象和Listener<T> 加上去, 然后在其中初始化Gson:

构造函数的修改

3. deliverResponse
   从名字可以看出来, 该函数是为将数据发送出去, 在JsonRequest中可以找到该方法, 即使用初始化后的Listener去解析数据, 应该是发送到了parseNetworkResponse中
   

   
   所以我们也直接使用监听器去解析数据:
   if (mListener != null) {mListener.onResponse(response);}

4. parseNetworkResponse
   首先贴上源码的描述

   
   
   
   

   子类必须继承该方法以处理网络响应(网络数据), 并且以泛型的形式返回. 这个方法将会在网络线程中调用, 如返回值为null将不去发送响应数据,
   也就是说, 该方法是对获取到网络数据的处理, 如果网络返回的是Json数据, 我们可以在此处使用Gson去封装Gson对象, 再利用泛型返回, 这样在使用的时候, 就可以直接获取到Gson对象了.
   这里先贴上JsonObjectRequest的处理方法:
   try {
   String jsonString = new String(response.data,
   HttpHeaderParser.parseCharset(response.headers, PROTOCOL_CHARSET));
   return Response.success(new JSONObject(jsonString),
   HttpHeaderParser.parseCacheHeaders(response));
   } catch (UnsupportedEncodingException e) {
   return Response.error(new ParseError(e));
   } catch (JSONException je) {
   return Response.error(new ParseError(je));
   }
   可以看到, 这里利用Response.success来设置回调返回值, name我们可以从返回值这里包裹一层Gson处理:
   至于PROTOCOL_CHARSET这个参数, 在源码中是个常量: "utf-8"
   try {
   String jsonString = new String(response.data,
   HttpHeaderParser.parseCharset(response.headers, "utf-8"));
   return Response.success(mGson.fromJson(jsonString,clazz),
   HttpHeaderParser.parseCacheHeaders(response));
   } catch (UnsupportedEncodingException e) {
   return Response.error(new ParseError(e));
   }
   至此, 我们的GsonRequest制作完成
   最后贴上整个工具类代码
   package util;

   import com.android.volley.NetworkResponse;
   import com.android.volley.ParseError;
   import com.android.volley.Request;
   import com.android.volley.Response;
   import com.android.volley.toolbox.HttpHeaderParser;
   import com.google.gson.Gson;
   import java.io.UnsupportedEncodingException;
   
    /**
     * Created by Administrator on 2017/7/26 0026.
     */
   
   public class GsonRequest<T> extends Request<T> {
        private Gson mGson;
        Class<T> clazz;
        private final Response.Listener<T> mListener;
   
        public GsonRequest(int method, String url, Response.ErrorListener listener, Class<T> clazz,
                   Response.Listener<T> mListener) {
            super(method, url, listener);
            this.clazz = clazz;
            this.mListener = mListener;
            mGson = new Gson();
            }
   
           @Override
           protected Response<T> parseNetworkResponse(NetworkResponse response) {
            try {
                String jsonString = new String(response.data,
                HttpHeaderParser.parseCharset(response.headers, "utf-8"));
                return Response.success(mGson.fromJson(jsonString, clazz),
                HttpHeaderParser.parseCacheHeaders(response));
            } catch (UnsupportedEncodingException e) {
                return Response.error(new ParseError(e));
            }
            }
   
           @Override
           protected void deliverResponse(T response) {
            if (mListener != null) {
               mListener.onResponse(response);
              }
           }
     }