Cookie管理 WebView同步

Posted 2020-11-04 安卓笔记侠

NoHttp的Cookie管理原理

在文档的初始化配置一章讲了NoHttp如何配置或者禁用cookie自动管理。

NoHttp的Cookie自动维护，严格遵守Http协议，即区分临时Cookie和有效期Cookie。

• 临时Cookie在本次App运行期内一直有效，直到App被杀死即被清除。
• 有效期Cookie会带有一个过期时间，不论App是否被杀死过，这个Cookie在到期时会被自动清除。

关于Session的维持登录

Session是对于服务端来说的，客户端是没有Session一说的。Session是服务器在和客户端建立连接时添加客户端连接标志，最终会在服务器软件（Apache、Tomcat、JBoss）转化为一个临时Cookie发送给给客户端，当客户端第一请求时服务器会检查是否携带了这个Session（临时Cookie），如果没有则会添加Session，如果有就拿出这个Session来做相关操作。

综上所述Session也就是客户端在一次运行期内一直有效，客户端被重启或者杀死时这个Session转化来的临时Cookie即被清除，下次客户端启动后请求服务器时会重新有一个新的Session。

有写开发者是用Session维持App端用户登录状态的，根据上述描述，App重启后上次登录时的Session就失效了，此时要想维护Session的持续有效有两个办法：

一、每次启动App就登录一次

第一个办法很土，不安全，但很有效。当用户登录成功后，保存用户的帐号、密码、是否登录状态在本地（记得加密），然后在APP每次重启时检查用户是否登录，如果是登录，那么后台自动调用登录接口登录一次，就可以拿到登录的有效Cookie。

二、用NoHttp的Cookie管理监听

第二个办法相对安全，建议采用第二种办法。NoHttp在初始化的时候可以配置一个CookieStore，我们可以给这个CookieStore设置一个Cookie管理的监听，当Cookie被保存时设置Cookie的有效期为永久：

public class App extends Application {

    private static App mainCourseInstance;

    @Override
    public void onCreate() {
        super.onCreate();
        NoHttp.initialize(this, new NoHttp.Config()
                .setCookieStore(new DBCookieStore(this).setCookieStoreListener(mListener))
        );
    }

    /**
     * Cookie管理监听。
     */
    private DBCookieStore.CookieStoreListener mListener = new DBCookieStore.CookieStoreListener() {
        @Override
        public void onSaveCookie(URI uri, HttpCookie cookie) { // Cookie被保存时被调用。
            // 1. 判断这个被保存的Cookie是我们服务器下发的Session。
            // 2. 这里的JSessionId是Session的name，
            //    比如java的是JSessionId，php的是PSessionId，
            //    当然这里只是举例，实际java中和php不一定是这个，具体要咨询你们服务器开发人员。
            if("JSessionId".equals(cookie.getName())) {
                // 设置有效期为最大。
                cookie.setMaxAge(HeaderUtil.getMaxExpiryMillis());
            }
        }

        @Override
        public void onRemoveCookie(URI uri, HttpCookie cookie) {// Cookie被移除时被调用。
        }
    }
}

NoHttp同步Cookie到原生的WebView

这里推荐一个方法，我们可以继承系统的WebView，然后设置一些必要属性后，重写WebView#loadUrl(String, Map<String, String>)方法。

第一步，继承WebView，重写loadUrl(String, Map<String, String>)方法：

ublic class MyWebView extends android.webkit.WebView {

    public MyWebView(Context context) {
        super(context);
    }

    public MyWebView(Context context, AttributeSet attrs) {
        super(context, attrs);
    }

    public MyWebView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
    }
    
    @Override
    public void loadUrl(String url, Map<String, String> httpHeader) {
        super.loadUrl(url, httpHeader);
    }
}

第二步，给loadUrl(String, Map<String, String>)方法添加具体添加自定义头和同步Cookie的代码：

@SuppressWarnings("deprecation")
@SuppressLint("NewApi")
@Override
public void loadUrl(String url, Map<String, String> httpHeader) {
    if (httpHeader == null) {
        httpHeader = new HashMap<>();
    }

    // 这里你还可以添加一些自定头。
    httpHeader.put("AppVersion", "1.0.0"); // 比如添加app版本信息，当然实际开发中要自动获取哦。

    URI uri = null;
    try {
        uri = new URI(url);
    } catch (URISyntaxException e) {
        e.printStackTrace();
    }
    if (uri != null) {
        java.net.CookieStore cookieStore = NoHttp.getCookieManager().getCookieStore();
        List<HttpCookie> cookies = cookieStore.get(uri);

        // 同步到WebView。
        android.webkit.CookieManager webCookieManager = android.webkit.CookieManager.getInstance();
        webCookieManager.setAcceptCookie(true);
        for (HttpCookie cookie : cookies) {
            String cookieUrl = cookie.getDomain();
            String cookieValue = cookie.getName() + "=" + cookie.getValue()
                        + "; path=" + cookie.getPath()
                        + "; domain=" + cookie.getDomain();
            
            webCookieManager.setCookie(cookieUrl, cookieValue);
        }

        if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.LOLLIPOP) {
            webCookieManager.flush();
        } else {
            android.webkit.CookieSyncManager.createInstance(NoHttp.getContext()).sync();
        }
    }
    super.loadUrl(url, httpHeader);
}

NoHttp同步Cookie到腾讯X5 WebView

很多人在使用它腾讯提供的X5服务器，来替代Android原生的WebView，如果你正是使用腾讯X5内核的话，同样NoHttp也支持Cookie同步。

步骤和上面原生WebView没区别，但是要注意几点：

1. 继承不是系统的android.webkit.WebView，而是com.tencent.smtt.sdk.WebView。
2. 同步到X5内核时不再是android.webkit.CookieManagerr，而是com.tencent.smtt.sdk.CookieManager。
3. 同步到X5内核时不再是android.webkit.CookieSyncManager，而是com.tencent.smtt.sdk.CookieSyncManager。

具体代码如下：

 1 ublic class MyWebView extends com.tencent.smtt.sdk.WebView {
 2 
 3     public MyWebView(Context context) {
 4         super(context);
 5     }
 6 
 7     public MyWebView(Context context, AttributeSet attrs) {
 8         super(context, attrs);
 9     }
10 
11     public MyWebView(Context context, AttributeSet attrs, int defStyleAttr) {
12         super(context, attrs, defStyleAttr);
13     }
14 
15     @SuppressWarnings("deprecation")
16     @SuppressLint("NewApi")
17     @Override
18     public void loadUrl(String url, Map<String, String> httpHeader) {
19         if (httpHeader == null) {
20             httpHeader = new HashMap<>();
21         }
22 
23         // 这里你还可以添加一些自定头。
24         httpHeader.put("AppVersion", "1.0.0"); // 比如添加app版本信息，当然实际开发中要自动获取哦。
25 
26         URI uri = null;
27         try {
28             uri = new URI(url);
29         } catch (URISyntaxException e) {
30             e.printStackTrace();
31         }
32         if (uri != null) {
33             java.net.CookieStore cookieStore = NoHttp.getCookieManager().getCookieStore();
34             List<HttpCookie> cookies = cookieStore.get(uri);
35 
36             // 同步到腾讯X5 WebView。
37             com.tencent.smtt.sdk.CookieManager webCookieManager = com.tencent.smtt.sdk.CookieManager.getInstance();
38             webCookieManager.setAcceptCookie(true);
39             for (HttpCookie cookie : cookies) {
40                 String cookieUrl = cookie.getDomain();
41                 String cookieValue = cookie.getName() + "=" + cookie.getValue()
42                         + "; path=" + cookie.getPath()
43                         + "; domain=" + cookie.getDomain();
44 
45                 webCookieManager.setCookie(cookieUrl, cookieValue);
46             }
47             com.tencent.smtt.sdk.CookieSyncManager.createInstance(NoHttp.getContext()).sync();
48         }
49         super.loadUrl(url, httpHeader);
50     }