查看: 794|回复: 0

[Android教程] volley框架下发送和读取cookie

发表于 2018-1-30 08:00:01

摘要: 首先volley本身不支持cookie,但是volley又非常好用(比如封装了网络请求的实现,内部支持并发,不用我们再额外设计网络管理异步处理,网络请求不应在UI线程等等),那既想使用volley又想在对服务器发起http请求时加上cookie,并从服务器给的响应中读取cookie。怎么办呢?庆幸的是volley是开源的,我们可以重写一些方法来实现我们的目标。
本文为原创,转载请注明出处,否则将依法追究版权

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

  1. volley学习资料:
  2. Android 网络通信框架Volley简介(Google IO 2013)
  3. Android Volley完全解析(一),初识Volley的基本用法
  4. Android Volley完全解析(二),使用Volley加载网络图片
  5. Android Volley完全解析(三),定制自己的Request
  6. Android Volley完全解析(四),带你从源码的角度理解Volley
  7. 什么是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。

  1. import android.util.Log;
  2. import com.android.volley.AuthFailureError;
  3. import com.android.volley.NetworkResponse;
  4. import com.android.volley.ParseError;
  5. import com.android.volley.Request;
  6. import com.android.volley.Response;
  7. import com.android.volley.toolbox.HttpHeaderParser;
  8. import org.apache.http.cookie.Cookie;
  9. import org.json.JSONException;
  10. import org.json.JSONObject;
  11. import java.io.UnsupportedEncodingException;
  12. import java.util.HashMap;
  13. import java.util.Map;
  14. import java.util.regex.Matcher;
  15. import java.util.regex.Pattern;
  16. import info.doufm.android.utils.ShareUtil;
  17. /**
  18. * Created by Sicong on 2014/12/18.
  19. */
  20. public class JsonObjectPostRequest extends Request<JSONObject> {
  21. private Map<String, String> mMap;
  22. private Response.Listener<JSONObject> mListener;
  23. public String cookieFromResponse;
  24. private String mHeader;
  25. private Map<String, String> sendHeader=new HashMap<String, String>(1);
  26. public JsonObjectPostRequest(String url, Response.Listener<JSONObject> listener, Response.ErrorListener errorListener, Map map) {
  27. super(Request.Method.POST, url, errorListener);
  28. mListener = listener;
  29. mMap = map;
  30. }
  31. //当http请求是post时,则需要该使用该函数设置往里面添加的键值对
  32. @Override
  33. protected Map<String, String> getParams() throws AuthFailureError {
  34. return mMap;
  35. }
  36. @Override
  37. protected Response<JSONObject> parseNetworkResponse(NetworkResponse response) {
  38. try {
  39. String jsonString =
  40. new String(response.data, HttpHeaderParser.parseCharset(response.headers));
  41. mHeader = response.headers.toString();
  42. Log.w("LOG","get headers in parseNetworkResponse "+response.headers.toString());
  43. //使用正则表达式从reponse的头中提取cookie内容的子串
  44. Pattern pattern=Pattern.compile("Set-Cookie.*?;");
  45. Matcher m=pattern.matcher(mHeader);
  46. if(m.find()){
  47. cookieFromResponse =m.group();
  48. Log.w("LOG","cookie from server "+ cookieFromResponse);
  49. }
  50. //去掉cookie末尾的分号
  51. cookieFromResponse = cookieFromResponse.substring(11,cookieFromResponse.length()-1);
  52. Log.w("LOG","cookie substring "+ cookieFromResponse);
  53. //将cookie字符串添加到jsonObject中,该jsonObject会被deliverResponse递交,调用请求时则能在onResponse中得到
  54. JSONObject jsonObject = new JSONObject(jsonString);
  55. jsonObject.put("Cookie",cookieFromResponse);
  56. Log.w("LOG","jsonObject "+ jsonObject.toString());
  57. return Response.success(jsonObject,
  58. HttpHeaderParser.parseCacheHeaders(response));
  59. } catch (UnsupportedEncodingException e) {
  60. return Response.error(new ParseError(e));
  61. } catch (JSONException je) {
  62. return Response.error(new ParseError(je));
  63. }
  64. }
  65. @Override
  66. protected void deliverResponse(JSONObject response) {
  67. mListener.onResponse(response);
  68. }
  69. @Override
  70. public Map<String, String> getHeaders() throws AuthFailureError {
  71. return sendHeader;
  72. }
  73. public void setSendCookie(String cookie){
  74. sendHeader.put("Cookie",cookie);
  75. }
  76. }
复制代码

解释:由于所有的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附加到请求的头中,代码如下所示:

  1. String userName = etUserName.getText().toString().trim();
  2. String userPassword = etUserPassword.getText().toString().trim();
  3. originPassword = userPassword;
  4. mUserName = userName;
  5. //生成MD5
  6. userPassword = UserUtil.toLowerCaseMD5(userPassword);
  7. //转成成UTF-8
  8. try {
  9. userName = URLEncoder.encode(userName, "UTF-8");
  10. userPassword = URLEncoder.encode(userPassword, "UTF-8");
  11. } catch (UnsupportedEncodingException e) {
  12. e.printStackTrace();
  13. }
  14. HashMap<String, String> mMap = new HashMap<String, String>();
  15. mMap.put("user_name", userName);
  16. mMap.put("password", userPassword);
  17. //发起请求
  18. JsonObjectPostRequest jsonObjectPostRequest = new JsonObjectPostRequest(Constants.LOGIN_URL, new Response.Listener<JSONObject>() {
  19. @Override
  20. public void onResponse(JSONObject jsonObject) {
  21. //从服务器响应response中的jsonObject中取出cookie的值,存到本地sharePreference
  22. try {
  23. shareUtil.setLocalCookie(jsonObject.getString("Cookie"));
  24. shareUtil.apply();
  25. } catch (JSONException e) {
  26. e.printStackTrace();
  27. }
  28. try {
  29. if (jsonObject.get("status").equals("success")) {
  30. //登录成功
  31. }
  32. } catch (JSONException e) {
  33. e.printStackTrace();
  34. }
  35. }
  36. }, new Response.ErrorListener() {
  37. @Override
  38. public void onErrorResponse(VolleyError volleyError) {
  39. Toast.makeText(LoginActivity.this, "网络错误,登录失败!", Toast.LENGTH_SHORT).show();
  40. }
  41. }, mMap);
  42. String localCookieStr = shareUtil.getLocalCookie();
  43. if(!localCookieStr.equals("")){
  44. jsonObjectPostRequest.setSendCookie(localCookieStr);//向服务器发起post请求时加上cookie字段
  45. }
  46. RequestManager.getRequestQueue().add(jsonObjectPostRequest);
  47. }
复制代码


回复

使用道具 举报