WKWebView - Cookie管理

Cookie 問題是目前 WKWebView 的一大短板,WKWebView 是單獨進程,擁有自己的私有存儲,Cookie 存在 WKHTTPCookieStore 中,每隔一段時間就和app側NSHTTPCookieStorage進行同步,這個同步是進程級別的同步,WKWebView那些坑中表示“二者同步是單向的”,但是經過驗證(iOS 14系統),二者同步是相互的,NSHTTPCookieStorage中會向WKHTTPCookieStore中同步,WKHTTPCookieStore也會向NSHTTPCookieStorage中同步,只不過都存在延時。

其中服務器 set-cookie 或 JS 執行 document.cookie 操作會很快將 Cookie 同步到 NSHTTPCookieStorage 和 WKHTTPCookieStore 中,需要注意的是,對于http-only為true的,document.cookie無法獲取到。

WKWebView Cookie 問題在于 WKWebView 發起的請求不會自動帶上存儲于 NSHTTPCookieStorage 容器中的 Cookie。

1. WKProcessPool

蘋果開發者文檔對 WKProcessPool 的定義是:A WKProcessPool object represents a pool of Web Content process. 通過讓所有 WKWebView 共享同一個 WKProcessPool 實例,可以實現多個 WKWebView 之間共享 Cookie(session Cookie and persistent Cookie)數據。不過 WKWebView WKProcessPool 實例在 app 殺進程重啟后會被重置,導致 WKProcessPool 中的 Cookie、session Cookie 數據丟失,目前也無法實現 WKProcessPool 實例本地化保存。

2. Cookie同步方案

iOS 11系統官方提供了同步 Cookie 的API,故 iOS 11 系統前后區分處理。

iOS 11及以后系統

iOS 11 及之后的系統可通過 WKHTTPCookieStore 來管理 HTTP Cookie 信息,WKHTTPCookieStore 存儲在 WKWebsiteDataStore 中,關系如下:
WKWebViewConfiguration -> WKWebsiteDataStore -> WKHTTPCookieStore

@interface WKWebViewConfiguration : NSObject <NSSecureCoding, NSCopying>
@property (nonatomic, strong) WKWebsiteDataStore *websiteDataStore API_AVAILABLE(macos(10.11), ios(9.0));
@end

@interface WKWebsiteDataStore : NSObject <NSSecureCoding>
+ (WKWebsiteDataStore *)defaultDataStore;
+ (WKWebsiteDataStore *)nonPersistentDataStore;
@property (nonatomic, readonly) WKHTTPCookieStore *httpCookieStore API_AVAILABLE(macos(10.13), ios(11.0));
@end

其中WKWebsiteDataStore.defaultDataStore是單例,WKWebViewConfiguration.websiteDataStore默認值為WKWebsiteDataStore.defaultDataStore,不管創建多少個WKWebViewConfiguration,所有的WKWebsiteDataStore均為全局單例,自己設置的nonPersistentDataStore除外。

綜上我們有兩個時機去設置 Cookie,一個是初始化 WKWebview 時,一個是發起請求時。注意 WKHTTPCookieStore 設置 Cookie 是一個異步的操作,所以在頁面初始化時設置 Cookie 會存在發起請求時,Cookie 沒有全部設置完畢的情況。

較好的方案為在 loadRequest 時,先設置 Cookie ,在設置成功的回調中再發起網絡請求。

如果沒有首頁使用 WKWebView 的場景,不需要啟動是就加載 web頁面,可以在APP啟動時,先進行 Cookie 的同步,因為是單例,后續所有的 WKWebView 都會攜帶對應的 Cookie 。

iOS 11 之前的系統

iOS 11 系統前 Cookie 的設置主要分為兩個階段,第一階段是 LoadRequest 請求 URL 時需要攜帶 Cookie ,第二階段是頁面加載完成后,業務請求需要攜帶 Cookie 。

由于 iOS 11 之前系統沒有提供對應API,所以我們需要分別處理這兩個階段。

階段一:在 loadRequest 前,在 request header 中設置 Cookie ,解決首個請求 Cookie 丟失問題。

WKWebView *webView = [[WKWebView alloc] init]; 
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://my.cookie.test:8080/WKCookieTestIndex"]]; 

NSArray *availableCookie = [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookiesForURL:request.URL];
if (availableCookie.count > 0) {
    NSDictionary *reqHeader = [NSHTTPCookie requestHeaderFieldsWithCookies:availableCookie];
    NSString *cookieStr = [reqHeader objectForKey:@"Cookie"];
    [request setValue:cookieStr forHTTPHeaderField:@"Cookie"];
}

[webView loadRequest:request];

階段二:通過 document.cookie 設置 Cookie 解決頁面內(同域)Ajax、iframe 請求攜帶 Cookie 問題。

// 可在初始化時進行設置
- (NSString *)ajaxCookieScripts {
    NSMutableString *cookieScript = [[NSMutableString alloc] init];
    // 為JS增加設置、獲取、刪除Cookie的方法(需要用到刪除方法)
    NSString *JSCookieFuncString =
    @"function setCookie(name,value,expires)\
    {\
    var oDate=new Date();\
    oDate.setDate(oDate.getDate()+expires);\
    document.cookie=name+'='+value+';expires='+oDate+';path=/'\
    }\
    function getCookie(name)\
    {\
    var arr = document.cookie.match(new RegExp('(^| )'+name+'=([^;]*)(;|$)'));\
    if(arr != null) return unescape(arr[2]); return null;\
    }\
    function delCookie(name)\
    {\
    var exp = new Date();\
    exp.setTime(exp.getTime() - 1);\
    var cval=getCookie(name);\
    if(cval!=null) document.cookie= name + '='+cval+';expires='+exp.toGMTString();\
    }";
    [cookieScript appendString:JSCookieFuncString];
    // 遍歷 HTTPCookieStorage 中所有 Cookie,進行同步
    // Tips:系統會根據URL的Domain,自動判斷攜帶Cookie,所以我們設置Cookie時不需要判斷域名。
    for (NSHTTPCookie *cookie in [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookies]) {
        
        // Skip cookies that will break our script
        if ([cookie.value rangeOfString:@"'"].location != NSNotFound) {
            continue;
        }
        // 設置Cookie前,先進行移除操作,防止出現重復設置的情況
        [cookieScript appendFormat:@"delCookie('%@');", cookie.name];
        // Create a line that appends this cookie to the web view's document's cookies
        [cookieScript appendFormat:@"document.cookie = '%@=%@;", cookie.name, cookie.value];
        if (cookie.domain || cookie.domain.length > 0) {
            [cookieScript appendFormat:@"domain=%@;", cookie.domain];
        }
        if (cookie.path || cookie.path.length > 0) {
            [cookieScript appendFormat:@"path=%@;", cookie.path];
        }
        if (cookie.expiresDate) {
            [cookieScript appendFormat:@"expires=%@;", cookie.properties[@"Expires"]];
        }
        if (cookie.secure) {
            // 只有 https 請求才能攜帶該 cookie
            [cookieScript appendString:@"Secure;"];
        }
        if (cookie.HTTPOnly) {
            // 保持 native 的 cookie 完整性,當 HTTPOnly 時,不能通過 document.cookie 來讀取該 cookie。
            [cookieScript appendString:@"HTTPOnly;"];
        }
        [cookieScript appendFormat:@"';"];
    }
    return cookieScript;
}

// 設置 WKUserScript
WKUserContentController *userContentController = [WKUserContentController new]; 
// 注意:此處 injectionTime 要設置成 WKUserScriptInjectionTimeAtDocumentStart,表示在最開始執行。
WKUserScript *cookieScript = [[WKUserScript alloc] initWithSource:self.ajaxCookieScripts injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO]; 
[userContentController addUserScript:cookieScript];
設置Cookie時不刪除造成重復

3. 實戰經驗

項目實戰發現,iOS 11前在初始化WKWebView時通過 WKUserScript 設置Cookie ,當 WKUserScript 設置過多時,會影響前端的解析渲染速度,正常業務使用無太大影響。對前端性能要求較高的業務,可以客戶端與前端配合,前端頁面渲染完成后,在適當的時機,調用原生方法獲取Cookie,前端通過 document.cookie 進行手動設置,此方案優勢是可以精準控制Cookie,加快首屏渲染速度,弊端是無法做到前端無感知,需要前端配合。可根據實際情況進行選擇。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,763評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,238評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,823評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,604評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,339評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,713評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,712評論 3 445
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,893評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,448評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,201評論 3 357
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,397評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,944評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,631評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,033評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,321評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,128評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,347評論 2 377

推薦閱讀更多精彩內容