文档章节

修改源码,使volley框架下支持发送和读取cookie

刘小米_思聪
 刘小米_思聪
发布于 2014/12/29 11:26
字数 1928
阅读 10284
收藏 1

本文为原创,转载请注明出处,否则将依法追究版权    

修改源码,让不支持cookie发送的volley框架支持cookie

我们平时开发android应用都需要用到网络技术,通常采用http协议来发起请求并接受网络数据。android系统提供两种方式进行http通信:HttpURLConnection和HttpClient。不过这两种方式稍复杂,如果不适当封装会导致许多重复代码。因此android网络通信框架应运而生,如AsynHttpClient(把Http所有的通信细节全封装在内,只需几行代码就可以完成通信),Universal_Image_loader(使界面上显示网络图片的操作变得极其简单,开发者不用关心如何从网络上获取图片,也不用关心开启线程,回收图片资源等细节,它已把一切都做好)。Google I/O大会上退出了新的网络通信架构volley,volley集HttpClient和HttpURLConnection优点于一身,Volley非常适合数据量不大,通信频繁的网络操作,但对于大数据量的网络操作比如下载文件,Volley表现糟糕。

    volley学习资料:

    Android 网络通信框架Volley简介(Google IO 2013)

    Android Volley完全解析(一),初识Volley的基本用法

    Android Volley完全解析(二),使用Volley加载网络图片

    Android Volley完全解析(三),定制自己的Request

    Android Volley完全解析(四),带你从源码的角度理解Volley

    什么是Cookie?

我们知道http是无连接的,不像tcp那样始终占有一个通道。为了破除http的这个局限,所以有了cookie和session。分别对应客户端和服务器端,以实现保持会话连接状态。常见的应用有购物车,用户自动登录。

以登录为例,客户端将含有用户填写的账号密码的表单post给服务器端,服务器判断其登录成功,则返回一个response,其中reponse的header中会包含"Cookie"字段。也就是说response的header是一长串字符串,客户端需要从中提取类似于 “set-cookie: …… ; ”的一段子串,并将它保存在本地,比如保存在String localCookie变量中,后续发送给服务器的所有请求中都需要将该键值对put在http请求的header中,注意key是固定的“Cookie", value就是之前保存的那个localCookie变量的值。

response的header示例图:

可以用正则表达式提取Set-Cookie:mBxa_……%09jax;子串。

我听过一个很有意思的比喻,http请求的头就像一辆公交车,每个座位就是Key,value对号入座。比如我们要放cookie字段在头里,就必需采用"Cookie"这个key,否则自己命名一个比如”mycookie“,那就只能坐地上了,这样服务器是就识别不了你这段话是干什么用的了。

直接贴代码

1)从服务器的response中获得cookie串。首先是自定义一个JsonObjectPostRequest。

import android.util.Log;

import com.android.volley.AuthFailureError;
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 org.apache.http.cookie.Cookie;
import org.json.JSONException;
import org.json.JSONObject;

import java.io.UnsupportedEncodingException;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import info.doufm.android.utils.ShareUtil;

/**
 * Created by Acker on 2014/12/18.
 */

public class JsonObjectPostRequest extends Request<JSONObject> {
    private Map<String, String> mMap;
    private Response.Listener<JSONObject> mListener;
    public String cookieFromResponse;
    private String mHeader;
    private Map<String, String> sendHeader=new HashMap<String, String>(1);
    public JsonObjectPostRequest(String url, Response.Listener<JSONObject> listener, Response.ErrorListener errorListener, Map map) {
        super(Request.Method.POST, url, errorListener);
        mListener = listener;
        mMap = map;
    }

    //当http请求是post时,则需要该使用该函数设置往里面添加的键值对
    @Override
    protected Map<String, String> getParams() throws AuthFailureError {
        return mMap;
    }
    @Override
    protected Response<JSONObject> parseNetworkResponse(NetworkResponse response) {
        try {
            String jsonString =
                    new String(response.data, HttpHeaderParser.parseCharset(response.headers));
            mHeader = response.headers.toString();
            Log.w("LOG","get headers in parseNetworkResponse "+response.headers.toString());
            //使用正则表达式从reponse的头中提取cookie内容的子串
            Pattern pattern=Pattern.compile("Set-Cookie.*?;");
            Matcher m=pattern.matcher(mHeader);
            if(m.find()){
                cookieFromResponse =m.group();
                Log.w("LOG","cookie from server "+ cookieFromResponse);
            }
            //去掉cookie末尾的分号
            cookieFromResponse = cookieFromResponse.substring(11,cookieFromResponse.length()-1);
            Log.w("LOG","cookie substring "+ cookieFromResponse);
            //将cookie字符串添加到jsonObject中,该jsonObject会被deliverResponse递交,调用请求时则能在onResponse中得到
            JSONObject jsonObject = new JSONObject(jsonString);
            jsonObject.put("Cookie",cookieFromResponse);
            Log.w("LOG","jsonObject "+ jsonObject.toString());
            return Response.success(jsonObject,
                    HttpHeaderParser.parseCacheHeaders(response));
        } catch (UnsupportedEncodingException e) {
            return Response.error(new ParseError(e));
        } catch (JSONException je) {
            return Response.error(new ParseError(je));
        }
    }

    @Override
    protected void deliverResponse(JSONObject response) {
        mListener.onResponse(response);
    }

    @Override
    public Map<String, String> getHeaders() throws AuthFailureError {
        return sendHeader;
    }
    public void setSendCookie(String cookie){
        sendHeader.put("Cookie",cookie);
    }
}

 

解释:由于所有的volley请求都是一级或多级继承(实现)自Requst抽象类,因此我们需要对volley Rqeust源码有一定的了解。因为发起请求,支持并发等都在volley的内部逻辑中实现了。我们想要做的事就需要重写这些提供给我们的方法了。当从网络中获取response的时候,怎么去解析对应的请求?这是由各个对应的Request去解决的。比如我们上面的自定义JsonObjectPostRequest,最后都要通过Response.success方法去返回一个Response对象,并且这个Response对象怎么使用则由deliverResponse方法决定。也就是说当我们调用一般的volley请求时(比如JsonRequest),呈现给我们可以使用的服务器响应就只有Response.Listener()中的onResposne(JsonObject response)方法中传入的参数response了,而这个response参数往往包含的是服务器返回的原始response经过JsonRequest定义类中的一系列加工之后的response,比如这里便只是服务器响应的 JsonObejct 对象了,是不含头的,那怎么办呢?怎么才能让我在调用的时候拿到服务器返回的头中的信息?方法是有的,我们需要在可以拿到原始response的地方,也就是parseNetworkResponse中做一些事:进一步拿到response的头(头是一个很长的字符串),我们需要从中找到cookie子串(可以采用正则表达式实现)。

那么问题来了,我们在Acticity中使用JsonObjectRequst的时候,怎么拿到这个辛辛苦苦拿到的cookie呢?分析volley的源码之后我发现:在创建JsonObjectRequest对象时,我们最终拿到的关于reponse的所有操作都是在onResponse(JSONObject  jsonObject){……}中进行的。那么解决方案就有了,在parseNetworkResponse中我自己新建一个cookie键值对,key随意写,你认识就行,值就是辛苦拿到的那个cookie值,再将该键值对也put到JsonObject里。那么这个JsonObject还是走原来的通道交给想使用它的地方,即通过parseNetworkResponse中的Response.success()将JsonObject 交给 deliverResponse()方法,最终在调用时就可以被Response.Listener()中的 onReposne( JsonObeject response) 拿到啦。

在Activity中发起请求时,可以获取服务器返回的cookie,保存到本地,还可以在发送时将cookie附加到请求的头中,代码如下所示:

       String userName = etUserName.getText().toString().trim();
       String userPassword = etUserPassword.getText().toString().trim();
       originPassword = userPassword;
       mUserName = userName;
       //生成MD5
       userPassword = UserUtil.toLowerCaseMD5(userPassword);
       //转成成UTF-8
       try {
            userName = URLEncoder.encode(userName, "UTF-8");
            userPassword = URLEncoder.encode(userPassword, "UTF-8");
       } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
       }
       HashMap<String, String> mMap = new HashMap<String, String>();
       mMap.put("user_name", userName);
       mMap.put("password", userPassword);
       
       //发起请求
       JsonObjectPostRequest jsonObjectPostRequest = new JsonObjectPostRequest(Constants.LOGIN_URL, new Response.Listener<JSONObject>() {
                @Override
                public void onResponse(JSONObject jsonObject) {
                    //从服务器响应response中的jsonObject中取出cookie的值,存到本地sharePreference
                    try {
                        shareUtil.setLocalCookie(jsonObject.getString("Cookie"));
                        shareUtil.apply();
                    } catch (JSONException e) {
                        e.printStackTrace();
                    }                   
                    try {
                        if (jsonObject.get("status").equals("success")) {
                            //登录成功                            
                        }
                    } catch (JSONException e) {
                        e.printStackTrace();
                    }
                }
            }, new Response.ErrorListener() {
                @Override
                public void onErrorResponse(VolleyError volleyError) {                    
                    Toast.makeText(LoginActivity.this, "网络错误,登录失败!", Toast.LENGTH_SHORT).show();
                }
            }, mMap);
            String localCookieStr = shareUtil.getLocalCookie();
            if(!localCookieStr.equals("")){
                jsonObjectPostRequest.setSendCookie(localCookieStr);//向服务器发起post请求时加上cookie字段
            }
            RequestManager.getRequestQueue().add(jsonObjectPostRequest);
        }

 

 

© 著作权归作者所有

刘小米_思聪
粉丝 58
博文 60
码字总数 43955
作品 0
西安
其他
私信 提问
加载中

评论(11)

风雨无阻01
hraders.put();将Cookie添加到header中的键是什么?根据什么来确定?
神奇海螺-

引用来自“liyinggang”的评论

可是你的那个shareUtil呢,麻烦楼主能提供下代码参考一下吗?这几天被这个cookie烦死了0
我不知道你的英语是怎么学的 share就是SharedPreferences Util就是工具,说简单点就是从SharedPreferences中获取一个存入的字符串
l
liyinggang
可是你的那个shareUtil呢,麻烦楼主能提供下代码参考一下吗?这几天被这个cookie烦死了0
刘备字玄德
刘备字玄德
楼主我把这个JsonObjectPostRequest复制了然后用的时候发现请求响应的不对呀应该是返回1的,你这个一直返回0, 应该是参数不对。 响应头里面也没有cookie。
刘备字玄德
刘备字玄德
0 支持
刘小米_思聪
刘小米_思聪 博主

引用来自“liz28”的评论

想问一下,parseNetworkResponse中的response和 继承Response.Listener<JSONObject> listener时覆盖的onresponse(response)是同一个值吗?
是的
l
liz28
想问一下,parseNetworkResponse中的response和 继承Response.Listener<JSONObject> listener时覆盖的onresponse(response)是同一个值吗?
l
liz28
想问一下,parseNetworkResponse中的response和 继承Response.Listener<JSONObject> listener时覆盖的onresponse(response)是同一个值吗?
l
liz28
想问一下,parseNetworkResponse中的response和 继承Response.Listener<JSONObject> listener时覆盖的onresponse(response)是同一个值吗?
刘小米_思聪
刘小米_思聪 博主
嗯,您觉得我哪里理解的不对吗,请您指教
volley 使用方法

1 Volley发送get请求: public void getJson() {String url = "http://"+host+":8080/web/json.jsp?username=xjs&password=123456";mQueue.add(new JsonObjectRequest(Method.GET, url, nul......

xiahuawuyu
2015/12/22
64
0
Android-网络通信框架Volley使用详解

1 Volley发送get请求: public void getJson() { String url = "http://"+host+":8080/web/json.jsp?username=xjs&password=123456"; mQueue.add(new JsonObjectRequest(Method.GET, url, n......

新年
2015/06/11
1K
0
android-async-http框架库使用基础

开源项目链接 android-async-http仓库:git clone https://github.com/loopj/android-async-http android-async-http主页:http://loopj.com/android-async-http/ 背景知识 开始使用分析前还......

xiahuawuyu
2015/12/22
97
0
Android 中判断网络连接和GPS是否可用及HTTPCLIENT使用

大家知道Google支持和发布的Android移动操作系统,主要是为了使其迅速占领移动互联网的市场份额,所谓移动互联网当然也是互联网了,凡是涉及互联网的任何软件任何程序都少不了联网模块的开发...

xztelecomlcs
2017/03/14
0
0
vollery框架支持https

通过前面的内容可以使大家对Volley有所了解。下面就开始讲支持HTTPS的实现。 其实Volley可以支持HTTPS,但是框架中默认没有加上去我们可以修改一小部分源码来实现这以功能。 volley的网络请求...

遇见sunshine
2016/01/22
145
0

没有更多内容

加载失败,请刷新页面

加载更多

计算机实现原理专题--二进制减法器(二)

在计算机实现原理专题--二进制减法器(一)中说明了基本原理,现准备说明如何来实现。 首先第一步255-b运算相当于对b进行按位取反,因此可将8个非门组成如下图的形式: 由于每次做减法时,我...

FAT_mt
昨天
6
0
好程序员大数据学习路线分享函数+map映射+元祖

好程序员大数据学习路线分享函数+map映射+元祖,大数据各个平台上的语言实现 hadoop 由java实现,2003年至今,三大块:数据处理,数据存储,数据计算 存储: hbase --> 数据成表 处理: hive --> 数...

好程序员官方
昨天
7
0
tabel 中含有复选框的列 数据理解

1、el-ui中实现某一列为复选框 实现多选非常简单: 手动添加一个el-table-column,设type属性为selction即可; 2、@selection-change事件:选项发生勾选状态变化时触发该事件 <el-table @sel...

everthing
昨天
6
0
【技术分享】TestFlight测试的流程文档

上架基本需求资料 1、苹果开发者账号(如还没账号先申请-苹果开发者账号申请教程) 2、开发好的APP 通过本篇教程,可以学习到ios证书申请和打包ipa上传到appstoreconnect.apple.com进行TestF...

qtb999
昨天
10
0
再见 Spring Boot 1.X,Spring Boot 2.X 走向舞台中心

2019年8月6日,Spring 官方在其博客宣布,Spring Boot 1.x 停止维护,Spring Boot 1.x 生命周期正式结束。 其实早在2018年7月30号,Spring 官方就已经在博客进行过预告,Spring Boot 1.X 将维...

Java技术剑
昨天
18
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部