40- WKWebView項目實踐分享(五)- WKWebView如何加Cookie

系列文章:

在iOS11以下的版本中,WKWebView并沒有類似UIWebView中NSHTTPCookieStorage這樣的可以直接設置和存儲Cookie的官方類。但是在各個App的實際開發過程中,給HTML5后臺傳入Cookie進行身份校驗等屬于最基本的操作,正是因為不能方便設置Cookie的原因,在本文發布的時候,很多大廠App的核心web業務并沒有使用WKWebView,仍然是UIWebView。iOS11開始,蘋果意識到了這個問題,做了妥協,新增WKHTTPCookieStorage來幫助開發者解決Cookie問題,雖然方便了,但是API仍然不穩定,比如iOS11.3的時候就出現了一些變動。

針對WKWebView設置Cookie的問題,為什么在iOS8-iOS11長達三年的時間里,蘋果沒有理會呢?CSDN作者請叫我馬老師的一篇文章中,提出了猜想,蘋果是想讓服務端完全控制Cookie,畢竟客戶端操作Cookie是有一定安全風險的。WKWebView設計出來,對安全性就有比較高的要求,比如說對跨域的限制。

客戶端不傳Cookie之后,服務端怎么確認用戶的身份信息呢?其中的一種方式,我們可以在首次請求的時候,將用戶信息身份信息通過POST請求的方式放到requst中。服務端接收到首次請求,判斷用戶身份信息。如果身份信息有效,在之后的請求中,服務器會主動設置Cookie保證后續的請求身份驗證是通過的。如果身份信息無效,則跳轉到登錄頁面。 這種方式就是Cookie完全交給服務器管理了。

但是,實際開發中,我們還是免不了客戶端設置Cookie。下邊說說在WKWebView中設置Cookie的方案。

WKWebView中設置Cookie的方案

在UIWebView中,可以通過NSHttpCookieStorage來管理Cookie,對Cookie進行增刪改查。當把Cookie添加到NSHttpCookieStorage中后,webView在發起請求的時候會自動從NSHttpCookieStorage中取出Cookie添加到request Header中,并且這個操作是零延遲的。也就是說,你第一行代碼添加Cookie到NSHttpCookieStorage中,第二行代碼loadRequest:,發起的請求中是帶有你設置的Cookie的。
關于零延遲這一點非常重要,因為你設置了Cookie,但是請求發起之后,request Header拿不到你設置的Cookie,導致服務器找不到Cookie,從而身份校驗不通過。

NSHttpCookieStorage對WKWebView而言,只能管理Cookie,但是沒有了零延遲自動同步到request Header這一關鍵特性。所以我們只能另找出路。正式因為修正這個問題,我們需要找對應方案適配不同的版本

截至本文發布時候,需要適配iOS版本分為三個范圍,分別是iOS8iOS11.0、iOS11.0iOS11.2、iOS11.3,iOS11.3以后的版本因為有了官方APIWKHTTPCookieStorage的加持,可以直接套用iOS11.3的方案。 下邊看方案的具體實施:

Cookie版本適配方案

下邊就針對每個適配版本來說一下具體操作方案。

適配iOS8~iOS11.0

首先這一步適配需要關注的地方有兩處:

  • 第一處是我們每次調用loadRequest:方法的時候,需要加Cookie。
  • 另一處就是loadRequest:成功之后,webView的后續頁面跳轉的時候,也需要加Cookie。

第一處,我們的解決思路是使用NSHttpCookieStorage管理Cookie。然后在每次調用loadRequest:方法的時候,我們把Cookie手動寫入到request Header中。具體代碼和步驟如下:

// 1. 清除NSHTTPCookieStorage中存儲的Cookies,避免重復Cookie
NSHTTPCookieStorage *cookieJar = [NSHTTPCookieStorage sharedHTTPCookieStorage];
for (NSHTTPCookie *cookie in cookieJar.cookies) {
    if ([cookie.comment isEqualToString:WebCookieComment]) {
        [cookieJar deleteCookie:cookie];
    }
}

// 2. 重新設置Cookies
[[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:cookie];
[[NSUserDefaults standardUserDefaults] synchronize];

// 3. 向Http Header中設置Cookie    
 NSDictionary *dict = [NSHTTPCookie requestHeaderFieldsWithCookies:[NSHTTPCookieStorage sharedHTTPCookieStorage].cookies];
 request.allHTTPHeaderFields = dict.copy;

// 4. 加載請求
[self.wkwebView loadRequest: request];

第二處后續webView跳轉中加Cookie,我們的解決思路是把Cookie添加到HTML中的document.Cookie,代碼如下:

//1. 添加自定義的cookie,后續請求Ajax頁面用到
WKUserScript *newCookieScript = [[WKUserScript alloc] initWithSource:[WebViewCookieTool cookieJavaScriptString] injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO];
[contentController addUserScript:newCookieScript];
webConfiguration.userContentController = contentController;


//2. 獲取Cookie的JS代碼
+ (NSString *)cookieJavaScriptString
    NSMutableString *script = [NSMutableString string];
    for (NSHTTPCookie *cookie in [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookies]) {
    if ([cookie.value rangeOfString:@"'"].location != NSNotFound) {
         continue;
    }
    [script appendFormat:@"document.cookie='%@'; \n", [self getCookieJSFromatString:cookie]];
}
    
    
+ (NSString *)getCookieJSFromatString:(NSHTTPCookie *)cookie
{
    NSString *cookieStr = [NSString stringWithFormat:@"%@=%@;domain=%@;path=%@",
                           cookie.name,
                           cookie.value,
                           cookie.domain,
                           cookie.path ?: @“/"];
    return cookieStr;
}

這種方案出現的問題

這種方案基本解決了iOS8-iOS10設置Cookie的問題,但是在實測中,發現將Cookie添加到request Header中會導致另一個問題出現。那就是如果在webView帶著Cookie發起請求之后,HTML服務器如果也想設置一些Cookie到header中,是不能正常設置的或者說添加不上,現象就是網頁無法正常顯示。針對這個問題,想到了兩個解決方案:

解決服務器無法在Header中正常設置Cookie

所以,我項目里有一個區分是不是本公司請求的靜態方法:

static inline BOOL checkURLIsNeedCookies(NSURL *url) {
    if ([url.host hasSuffix:@".myCompany.com") {
        return YES;
    }
    return NO;
}

適配iOS11.0~iOS11.2

iOS11.0之后的適配就爽啦,蘋果在iOS11.0推出了WKHTTPCookieStore,這個類對WKWebView的效果和NSHttpCookieStorage對UIWebView的效果一樣,并且也是零延遲。在請求發起的時候,我們只需要將Cookie設置到WKHTTPCookieStore就可以了。代碼如下:

// 1. 設置Cookie
WKWebsiteDataStore *store = [WKWebsiteDataStore defaultDataStore];
[store.httpCookieStore setCookie:cookie completionHandler:^{
NSLog(@“cookie添加成功”);
}];

// 2. 加載請求
[self.wkwebView loadRequest: request];

適配iOS11.3

前幾天升級iOS11.3之后發現一個問題。具體出錯的位置是需要上傳Cookie的HTML頁面,WKHTTPCookieStore第一次設置Cookie之后,發起請求,Cookie不能同步到request Header中。此時,webView重新請求頁面,WKHTTPCookieStore的作用恢復正常,之后請求其他的webView也不會出現Cookie丟失的問題。 總結就是在iOS11.3中,WKHTTPCookieStore設置Cookie之后,第一次發起請求Cookie會丟失,第二次及以后的請求的Cookie沒有問題。

解決方式是,我們在執行loadRequest之前主動設置一次Cookie。我這里是在didFinishLaunchOption:中設置的。設置完之后,就沒有問題了。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
{
   WKWebsiteDataStore *store = [WKWebsiteDataStore defaultDataStore];
    [store.httpCookieStore setCookie:cookie completionHandler:^{
        NSLog(@“cookie添加成功”);
    }];
}

好了,關于WKWebView的Cookie設置就到此為止。

共享Web Content Process

我們之前說過,一個WKWebView創建出來之后,對應一個Web Content Process。這樣就保證每個WKWebView的緩存、Cookie等信息是隔離的。但是這樣會導致一個問題就是,當網頁中出現<a>標簽和target=_blank的時候,會好像瀏覽器那樣新開一個tab頁面,此時新開的webView不共享不到之前webView的Cookie的,導致新開的webView不能正常顯示。 處理的方式是,所有的WKWebView共享同一個processPool。 下面有兩種設置方式:

 1’:   
self.processPool = [[WKProcessPool alloc] init];
WKWebViewConfiguration *configuration1 = [[WKWebViewConfiguration alloc] init];
configuration1.processPool = self.processPool;
WKWebView *webView = [[WKWebView alloc] initWithFrame:CGRectZero configuration:configuration1];


2’:
- (WKProcessPool *)wkProcessPool
{
    static dispatch_once_t once;
    static WKProcessPool * __singleton__;
    dispatch_once( &once, ^{
        __singleton__ = [[WKProcessPool alloc] init];
        
    });
    return __singleton__;
}

 webConfiguration.processPool = self.wkProcessPool; 
 WKWebView *webView = [[WKWebView alloc] initWithFrame:CGRectZero configuration:configuration1];

因為設置了單利的緣故,我們在HTML頁面退出的時候,因為銷毀單利。否則會導致一些問題。在《42- WKWebView項目實踐分享(六) - 補充: 實踐中的坑》提到。

參考

交流


希望能和大家交流技術
Blog:http://www.lilongcnc.cc


最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容