Android 控件WebView设置Cookie

WebViewCookie

引言:网页需要设置登录状态等情形。开发使用过程中自我经验简单记录。

时间:2017年03月13日20:53:12

作者:JustDo23

01. 设置方式

同步的问题很常见,网上搜到的解决方法基本类似。

  /**
   * 给WebView同步Cookie
   *
   * @param context 上下文
   * @param url     可以使用[domain][host]
   */
  private void syncCookie(Context context, String url) {
    CookieSyncManager.createInstance(context);
    CookieManager cookieManager = CookieManager.getInstance();
    cookieManager.setAcceptCookie(true);
    cookieManager.removeSessionCookie();// 移除旧的[可以省略]
    List<HttpCookie> cookies = new PersistentCookieStore(context).getCookies();// 获取Cookie[可以是其他的方式获取]
    for (int i = 0; i < cookies.size(); i++) {
      HttpCookie cookie = cookies.get(i);
      String value = cookie.getName() + "=" + cookie.getValue();
      cookieManager.setCookie(url, value);
    }
    CookieSyncManager.getInstance().sync();// To get instant sync instead of waiting for the timer to trigger, the host can call this.
  }

这里简单说明:

  • 参数中的 URL 在使用过程中基本是域名。例如 https://www.baidu.com/ 就可以使 www.baidu.com
  • Cookie 列表的获取根据自己项目的存储方式不同而不同。例如使用 SharedPreferencesHashMap
  • 注意使用 for 循环 进行 setCookie(String url, String value) 调用。网上有博客表示使用分号手动拼接的 value 值会导致 Cookie 不能完整设置或者无效
  • 注意 value 的值是使用 key=value 的完整形式。文档提示 the cookie as a string, using the format of the 'Set-Cookie' HTTP response header
  • CookieSyncManager 是个过时的类,Api21 中 WebView 可以自动同步。
  • CookieSyncManager.getInstance().sync(); 方法的替代方法是 cookieManager.flush();
  • Cookie 同步方法要在 WebView 的 setting 设置完之后调用,否则无效。
  • 调用 loadUrl(url); 前一句调用此方法进行 Cookie 同步操作。
/**
 * 获取URL的域名
 */
private String getDomain(String url){
  url = url.replace("http://", "").replace("https://", "");
  if (url.contains("/")) {
    url = url.substring(0, url.indexOf('/'));
  }
  return url;
}

02. 保存Cookie

在这里记录一下使用 SharedPreferences 保存整个 Cookie 串并使用 HashMap 存储键值对

/**
 * 获取本地存储的 Cookie 集合
 *
 * @return Cookie 键值对
 */
public Map<String, String> getCookieMap() {
    Map<String, String> cookieMap = new HashMap<>();
    String cookie = getCookie();// 从SharedPreferences中获取整个Cookie串
    if (!TextUtils.isEmpty(cookie)) {
        String[] cookieArray = cookie.split(";");// 多个Cookie是使用分号分隔的
        for (int i = 0; i < cookieArray.length; i++) {
            int position = cookieArray[i].indexOf("=");// 在Cookie中键值使用等号分隔
            String cookieName = cookieArray[i].substring(0, position);// 获取键
            String cookieValue = cookieArray[i].substring(position + 1);// 获取值
            cookieMap.put(cookieName, NetCodeUtil.encodeURL(cookieValue));// 存至Map
            // 解码使用 URLEncoder.encode(str, "UTF-8");
        }
    }
    return cookieMap;
}

注意:编解码,从请求头中获取到的 Cookie 是经过 URL 编码 的,解码后可以获取到姓名之类中文,在给 WebView 或者是其他请求设置 Cookie 的时候需要进行编码

CookieUtil cookieUtil = new CookieUtil(this);// 将 Cookie 保存在了 SharedPreferences
Map<String, String> cookieMap = cookieUtil.getCookieMap();// 获取键值对
for (Map.Entry<String, String> entry : cookieMap.entrySet()) {// 遍历 Map
    String value = entry.getKey() + "=" + entry.getValue();// 键值对拼接成 value
    cookieManager.setCookie(url, value);// 设置 Cookie
}

03. 域名不同

使用 WebView 加载 A接口 获取到展示的界面,界面需要填充的数据会自动请求 B接口。这两接口域名不相同,之前服务器升级的时候搞了一个新的域名。抓包发现 AB两个接口 域名不同 A为旧 B为新

  • 尝试对两个域名设置 Cookie 测试发现不没有效果
  • 尝试将两个接口的域名设置为相同的测试发现两个接口都携带了 Cookie

进行了一番搜索之后,发现有在强调,只有cookie的domain和path与请求的URL匹配才会发送这个cookie

/**
 * Sets a cookie for the given URL. Any existing cookie with the same host,
 * path and name will be replaced with the new cookie. The cookie being set
 * will be ignored if it is expired.
 *
 * @param url the URL for which the cookie is to be set
 * @param value the cookie as a string, using the format of the 'Set-Cookie'
 *              HTTP response header
 */
public abstract void setCookie(String url, String value);

注释中写到,具有相同的 hostpathname 的任何现有的 Cookie 将会被替换为新的 Cookie。

04. Cookie保存位置

项目中使用 WebView 其实会自动将 Cookie 保存在本地数据库中。保存是路径为 data/data/package_name/app_WebView/Cookies 虽然不是 .db 结尾的,实际就是一个 .db 文件

参考文档

  1. 安卓学习笔记---AndroidWebview里设置Cookie遇到的坑

升级

引言:实际使用中遇到问题并进行更新。

时间:2018年04月19日21:03:12

作者:JustDo23

01. 针对一级域名

  • 不用对每个具体的 Url 进行设置 Cookie
  • 针对项目使用的一级域名进行设置 Cookie
  • 选择合适的时机进行刷新
public void synCookies(Context context) {
  if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
    CookieSyncManager.createInstance(context);
  }
  CookieManager cookieManager = CookieManager.getInstance();
  cookieManager.setAcceptCookie(true);// 允许接受 Cookie
  if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
    cookieManager.removeSessionCookie();// 移除
  } else {
    cookieManager.removeSessionCookies(null);// 移除
  }
  List<HttpCookie> cookies = UserModle.getInstance(this).getCookies();
  for (int i = 0; i < cookies.size(); i++) {
    HttpCookie cookie = cookies.get(i);
    String value = cookie.getName() + "=" + cookie.getValue();
    cookieManager.setCookie(".baidu.com", value);
  }
  cookieManager.setCookie(".baidu.com", "Domain=.baidu.com");
  cookieManager.setCookie(".baidu.com", "Path=/");
  if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
    CookieSyncManager.getInstance().sync();
  } else {
    cookieManager.flush();
  }
}

02. UserAgent

  • 每次设置 UserAgent 会导致 WebView 重新加载
  • 根据需要进行设置
  • 注意各个添加分号
String original = webView.getSettings().getUserAgentString();// 获取 WebView 的 UserAgent
original += " Version:" + versionName + ";";// 替换
webView.getSettings().setUserAgentString(original);// 设置新的 UserAgent

03. 参考

  1. 选择性参考
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,050评论 18 139
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 41,986评论 11 349
  • 将cookie同步到WebView(推荐)参考:文/CrazyCodeBoy(简书作者) android WebV...
    蒸汽飞船阅读 23,211评论 7 28
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,471评论 25 707
  • 大家好,今天又是云舅不定期冒泡时间。 几天不见,你们是不是又在想我? 老实说,最近舅有些苦恼。 放眼望去,烂片太多...
    Sir电影阅读 1,154评论 0 21