修改源碼，使volley框架下支持發送和讀取cookie

本文爲原創，轉載請註明出處，不然將依法追究版權    

修改源碼，讓不支持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);
        }