Android WebView设置Cookie

场景

最近公司项目需求，要求H5可以直接通过cookie得到相关信息

• 业务场景1：

  网页登录：记录用户登录信息，下次进去不需要重复登录

• 业务场景2：

  获取相关参数信息，比如：app版本号等信息

HTTP Cookie管理机制

实现Cookie参数注入，先来了解一下相关的配置

1、domain(host)

表示cookie所在的域，默认为请求地址

例如：www.zyb.com/test/index.php

domian默认为： www.zyb.com

这里还有跨域问题： 域A: test1.zyb.com 域B: test2.zyb.com

那么在域A生产一个可以使域A和域B都能访问的Cookie，就需要将Cookie的domain设置为.zyb.com；

如果要在域A生产一个令域A不能访问而域能访问的Cookie 就要将Cookie设置为test2.zyb.com。

2、path

表示cookie所在的目录,定义服务器上的路径,默认为/,即根目录。

同一服务器上的目录有/test/,/test/aa/,/test/bb/，现设一个cookie1的path为/test/，cookie2的path为/test/aa/，那么test下的所有页面都可以访问到cookie1，而/test/、/test/bb/的子页面不能访问cookie2，只有/test/aa/的子页面可以访问cookie2。

这是因为cookie只允许其path路径下的页面访问。

因此一般如果访问一级域名，只需要将path设置为根目录就可以。

3、Set-Cookie响应头格式

Set-Cookie: <name>=<value>[; <name>=<value>]...
   [; expires=<date>][; domain=<domain_name>]
   [; path=<some_path>][; secure][; httponly]

如果出现Cookie偶尔失效是什么原因呢？

只有cookie的domain和path与请求的URL匹配，这个cookie才是有效的。替换cookie时，要保证替换的Cookie具有相同的 host 、 path、name。

Cookie 默认保存位置

如果项目中使用WebView，自动将Cookie保存在本地数据库中。保存位置：data/data/package_name/app_WebView/Cookies.db

Cookie保存位置 cookie内容

如何设置

• 针对项目中 一级域名 设置cookie

/**
 * 同步cookie
 *
 * @param url 地址
 * @param cookieList 需要添加的Cookie值,以键值对的方式:key=value
 */
private void syncCookie (String url, ArrayList<String> cookieList) {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
        CookieSyncManager.createInstance(WIKApplication.getInstance().getApplicationContext());
    }
    CookieManager cookieManager = CookieManager.getInstance();
    cookieManager.setAcceptCookie(true);
    if (cookieList != null && cookieList.size() > 0) {
        for (String cookie : cookieList) {
                cookieManager.setCookie(url, cookie);
        }
    }
    cookieManager.setCookie(url, "Domain=.zyb.com");
    cookieManager.setCookie(url, "Path=/");
    String cookies = cookieManager.getCookie(url);
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP_MR1) {
        cookieManager.flush();
    } else {
        CookieSyncManager.getInstance().sync();
    }
}

这里的url指的是一级域名，比如：.zyb.com

• 自定义Cookie值

private void setAppInfoCookies () {
    ArrayList<String> cookieList = new ArrayList<>();
    cookieList.add("site=android");
    cookieList.add("wak_version=" + getAppVersion)；
    syncCookie(DOMAIN, cookieList);
}

• 相关参数说明

CookieSyncManager 是个过时的类，Api21 中 WebView 可以自动同步。

CookieSyncManager.getInstance().sync(); 方法的替代方法是 cookieManager.flush();

注意： 如果更新Cookie，只有host、name、path都相同时才会更新成功，否则只会在数据库中新添加。

Cookie的过期机制

可以设置Cookie的生效时间字段名为： expires 或 max-age。

expires：过期的时间点

max-age：生效的持续时间，单位为秒。

1. 若将Cookie的 max-age 设置为负数，或者 expires 字段设置为过期时间点，数据库更新后这条Cookie将从数据库中被删除。
2. 如果将Cookie的 max-age 和 expires 字段设置为正常的过期日期，则到期后再数据库更新时会删除该条数据。

JS获取Cookies

function getCookie(cookie_name) {
        //获取所有的cookie
        var allcookies = document.cookie;
        //索引长度，开始索引的位置
        var cookie_pos = allcookies.indexOf(cookie_name);

        // 如果找到了索引，就代表cookie存在,否则不存在
        if (cookie_pos != -1) {
            // 把cookie_pos放在值的开始，只要给值加1即可
            //计算取cookie值得开始索引，加的1为“=”
            cookie_pos = cookie_pos + cookie_name.length + 1; 
            //计算取cookie值得结束索引
            var cookie_end = allcookies.indexOf(";", cookie_pos);
            
            if (cookie_end == -1) {
                cookie_end = allcookies.length;
            }
            //得到想要的cookie的值
            var value = unescape(allcookies.substring(cookie_pos, cookie_end)); 
        }
        return value;
}

最后，希望此篇博客对大家有所帮助，欢迎提出问题及建议共同探讨，如有兴趣可以关注我的博客，谢谢！