Android Volley完全解析(三)，定制自己的Request
转载请注明出处：http://blog.csdn.net/guolin_blog/article/details/17612763
经过前面两篇文章的学习，我们已经掌握了Volley各种Request的使用方法，包括StringRequest、JsonRequest、ImageRequest等。其中StringRequest用于请求一条普通的文本数据，JsonRequest(JsonObjectRequest、JsonArrayRequest)用于请求一条JSON格式的数据，ImageRequest则是用于请求网络上的一张图片。
可是Volley提供给我们的Request类型就只有这么多，而我们都知道，在网络上传输的数据通常有两种格式，JSON和XML，那么如果想要请求一条XML格式的数据该怎么办呢？其实很简单，Volley提供了非常强的扩展机制，使得我们可以很轻松地定制出任意类型的Request，这也就是本篇文章的主题了。
在开始之前还是友情提醒一下，如果你还没有阅读过我前面两篇关于Volley的文章，建议先去阅读一下AndroidVolley完全解析(一)，初识Volley的基本用法和AndroidVolley完全解析(二)，使用Volley加载网络图片。
1.自定义XMLRequest
下面我们准备自定义一个XMLRequest，用于请求一条XML格式的数据。那么该从哪里开始入手呢？额，好像是有些无从下手。遇到这种情况，我们应该去参考一下Volley的源码，看一看StringRequest是怎么实现的，然后就可以模仿着写出XMLRequest了。首先看下StringRequest的源码，如下所示：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
/**
*AcannedrequestforretrievingtheresponsebodyatagivenURLasaString.
*/
publicclassStringRequestextendsRequest<String>{
privatefinalListener<String>mListener;
/**
*Createsanewrequestwiththegivenmethod.
*
*@parammethodtherequest{@linkMethod}touse
*@paramurlURLtofetchthestringat
*@paramlistenerListenertoreceivetheStringresponse
*@paramerrorListenerErrorlistener,ornulltoignoreerrors
*/
publicStringRequest(intmethod,Stringurl,Listener<String>listener,
ErrorListenererrorListener){
super(method,url,errorListener);
mListener=listener;
}
/**
*CreatesanewGETrequest.
*
*@paramurlURLtofetchthestringat
*@paramlistenerListenertoreceivetheStringresponse
*@paramerrorListenerErrorlistener,ornulltoignoreerrors
*/
publicStringRequest(Stringurl,Listener<String>listener,ErrorListenererrorListener){
this(Method.GET,url,listener,errorListener);
}
@Override
protectedvoiddeliverResponse(Stringresponse){
mListener.onResponse(response);
}
@Override
protectedResponse<String>parseNetworkResponse(NetworkResponseresponse){
Stringparsed;
try{
parsed=newString(response.data,HttpHeaderParser.parseCharset(response.headers));
}catch(UnsupportedEncodingExceptione){
parsed=newString(response.data);
}
returnResponse.success(parsed,HttpHeaderParser.parseCacheHeaders(response));
}
}
可以看到，StringRequest的源码很简练，根本就没几行代码，我们一起来分析下。首先StringRequest是继承自Request类的，Request可以指定一个泛型类，这里指定的当然就是String了，接下来StringRequest中提供了两个有参的构造函数，参数包括请求类型，请求地址，以及响应回调等，由于我们已经很熟悉StringRequest的用法了，相信这几个参数的作用都不用再解释了吧。但需要注意的是，在构造函数中一定要调用super()方法将这几个参数传给父类，因为HTTP的请求和响应都是在父类中自动处理的。
另外，由于Request类中的deliverResponse()和parseNetworkResponse()是两个抽象方法，因此StringRequest中需要对这两个方法进行实现。deliverResponse()方法中的实现很简单，仅仅是调用了mListener中的onResponse()方法，并将response内容传入即可，这样就可以将服务器响应的数据进行回调了。parseNetworkResponse()方法中则应该对服务器响应的数据进行解析，其中数据是以字节的形式存放在NetworkResponse的data变量中的，这里将数据取出然后组装成一个String，并传入Response的success()方法中即可。
了解了StringRequest的实现原理，下面我们就可以动手来尝试实现一下XMLRequest了，代码如下所示：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
publicclassXMLRequestextendsRequest<XmlPullParser>{
privatefinalListener<XmlPullParser>mListener;
publicXMLRequest(intmethod,Stringurl,Listener<XmlPullParser>listener,
ErrorListenererrorListener){
super(method,url,errorListener);
mListener=listener;
}
publicXMLRequest(Stringurl,Listener<XmlPullParser>listener,ErrorListenererrorListener){
this(Method.GET,url,listener,errorListener);
}
@Override
protectedResponse<XmlPullParser>parseNetworkResponse(NetworkResponseresponse){
try{
StringxmlString=newString(response.data,
HttpHeaderParser.parseCharset(response.headers));
XmlPullParserFactoryfactory=XmlPullParserFactory.newInstance();
XmlPullParserxmlPullParser=factory.newPullParser();
xmlPullParser.setInput(newStringReader(xmlString));
returnResponse.success(xmlPullParser,HttpHeaderParser.parseCacheHeaders(response));
}catch(UnsupportedEncodingExceptione){
returnResponse.error(newParseError(e));
}catch(XmlPullParserExceptione){
returnResponse.error(newParseError(e));
}
}
@Override
protectedvoiddeliverResponse(XmlPullParserresponse){
mListener.onResponse(response);
}
}
可以看到，其实并没有什么太多的逻辑，基本都是仿照StringRequest写下来的，XMLRequest也是继承自Request类的，只不过这里指定的泛型类是XmlPullParser，说明我们准备使用Pull解析的方式来解析XML。在parseNetworkResponse()方法中，先是将服务器响应的数据解析成一个字符串，然后设置到XmlPullParser对象中，在deliverResponse()方法中则是将XmlPullParser对象进行回调。
好了，就是这么简单，下面我们尝试使用这个XMLRequest来请求一段XML格式的数据。http://flash.weather.com.cn/wmaps/xml/china.xml这个接口会将中国所有的省份数据以XML格式进行返回，如下所示：
[html]viewplaincopy在CODE上查看代码片派生到我的代码片
<chinadn="day"slick-uniqueid="3">
<cityquname="黑龙江"pyname="heilongjiang"cityname="哈尔滨"state1="0"state2="0"stateDetailed="晴"tem1="18"tem2="6"windState="西北风3-4级转西风小于3级"/>
<cityquname="吉林"pyname="jilin"cityname="长春"state1="0"state2="0"stateDetailed="晴"tem1="19"tem2="6"windState="西北风3-4级转小于3级"/>
<cityquname="辽宁"pyname="liaoning"cityname="沈阳"state1="0"state2="0"stateDetailed="晴"tem1="21"tem2="7"windState="东北风3-4级"/>
<cityquname="海南"pyname="hainan"cityname="海口"state1="1"state2="1"stateDetailed="多云"tem1="30"tem2="24"windState="微风"/>
<cityquname="内蒙古"pyname="neimenggu"cityname="呼和浩特"state1="0"state2="0"stateDetailed="晴"tem1="19"tem2="5"windState="东风3-4级"/>
<cityquname="新疆"pyname="xinjiang"cityname="乌鲁木齐"state1="0"state2="0"stateDetailed="晴"tem1="22"tem2="10"windState="微风转东南风小于3级"/>
<cityquname="西藏"pyname="xizang"cityname="拉萨"state1="1"state2="7"stateDetailed="多云转小雨"tem1="18"tem2="4"windState="微风"/>
<cityquname="青海"pyname="qinghai"cityname="西宁"state1="0"state2="1"stateDetailed="晴转多云"tem1="18"tem2="2"windState="微风"/>
<cityquname="宁夏"pyname="ningxia"cityname="银川"state1="0"state2="0"stateDetailed="晴"tem1="19"tem2="8"windState="微风"/>
<cityquname="甘肃"pyname="gansu"cityname="兰州"state1="0"state2="0"stateDetailed="晴"tem1="21"tem2="6"windState="微风"/>
<cityquname="河北"pyname="hebei"cityname="石家庄"state1="0"state2="0"stateDetailed="晴"tem1="25"tem2="12"windState="北风小于3级"/>
<cityquname="河南"pyname="henan"cityname="郑州"state1="0"state2="0"stateDetailed="晴"tem1="24"tem2="13"windState="微风"/>
<cityquname="湖北"pyname="hubei"cityname="武汉"state1="0"state2="0"stateDetailed="晴"tem1="24"tem2="12"windState="微风"/>
<cityquname="湖南"pyname="hunan"cityname="长沙"state1="2"state2="1"stateDetailed="阴转多云"tem1="20"tem2="15"windState="北风小于3级"/>
<cityquname="山东"pyname="shandong"cityname="济南"state1="1"state2="1"stateDetailed="多云"tem1="20"tem2="10"windState="北风3-4级转小于3级"/>
<cityquname="江苏"pyname="jiangsu"cityname="南京"state1="2"state2="2"stateDetailed="阴"tem1="19"tem2="13"windState="西北风4-5级转3-4级"/>
<cityquname="安徽"pyname="anhui"cityname="合肥"state1="2"state2="1"stateDetailed="阴转多云"tem1="20"tem2="12"windState="西北风转北风3-4级"/>
<cityquname="山西"pyname="shanxi"cityname="太原"state1="0"state2="0"stateDetailed="晴"tem1="22"tem2="8"windState="微风"/>
<cityquname="陕西"pyname="sanxi"cityname="西安"state1="1"state2="0"stateDetailed="多云转晴"tem1="21"tem2="9"windState="东北风小于3级"/>
<cityquname="四川"pyname="sichuan"cityname="成都"state1="1"state2="1"stateDetailed="多云"tem1="26"tem2="15"windState="南风小于3级"/>
<cityquname="云南"pyname="yunnan"cityname="昆明"state1="7"state2="7"stateDetailed="小雨"tem1="21"tem2="13"windState="微风"/>
<cityquname="贵州"pyname="guizhou"cityname="贵阳"state1="1"state2="3"stateDetailed="多云转阵雨"tem1="21"tem2="11"windState="东风小于3级"/>
<cityquname="浙江"pyname="zhejiang"cityname="杭州"state1="3"state2="1"stateDetailed="阵雨转多云"tem1="22"tem2="14"windState="微风"/>
<cityquname="福建"pyname="fujian"cityname="福州"state1="1"state2="2"stateDetailed="多云转阴"tem1="28"tem2="18"windState="微风"/>
<cityquname="江西"pyname="jiangxi"cityname="南昌"state1="2"state2="1"stateDetailed="阴转多云"tem1="23"tem2="15"windState="北风3-4级转微风"/>
<cityquname="广东"pyname="guangdong"cityname="广州"state1="3"state2="2"stateDetailed="阵雨转阴"tem1="26"tem2="20"windState="微风"/>
<cityquname="广西"pyname="guangxi"cityname="南宁"state1="3"state2="3"stateDetailed="阵雨"tem1="23"tem2="19"windState="东北风小于3级"/>
<cityquname="北京"pyname="beijing"cityname="北京"state1="0"state2="0"stateDetailed="晴"tem1="26"tem2="10"windState="微风"/>
<cityquname="天津"pyname="tianjin"cityname="天津"state1="1"state2="0"stateDetailed="多云转晴"tem1="22"tem2="13"windState="东北风3-4级转小于3级"/>
<cityquname="上海"pyname="shanghai"cityname="上海"state1="7"state2="1"stateDetailed="小雨转多云"tem1="20"tem2="16"windState="西北风3-4级"/>
<cityquname="重庆"pyname="chongqing"cityname="重庆"state1="1"state2="3"stateDetailed="多云转阵雨"tem1="21"tem2="14"windState="微风"/>
<cityquname="香港"pyname="xianggang"cityname="香港"state1="3"state2="1"stateDetailed="阵雨转多云"tem1="26"tem2="22"windState="微风"/>
<cityquname="澳门"pyname="aomen"cityname="澳门"state1="3"state2="1"stateDetailed="阵雨转多云"tem1="27"tem2="22"windState="东北风3-4级转微风"/>
<cityquname="台湾"pyname="taiwan"cityname="台北"state1="9"state2="7"stateDetailed="大雨转小雨"tem1="28"tem2="21"windState="微风"/>
<cityquname="西沙"pyname="xisha"cityname="西沙"state1="3"state2="3"stateDetailed="阵雨"tem1="30"tem2="26"windState="东北风4-5级"/>
<cityquname="南沙"pyname="nanshadao"cityname="南沙"state1="1"state2="1"stateDetailed="多云"tem1="32"tem2="27"windState="东风4-5级"/>
<cityquname="钓鱼岛"pyname="diaoyudao"cityname="钓鱼岛"state1="7"state2="1"stateDetailed="小雨转多云"tem1="23"tem2="19"windState="西南风3-4级转北风5-6级"/>
</china>
确定了访问接口后，我们只需要在代码中按照以下的方式来使用XMLRequest即可：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
XMLRequestxmlRequest=newXMLRequest(
"http://flash.weather.com.cn/wmaps/xml/china.xml",
newResponse.Listener<XmlPullParser>(){
@Override
publicvoidonResponse(XmlPullParserresponse){
try{
inteventType=response.getEventType();
while(eventType!=XmlPullParser.END_DOCUMENT){
switch(eventType){
caseXmlPullParser.START_TAG:
StringnodeName=response.getName();
if("city".equals(nodeName)){
StringpName=response.getAttributeValue(0);
Log.d("TAG","pNameis"+pName);
}
break;
}
eventType=response.next();
}
}catch(XmlPullParserExceptione){
e.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}
}
},newResponse.ErrorListener(){
@Override
publicvoidonErrorResponse(VolleyErrorerror){
Log.e("TAG",error.getMessage(),error);
}
});
mQueue.add(xmlRequest);
可以看到，这里XMLRequest的用法和StringRequest几乎是一模一样的，我们先创建出一个XMLRequest的实例，并把服务器接口地址传入，然后在onResponse()方法中解析响应的XML数据，并把每个省的名字打印出来，最后将这个XMLRequest添加到RequestQueue当中。
现在运行一下代码，观察控制台日志，就可以看到每个省的名字都从XML中解析出来了，如下图所示。
2.自定义GsonRequest
JsonRequest的数据解析是利用Android本身自带的JSONObject和JSONArray来实现的，配合使用JSONObject和JSONArray就可以解析出任意格式的JSON数据。不过也许你会觉得使用JSONObject还是太麻烦了，还有很多方法可以让JSON数据解析变得更加简单，比如说GSON。遗憾的是，Volley中默认并不支持使用自家的GSON来解析数据，不过没有关系，通过上面的学习，相信你已经知道了自定义一个Request是多么的简单，那么下面我们就来举一反三一下，自定义一个GsonRequest。
首先我们需要把gson的jar包添加到项目当中，jar包的下载地址是：https://code.google.com/p/google-gson/downloads/list。
接着定义一个GsonRequest继承自Request，代码如下所示：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
publicclassGsonRequest<T>extendsRequest<T>{
privatefinalListener<T>mListener;
privateGsonmGson;
privateClass<T>mClass;
publicGsonRequest(intmethod,Stringurl,Class<T>clazz,Listener<T>listener,
ErrorListenererrorListener){
super(method,url,errorListener);
mGson=newGson();
mClass=clazz;
mListener=listener;
}
publicGsonRequest(Stringurl,Class<T>clazz,Listener<T>listener,
ErrorListenererrorListener){
this(Method.GET,url,clazz,listener,errorListener);
}
@Override
protectedResponse<T>parseNetworkResponse(NetworkResponseresponse){
try{
StringjsonString=newString(response.data,
HttpHeaderParser.parseCharset(response.headers));
returnResponse.success(mGson.fromJson(jsonString,mClass),
HttpHeaderParser.parseCacheHeaders(response));
}catch(UnsupportedEncodingExceptione){
returnResponse.error(newParseError(e));
}
}
@Override
protectedvoiddeliverResponse(Tresponse){
mListener.onResponse(response);
}
}
可以看到，GsonRequest是继承自Request类的，并且同样提供了两个构造函数。在parseNetworkResponse()方法中，先是将服务器响应的数据解析出来，然后通过调用Gson的fromJson方法将数据组装成对象。在deliverResponse方法中仍然是将最终的数据进行回调。
那么下面我们就来测试一下这个GsonRequest能不能够正常工作吧，调用http://www.weather.com.cn/data/sk/101010100.html这个接口可以得到一段JSON格式的天气数据，如下所示：
[plain]viewplaincopy在CODE上查看代码片派生到我的代码片
{"weatherinfo":{"city":"北京","cityid":"101010100","temp":"19","WD":"南风","WS":"2级","SD":"43%","WSE":"2","time":"19:45","isRadar":"1","Radar":"JC_RADAR_AZ9010_JB"}}
接下来我们使用对象的方式将这段JSON字符串表示出来。新建一个Weather类，代码如下所示：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
publicclassWeather{
privateWeatherInfoweatherinfo;
publicWeatherInfogetWeatherinfo(){
returnweatherinfo;
}
publicvoidsetWeatherinfo(WeatherInfoweatherinfo){
this.weatherinfo=weatherinfo;
}
}
Weather类中只是引用了WeatherInfo这个类。接着新建WeatherInfo类，代码如下所示：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
publicclassWeatherInfo{
privateStringcity;
privateStringtemp;
privateStringtime;
publicStringgetCity(){
returncity;
}
publicvoidsetCity(Stringcity){
this.city=city;
}
publicStringgetTemp(){
returntemp;
}
publicvoidsetTemp(Stringtemp){
this.temp=temp;
}
publicStringgetTime(){
returntime;
}
publicvoidsetTime(Stringtime){
this.time=time;
}
}
WeatherInfo类中含有city、temp、time这几个字段。下面就是如何调用GsonRequest了，其实也很简单，代码如下所示：
[java]viewplaincopy在CODE上查看代码片派生到我的代码片
GsonRequest<Weather>gsonRequest=newGsonRequest<Weather>(
"http://www.weather.com.cn/data/sk/101010100.html",Weather.class,
newResponse.Listener<Weather>(){
@Override
publicvoidonResponse(Weatherweather){
WeatherInfoweatherInfo=weather.getWeatherinfo();
Log.d("TAG","cityis"+weatherInfo.getCity());
Log.d("TAG","tempis"+weatherInfo.getTemp());
Log.d("TAG","timeis"+weatherInfo.getTime());
}
},newResponse.ErrorListener(){
@Override
publicvoidonErrorResponse(VolleyErrorerror){
Log.e("TAG",error.getMessage(),error);
}
});
mQueue.add(gsonRequest);
可以看到，这里onResponse()方法的回调中直接返回了一个Weather对象，我们通过它就可以得到WeatherInfo对象，接着就能从中取出JSON中的相关数据了。现在运行一下代码，观察控制台日志，打印数据如下图所示：
这样的话，XMLRequest和GsonRequest的功能就基本都实现了，我们也是借助这两个例子深刻地理解了自定义Request的方法，对Volley的认识也是更加深入了。好了，本篇文章就到此结束，下篇文章中我们将对Volley进行更深层次的研究。