Android Cookie处理
Android有两个CookieManager类,用以处理Cookie同步的问题,分别是:
android.webkit.CookieManager
java.net.CookieManager
1 java.net.CookieManager的使用
1.1 使用HttpURLConnection处理http请求
使用CookieManager默认的实现,在Application初始化的时候添加以下代码即可:
CookieHandler.setDefault(new CookieManager());
但是默认的实现往往不能满足需求,那就需要自己处理Cookie。
自己处理Cookie的时候需要继承CookieManager类并重写两个方法:
//发送http请求的时候 获取需要的请求头(head)信息
public Map<String, List<String>> get(URI uri, Map<String, List<String>> requestHeaders)
//获取的http响应头信息 用于提取所需要的Cookie信息
public void put(URI uri, Map<String, List<String>> responseHeaders)
例如下面是我在自己项目里处理Cookie的类,处理的原则是
- 如果http请求涉及多个域,则每个域只带自己的Cookie信息
- 如果同域多个请求返回不同的Cookie属性,则下次请求需要带上之前获取的所有同域的Cookie属性
- 忽略掉一些无用的属性
代码如下所示:
public class MyCookieManager extends CookieManager {
private HashMap<String, HashMap<String, String>> mCookieMap = new HashMap<>(3);
private static String[] COOKIE_SKIP_KEY = {"domain", "path", "expires", "max-age", "discard"};//请求头的Cookie里不需要的属性
public MyCookieManager() {
super(null, CookiePolicy.ACCEPT_ALL);
}
@Override
public Map<String, List<String>> get(URI uri, Map<String, List<String>> requestHeaders) throws IOException {
HashMap<String, List<String>> headMap = new HashMap<>();
headMap.putAll(requestHeaders);
headMap.put("Cookie", Arrays.asList(getCookieStr(uri)));
return headMap;
}
@Override
public void put(URI uri, Map<String, List<String>> responseHeaders) throws IOException {
List<String> setCookies = responseHeaders.get("Set-Cookie");
if (setCookies == null) {
return;
}
String host = uri.getHost();
HashMap<String, String> cookieMap = mCookieMap.get(host);
if (cookieMap == null) {
cookieMap = new HashMap<>(5);
}
for (String str : setCookies) {
String[] attrs = str.split(";");
for (String attr : attrs) {
if (attr.contains("=")) {
String[] kv = attr.split("=");
if (!isSkip(kv[0])) {
cookieMap.put(kv[0], kv[1]);
}
}
}
}
mCookieMap.put(host, cookieMap);
}
private boolean isSkip(String key) {
for (int i = 0; i < COOKIE_SKIP_KEY.length; i++) {
if (COOKIE_SKIP_KEY[i].equals(key.toLowerCase().trim())) {
return true;
}
}
return false;
}
public String getCookieStr(URI uri) {
String cookieStr = "";
HashMap<String, String> cookieMap = mCookieMap.get(uri.getHost());
if (cookieMap != null) {
Iterator<Map.Entry<String, String>> it = cookieMap.entrySet().iterator();
while (it.hasNext()) {
Map.Entry<String, String> entry = it.next();
cookieStr += entry.getKey() + "=" + entry.getValue() + ";";
}
}
return cookieStr;
}
然后在Application的onCreate里添加以下代码即可:
CookieHandler.setDefault(new MyCookieManager());
1.2 使用OkHttp处理Http请求
在一些http框架里,继承CookieManager处理Cookie的方式并不是总能生效。
当然成熟点的框架都会提供类似的接口方便开发者处理,android里最流行的框架OkHttp当然也提供了处理Cookie的方式。
在OkHttp2.x的版本里,可以用以下方式处理Cookie:
OkHttpClient client = new OkHttpClient();
client.setCookieHandler(new CookieManager());
在OkHttp3.x的版本里,摈弃了setCookieHandler()方法,取代的是cookieJar(CookieJar cookieJar)方法,并提供了CookieJar接口。
CookieJar的使用类似CookieMananger,同样提供两个方法:
//获取的http响应的Cookie信息
public void saveFromResponse(HttpUrl url, List<Cookie> cookies)
//发送http请求的时候 获取需要的Cookie信息
public List<Cookie> loadForRequest(HttpUrl url)
如果之前MyCookieManger的处理方式需要移植到OkHttp,则代码修改如下:
public class HttpCookieManager implements CookieJar {
private HashMap<String, HashMap<String, String>> mCookieMap = new HashMap<>(3);
private static String[] COOKIE_SKIP_KEY = {"domain", "path", "expires", "max-age", "discard"};
private HttpCookieManager() {}
private static HttpCookieManager instance = new HttpCookieManager();
public static HttpCookieManager getInstance() {
return instance;
}
@Override
public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
if (cookies == null) {
return;
}
String host = url.host();
HashMap<String, String> cookieMap = mCookieMap.get(host);
if (cookieMap == null) {
cookieMap = new HashMap<>(5);
}
for (Cookie cookie : cookies) {
String str = cookie.toString();
String[] attrs = str.split(";");
for (String attr : attrs) {
if (attr.contains("=")) {
String[] kv = attr.split("=");
if (!isSkip(kv[0])) {
cookieMap.put(kv[0], kv[1]);
}
}
}
}
mCookieMap.put(host, cookieMap);
}
@Override
public List<Cookie> loadForRequest(HttpUrl url) {
List<Cookie> list = new ArrayList<>(1);
list.add(new Cookie.Builder().name("Cookie").value(getCookieStr(url.uri())).domain(url.host()).build());
return Collections.emptyList();
}
private boolean isSkip(String key) {
for (int i = 0; i < COOKIE_SKIP_KEY.length; i++) {
if (COOKIE_SKIP_KEY[i].equals(key.toLowerCase().trim())) {
return true;
}
}
return false;
}
public String getCookieStr(URI uri) {
String cookieStr = "";
HashMap<String, String> cookieMap = mCookieMap.get(uri.getHost());
if (cookieMap != null) {
Iterator<Map.Entry<String, String>> it = cookieMap.entrySet().iterator();
while (it.hasNext()) {
Map.Entry<String, String> entry = it.next();
cookieStr += entry.getKey() + "=" + entry.getValue() + ";";
}
}
return cookieStr;
}
}
然后OkHttp的初始化如下所示:
private OkHttpClient client = new OkHttpClient();
client = client.newBuilder().cookieJar(HttpCookieManager.getInstance()).build();
一般情况下,在OkHttp3.x里这样处理就可以了,但是在有302跳转的时候,如果跳转后的请求也需要同样的Cookie处理规则,那么跳转后的请求是调不到CookieJar的loadForRequest方法的。
这时候就需要用到OkHttp的Interceptor,实现Interceptor接口如下:
class CookieInterceptor implements Interceptor {
@Override
public Response intercept(Interceptor.Chain chain) throws IOException {
Request request = chain.request();
//处理Cookie 这里处理主要是为302重定向的请求添加Cookie
String cookieStr = HttpCookieManager.getInstance().getCookieStr(request.url().uri());
request = request.newBuilder().addHeader("Cookie", cookieStr).build();
return chain.proceed(request);
}
}
屏蔽CookieJar里loadForRequest方法的处理:
public List<Cookie> loadForRequest(HttpUrl url) {
return Collections.emptyList();
}
OkHttp初始化如下:
client = client.newBuilder()
.addNetworkInterceptor(new CookieInterceptor())
.cookieJar(HttpCookieManager.getInstance()).build();
2 android.webkit.CookieManager的使用
CookieManager cookieManager = CookieManager.getInstance();
cookieManager.setAcceptCookie(accept);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
cookieManager.setAcceptThirdPartyCookies(webView, true);
}
MyCookieManager myCookieManager = (MyCookieManager) CookieHandler.getDefault();
//HttpCookieManager.getInstance().getCookieStr(request.url().uri());
cookieManager.setCookie(urlStr, myCookieManager.getCookieStr(new URI(url)));
CookieSyncManager.getInstance().sync();