Android app通过session cookie 记录登录状态 (OkHttp3.0 Client设置cookie拦截器 )

• 摘要：前言在实际开发中,我们经常会遇到这样的场景:app中打开某个H5页面时,H5经常需要知道你的sessioncookie来判断登录状态或者要求你告知sessioncookie。本文将给出个在实际开发中遇到的解决方案。喜欢探讨Android开发技术的同学可以加学习小组QQ群:193765960。版权归作者所有,如有转发,请注明文章出处:http://www.jianshu.com/u/d43d948bef391.什么是Session、Cookie摘录一段别人的话,给大家包括自己扫
• 
  

  前言
  在实际开发中,我们经常会遇到这样的场景:app中打开某个H5页面时,H5经常需要知道你的session cookie来判断登录状态或者要求你告知session cookie。本文将给出个在实际开发中遇到的解决方案。喜欢探讨Android开发技术的同学可以加学习小组QQ群: 193765960。

  
  

  
  

  版权归作者所有,如有转发,请注明文章出处:http://www.jianshu.com/u/d43d948bef39

  
  
  1. 什么是Session、Cookie
  

  摘录一段别人的话,给大家包括自己扫扫盲。

  
  

  
  

  作者:知乎用户
  链接:https://www.zhihu.com/question/19786827/answer/28752144
  来源:知乎
  着作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。*

由于HTTP协议是无状态的协议,所以服务端需要记录用户的状态时,就需要用某种机制来识具体的用户,这个机制就是Session.典型的场景比如购物车,当你点击下单按钮时,由于HTTP协议无状态,所以并不知道是哪个用户操作的,所以服务端要为特定的用户创建了特定的Session,用用于标识这个用户,并且跟踪用户,这样才知道购物车里面有几本书。这个Session是保存在服务端的,有一个唯一标识。在服务端保存Session的方法很多,内存、数据库、文件都有。集群的时候也要考虑Session的转移,在大型的网站,一般会有专门的Session服务器集群,用来保存用户会话,这个时候 Session 信息都是放在内存的,使用一些缓存服务比如Memcached之类的来放 Session。

思考一下服务端如何识别特定的客户?这个时候Cookie就登场了。每次HTTP请求的时候,客户端都会发送相应的Cookie信息到服务端。实际上大多数的应用都是用 Cookie 来实现Session跟踪的,第一次创建Session的时候,服务端会在HTTP协议中告诉客户端,需要在 Cookie 里面记录一个Session ID,以后每次请求把这个会话ID发送到服务器,我就知道你是谁了。有人问,如果客户端的浏览器禁用了 Cookie 怎么办?一般这种情况下,会使用一种叫做URL重写的技术来进行会话跟踪,即每次HTTP交互,URL后面都会被附加上一个诸如 sid=xxxxx 这样的参数,服务端据此来识别用户。
Cookie其实还可以用在一些方便用户的场景下,设想你某次登陆过一个网站,下次登录的时候不想再次输入账号了,怎么办?这个信息可以写到Cookie里面,访问网站的时候,网站页面的脚本可以读取这个信息,就自动帮你把用户名给填了,能够方便一下用户。这也是Cookie名称的由来,给用户的一点甜头。所以,总结一下:Session是在服务端保存的一个数据结构,用来跟踪用户的状态,这个数据可以保存在集群、数据库、文件中;Cookie是客户端保存用户信息的一种机制,用来记录用户的一些信息,也是实现Session的一种方式。

这个一时半会儿也说不好,另找了片文章给大家瞧瞧
cookie、session和token那些事

2. App 中如何使用session cookie
2.1 封装HTTP Client,统一保存和读取cookie
2.1.1 OkHttp3.0 Client设置cookie拦截器
// 设置OkHttpClient
OkHttpClient httpClient = new OkHttpClient.Builder()
.addInterceptor(logging)
.addInterceptor(proheaders)
**.addInterceptor(new ReadCookiesInterceptor())**
**.addInterceptor(new SaveCookiesInterceptor())**
.readTimeout(30, TimeUnit.SECONDS)
.sslSocketFactory(sslSocketFactory)
.hostnameVerifier(new HostnameVerifier() {
@Override
public boolean verify(String s, SSLSession sslSession) {
return true;
}
})
.connectTimeout(60, TimeUnit.SECONDS)
.build();

2.1.2 ReadCookiesInterceptor
public class ReadCookiesInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request.Builder builder = chain.request().newBuilder();
HashSet<String> preferences = (HashSet) PreferenceUtil.getPreferences().getStringSet(PreferenceUtil.PREF_COOKIES, new HashSet<String>());
for (String cookie : preferences) {
builder.addHeader("Cookie", cookie);
}
return chain.proceed(builder.build());
}
}

2.1.3 SaveCookiesInterceptor
public class SaveCookiesInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Response originalResponse = chain.proceed(chain.request());
if (!originalResponse.headers("Set-Cookie").isEmpty()) {
HashSet<String> cookies = new HashSet<>();
for (String header : originalResponse.headers("Set-Cookie")) {
cookies.add(header);
}
PreferenceUtil.getPreferences().edit()
.putStringSet(PreferenceUtil.PREF_COOKIES, cookies)
.apply();
}
return originalResponse;
}
}

需要注意的是这两行代码,用于本地化存储,按说cookie已经是本地化存储了,直接使用manager就可以获取,但是因为当时第一次做,采用了比较笨的方案:

PreferenceUtil.getPreferences().edit()
.putStringSet(PreferenceUtil.PREF_COOKIES, cookies)
.apply();

更正规的做法如下(点我参考):

CookieManager manager = new CookieManager();
CookieHandler.setDefault(manager);
//因为http已经做了请求,所以会得到cookie
CookieStore cookieJar = manager.getCookieStore();
List<HttpCookie> cookies = cookieJar.getCookies();

2.2 WebView中读取本地保存的cookie
url = "http://www.xxxxxx.com";
HashSet<String> preferences = (HashSet) PreferenceUtil.getPreferences().getStringSet(PreferenceUtil.PREF_COOKIES, new HashSet<String>());
for (String cookie : preferences) {
syncCookie(url, cookie);
}
mWebView.loadUrl(url);

/**
* 将cookie同步到WebView
*
* @param url WebView要加载的url
* @param cookie 要同步的cookie
* @return true 同步cookie成功,false同步cookie失败
*/
public boolean syncCookie(String url, String cookie) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
CookieSyncManager.createInstance(this);
}
CookieManager cookieManager = CookieManager.getInstance();
cookieManager.setCookie(url, cookie);//如果没有特殊需求,这里只需要将session id以"key=value"形式作为cookie即可
String newCookie = cookieManager.getCookie(url);
return TextUtils.isEmpty(newCookie) ? false : true;
}