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