使用Volley获取多个cookie

问题描述

最近接手了一个论坛性质的应用，因为流量小，网络请求频繁，所以选择使用Volley进行重构。因为默认Volley只是读取一个cookie，而这个项目使用了4个cookie，所以用户登录部分先使用原来的HttpClient来保存用户的登录cookie信息。
重构获取和发送内容部分重构基本能够顺利完成，只剩下cookie这个难题，网上找了很多资料，发现很多都是片面一讲，其实说的不对。

网上找到的方法（不能解决问题）

有时服务器会返回多个 Set-Cookie 值，而Volley默认只取第一个，如果有需求，就要自己修改Volley的代码啦，HurlStack（sdk_int>9会走这里)里面的performRequest，默认解析header方式如下，多个值的话只需要拿到header.getValue().get(1)等等，具体需求可以自行修改。

Header h = new BasicHeader(header.getKey(), header.getValue().get(0));
response.addHeader(h);

上面是网上搜到的方法，其实只是说了第一步，后面还有需要注意的地方。但是解决问题的思路是对的：
1. 重写或者是继承一个HurlStack，在方法performRequest（）中把cookie添加到response。
2. 定义一个model包含请求返回的内容和cookie list。
3. 重写一个返回对象是上面我们model的request，在request的parseNetworkResponse方法中，把获取到的cookie放到model里面。
这里需要额外注意一点，也是上面方法没有说明的一点：
在我们的HurlStack中performRequest返回的是一个HttpResponse(header是一个list)，我们的cookie也是添加到了它的headers里面。到目前还没有问题。但是此处返回的response还要经过一个转化，因为Request类的protected abstract Response<T> parseNetworkResponse(NetworkResponse paramNetworkResponse);参数为一个NetworkResponse，这个的headers是一个Map<String, String>，所以这就要求我们的多个cookie的key不能都为Set-Cookie。因为上面的代码中cookie的header.getKey()一般是Set-Cookie。
下面是部分源码：

HurlStack.class

  public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders)
    throws IOException, AuthFailureError
  {

    ...
    BasicHttpResponse response = new BasicHttpResponse(responseStatus);
    response.setEntity(entityFromConnection(connection));
    for (Map.Entry<String, List<String>> header : connection.getHeaderFields().entrySet()) {
      if (header.getKey() != null)
      {
        Header h = new BasicHeader((String)header.getKey(), (String)((List)header.getValue()).get(0));
        response.addHeader(h);
      }
    }
    return response;
  }

BasicNetwork.class

  private static Map<String, String> convertHeaders(Header[] headers)
  {
    Map<String, String> result = new HashMap();
    for (int i = 0; i < headers.length; i++) {
      result.put(headers[i].getName(), headers[i].getValue());
    }
    return result;
  }

我的解决办法

关键代码：
MyHurlStack.class

public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders)
      throws IOException, AuthFailureError {
    String url = request.getUrl();
    HashMap map = new HashMap();
    map.putAll(request.getHeaders());
    map.putAll(additionalHeaders);
    if (this.mUrlRewriter != null) {
      String parsedUrl = this.mUrlRewriter.rewriteUrl(url);
      if (parsedUrl == null) {
        throw new IOException("URL blocked by rewriter: " + url);
      }

      url = parsedUrl;
    }

    URL parsedUrl1 = new URL(url);
    HttpURLConnection connection = this.openConnection(parsedUrl1, request);
    Iterator responseCode = map.keySet().iterator();

    while (responseCode.hasNext()) {
      String protocolVersion = (String) responseCode.next();
      connection.addRequestProperty(protocolVersion, (String) map.get(protocolVersion));
    }

    setConnectionParametersForRequest(connection, request);
    ProtocolVersion protocolVersion1 = new ProtocolVersion("HTTP", 1, 1);
    int responseCode1 = connection.getResponseCode();
    if (responseCode1 == -1) {
      throw new IOException("Could not retrieve response code from HttpUrlConnection.");
    } else {
      BasicStatusLine responseStatus =
          new BasicStatusLine(protocolVersion1, connection.getResponseCode(),
              connection.getResponseMessage());
      BasicHttpResponse response = new BasicHttpResponse(responseStatus);
      response.setEntity(entityFromConnection(connection));

      for (Object o : connection.getHeaderFields().entrySet()) {
        Entry header = (Entry) o;
        if (header.getKey() != null) {
        // 如果是cookie则保存为name = Set-Cookie + 序号，保证key不同
          if (header.getKey().equals("Set-Cookie")) {
            List headerList = (List) header.getValue();
            for (int i = 0; i < headerList.size(); i++) {
              BasicHeader h =
                  new BasicHeader((String) header.getKey() + i, (String) headerList.get(i));
              response.addHeader(h);
            }
          } else {
            List headerList = (List) header.getValue();
            for (Object aHeaderList : headerList) {
              BasicHeader h = new BasicHeader((String) header.getKey(), (String) aHeaderList);
              response.addHeader(h);
            }
          }
        }
      }

      return response;
    }
  }

MyRequest.class

  //使用正则表达式从reponse的头中提取cookie内容的子串
  private static final Pattern pattern = Pattern.compile("Set-Cookie\\d*");


  @Override
  protected Response<MyResponse> parseNetworkResponse(NetworkResponse networkResponse) {
    try {
      MyResponse response = new MyResponse();
      String jsonString =
          new String(networkResponse.data, HttpHeaderParser.parseCharset(networkResponse.headers));

      response.setJsonString(jsonString);
      // get all cookie
      List<Cookie> cookies = new ArrayList<>();
      for (String key : networkResponse.headers.keySet()) {
        Matcher matcher = pattern.matcher(key);
        if (matcher.find()) {
          cookieFromResponse = networkResponse.headers.get(key);
          cookieFromResponse = cookieFromResponse.substring(0, cookieFromResponse.indexOf(";"));
          String keyValue[] = cookieFromResponse.split("=", -1);
          Cookie cookie = new BasicClientCookie(keyValue[0], keyValue[1]);
          cookies.add(cookie);
        }
      }

      response.setCookies(cookies);

      return Response.success(response, HttpHeaderParser.parseCacheHeaders(networkResponse));
    } catch (UnsupportedEncodingException e) {
      return Response.error(new ParseError(e));
    }
  }

MyResponse.class

public class MyResponse{

  private static String TAG = "MyResponse";

  private int status = 0;

  private String jsonString = "";

  private List<Cookie> cookies = new ArrayList<>();

  public int getStatus() {
    return status;
  }

  public void setStatus(int status) {
    this.status = status;
  }

  public String getJsonString() {
    return jsonString;
  }

  public void setJsonString(String jsonString) {
    this.jsonString = jsonString;
  }

  public List<Cookie> getCookies() {
    return cookies;
  }

  public void setCookies(List<Cookie> cookies) {
    this.cookies = cookies;
  }
}

VolleyHelper.class

 public static void init(Context context) {
    queue = Volley.newRequestQueue(context, new MyHurlStack());
  }

后记

当初按照网上的方法只是改了HurlStack里面的部分内容，最后只能得到一个cookie，这里一般都会想到是不是Map的原因。最后查找源码发现真的是这个原因，然后使用了一个笨方法来解决了问题。所以根据源码来分析解决问题还是很需要的。
这个方法只是根据我们目前的情况解决了问题，应该是不能解决所有的情况，这里只是提供一个解决的思路，如果你有更好的解决方法，请留言，一起讨论一下。