volley学习笔记（六）：volley框架下发送和读取cookie

首先volley本身不支持cookie，但是volley又非常好用（比如封装了网络请求的实现，内部支持并发，不用我们再额外设计网络管理异步处理，网络请求不应在UI线程等等），那既想使用volley又想在对服务器发起http请求时加上cookie，并从服务器给的响应中读取cookie。怎么办呢？庆幸的是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);
        }


原文：http://my.oschina.net/liusicong/blog/361853