Cookie管理 WebView同步

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的持續有效有兩個辦法：

1、每次啓動App就登陸一次

第一個辦法很土，不安全，但頗有效。當用戶登陸成功後，保存用戶的賬號、密碼、是否登陸狀態在本地（記得加密），而後在APP每次重啓時檢查用戶是否登陸，若是是登陸，那麼後臺自動調用登陸接口登陸一次，就能夠拿到登陸的有效Cookie。

2、用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     }