讓 WKWebView 支持 NSURLProtocol
最近把公司的項目從 UIWebView 遷移到了 WKWebView川无,因為之前大體上還是遵從了 Apple 的 API 沒有過度地去 hack,而且 WebViewJavascriptBridge 也同樣支持 WKWebView虑乖,所以遷移過程沒有想象中那么痛苦懦趋,只要把 UIWebViewDelegate 的方法改成 WKUIDelegate 和 WKNavigationDelegate 對應(yīng)方法就好了。
但是在 WKWebView 已經(jīng)出現(xiàn)了三年的今天疹味,UIWebView 還沒有被標(biāo)記為 deprecated仅叫,我想 Apple 一定也和很多開發(fā)者一樣,覺得 WKWebView 還沒有完善到能完全替代 UIWebView 的程度糙捺。比如其中一個痛點——對請求攔截的支持诫咱,正常情況下,按照下面的方式注冊一個 NSURLProtocol 子類洪灯,就可以對 app 內(nèi)所有的網(wǎng)絡(luò)請求進(jìn)行 MitM 了:
[NSURLProtocol registerClass:[AwesomeURLProtocol class]];
但 WKWebView 中的請求卻完全不遵從這一規(guī)則坎缭,除了一開始會調(diào)用一下 + [NSURLProtocol canInitWithRequest:]
方法,之后的整個請求流程似乎就與 NSURLProtocol 完全無關(guān)了签钩。關(guān)于這一點掏呼,網(wǎng)絡(luò)上文章一般都解釋說 WKWebView 的請求是在單獨的進(jìn)程里,所以不走 NSURLProtocol边臼。
既然 WKWebView 不走 NSURLProtocol哄尔,那為什么還要在一開始調(diào)一下 canInitWithRequest:
呢假消?更令我好奇的是從 WebKit.framework dump 出的頭文件能看出柠并,有幾個類(WKCustomProtocol、WKCustomProtocolLoader)明顯與 NSURLProtocol 有關(guān),說明 WKWebView 很可能是支持 NSURLProtocol 的臼予,只是出于某種原因沒開放而已鸣戴,于是我決定翻 WebKit 的源碼一探究竟。
WKBrowsingContextController
翻 WebKit 源碼的過程就不細(xì)說了粘拾,光從 GitHub 上拉源碼到本地就花了我?guī)讉€ G 的 ss 流量……總之翻到最后窄锅,我在一項單元測試 TestProtocol.mm 中看到了 NSURLProtocol 熟悉的身影:
+ (void)registerWithScheme:(NSString *)scheme
{
testScheme = [scheme retain];
[NSURLProtocol registerClass:[self class]];
#if WK_API_ENABLED
[WKBrowsingContextController registerSchemeForCustomProtocol:testScheme];
#endif
}
從 registerSchemeForCustomProtocol:
這個方法名來猜測,它的作用的應(yīng)該是注冊一個自定義的 scheme缰雇,這樣對于 WebKit 進(jìn)程的所有網(wǎng)絡(luò)請求入偷,都會先檢查是否有匹配的 scheme,有的話再走主進(jìn)程的 NSURLProtocol 這一套流程械哟,猜測這么做可能是為了保證效率 (NSURLRequest 的 HTTPBody 屬性在 WKWebView 中被忽略了應(yīng)該也出于這個原因)疏之,畢竟 IPC 代價挺高的。后翻 WebKit::CustomProtocolManager和 WebKit::WebProcessPool等相關(guān)源碼也印證了這個猜想暇咆。
看上去沒什么問題锋爪,于是按照 TestCase 里的例子嘗試了一下:
Class cls = NSClassFromString(@"WKBrowsingContextController");
SEL sel = NSSelectorFromString(@"registerSchemeForCustomProtocol:");
if ([(id)cls respondsToSelector:sel]) {
/ / 把 http 和 https 請求交給 NSURLProtocol 處理
[(id)cls performSelector:sel withObject:@"http"];
[(id)cls performSelector:sel withObject:@"https"];
}
// 這下 AwesomeURLProtocol 就可以用啦
[NSURLProtocol registerClass:[AwesomeURLProtocol class]];
現(xiàn)在 WKWebView 中的所有請求都可以被 NSURLProtocol 修改了:[圖片上傳中。爸业。其骄。(1)]
關(guān)于私有 API
按照 @sunnyxx 的總結(jié),Apple 檢查私有 API 的使用扯旷,大概會采取下面幾種手段:
是否 link 了私有 framework 或者公開 framework 中的私有符號拯爽,這可以防止開發(fā)者把私有 header 都 dump 出來供程序直接調(diào)用。
同上钧忽,使用@selector(_private_sel)加上-performSelector:的方式直接調(diào)用私有 API某抓。
掃描所有符號,查看是否有繼承自私有類惰瓜,重載私有方法否副,方法名是否有重合。
掃描所有string崎坊,看字符串常量段是否出現(xiàn)和私有 API 對應(yīng)的备禀。
而本文所介紹的方法,一共有兩個地方使用了私有 API:
Class cls = NSClassFromString(@"WKBrowsingContextController");
SEL sel = NSSelectorFromString(@"registerSchemeForCustomProtocol:");
這兩個地方都是通過反射的方式拿到了私有的 class/selector奈揍,對應(yīng)上面的第四條曲尸。其中第二行那個還好說,因為 registerSchemeForCustomProtocol這個名詞看上去相當(dāng)普通男翰,如果把這種字符串也禁掉了的話會誤傷一大票開發(fā)者另患,所以有風(fēng)險的主要是 WKBrowsingContextController這個字符串,要前綴有前綴蛾绎,要 camel case 有 camel case昆箕,再跟私有 class 名撞車的話就跟可能被拒了鸦列。
那么怎樣繞過這個字符串呢?查詢 WKWebView.h 可以看到鹏倘,有個方法 - browsingContextController的方法名跟 WKBrowsingContextController長得很像薯嗤,通過 KVC 取出來(沒錯,KVC 不但可以取 property 取 ivar纤泵,還可以取無入?yún)?selector 的返回值)發(fā)現(xiàn)它就是 WKBrowsingContextController的一個實例骆姐,這樣一來這個私有類就可以通過 KVC 的方式來得到了:
Class cls = [[[WKWebView new] valueForKey:@"browsingContextController"] class];
比起粗暴地 NSClassFromString,使用 valueForKey 的方法安全了許多捏题。當(dāng)然玻褪,如果還有什么要擔(dān)心的話,這些字符串也可以不明著寫出來公荧,只要運行時算出來就行归园,比如用 base64 編碼啊,圖片資源里藏一段啊稚矿,甚至通過服務(wù)器下發(fā)……既然到了這個程度庸诱,蘋果的靜態(tài)掃描就很難再 hold 住了。
使用私有 API 的另一風(fēng)險是兼容性問題晤揣,比如上面的 browsingContextController就只能在 iOS 8.4 以后才能用桥爽,反注冊 scheme 的方法 unregisterSchemeForCustomProtocol:也是在 iOS 8.4 以后才被添加進(jìn)來的,要支持 iOS 8.0 ~ 8.3 機型的話昧识,只能通過動態(tài)生成字符串的方式拿到 WKBrowsingContextController钠四,而且還不能反注冊,不過這些問題都不大跪楞。至于向后兼容缀去,這個也不用太擔(dān)心,因為 iOS 發(fā)布新版本之前都會有開發(fā)者預(yù)覽版的甸祭,那個時候再測一下也不遲缕碎。對于本文的例子來說,如果將來哪個 iOS 版本移除了這個 API池户,那很可能是因為官方提供了完整的解決方案咏雌,到那時候自然也不需要本文介紹的方法了。
最后校焦,我寫了一個 Demo 放到了 GitHub 上赊抖,支持 iOS 8.4+,代碼經(jīng)測試已通過 App Store 審核:https://github.com/yeatse/NSURLProtocol-WebKitSupport
內(nèi)容轉(zhuǎn)載于:https://blog.yeatse.com/2016/10/26/support-nsurlprotocol-in-wkwebview/