一、WKWebView的使用
1.1 属性
关于 extendedLayoutIncludesOpaqueBars
和 automaticallyAdjustsScrollViewInsets
- 这两个属性属于UIViewController
- 默认情况下extendedLayoutIncludesOpaqueBars = false 扩展布局不包含导航栏
- 默认情况下automaticallyAdjustsScrollViewInsets = true 自动计算滚动视图的内容边距
- 但是,当 导航栏 是 不透明时,而tabBar为透明的时候,为了正确显示tableView的全部内容,需要重新设置这两个属性的值,然后设置contentInset(参考代码).
在iOS11 中, UIViewController的 automaticallyAdjustsScrollViewInsets
属性已经不再使用,我们需要使用UIScrollView的 contentInsetAdjustmentBehavior
属性来替代它.
UIScrollViewContentInsetAdjustmentBehavior 是一个枚举类型,值有以下几种:
- automatic 和scrollableAxes一样,scrollView会自动计算和适应顶部和底部的内边距并且在scrollView 不可滚动时,也会设置内边距.
- scrollableAxes 自动计算内边距.
- never不计算内边距
- always 根据safeAreaInsets 计算内边距一般我们肯定需要设置为 never,我们自己来控制间距,但是在iOS 12的webView中,就会出现开始所说的问题,需要设置为automatic才能解决
调整WKWebView布局方式,避免调整webView.scrollView.contentInset。实际上,即便在 UIWebView 上也不建议直接调整webView.scrollView.contentInset的值.
1.2 调整滚动速率
WKWebView 需要通过 scrollView delegate 调整滚动速率:
1 | - (void)scrollViewWillBeginDragging:(UIScrollView *)scrollView { |
1.3 视频自动播放
WKWebView 需要通过WKWebViewConfiguration.mediaPlaybackRequiresUserAction设置是否允许自动播放,但一定要在 WKWebView 初始化之前设置,在 WKWebView 初始化之后设置无效。
1.4 goBack API问题
WKWebView 上调用 -[WKWebView goBack], 回退到上一个页面后不会触发window.onload()函数、不会执行JS。
1.5 WKWebview+NSURLProtocol实现网页缓存
1.5.1 前言
出于节省hybrid app的性能,以及加载时间,对app内的一些资源做缓存处理,包括:图片、js文件。
首先,我们需要能拦截到这些请求,实验之后,发现NSURLProtocol
在WKWebViwe
中不生效。
本文分一下两个部分:
- 让WKWebView支持NSURLProtocol,摘抄了这篇博客大篇幅内容,其中有关于苹果对私有API的监测以及开发人员的应对措施
- 对资源做缓存措施
1.5.2 让WKWebView支持NSURLProtocol
在UIWebView中,只需要一行代码[NSURLProtocol registerClass:[customeURLProtocol class]];
,就可以对app内所有的网络请求进行拦截处理。
但是在WKWebView中,除了一开始会调用一下 + [NSURLProtocol canInitWithRequest:]
方法,之后就全拦截不到了。网上查,说是WKWebView 的请求是在单独的进程里,所以不走 NSURLProtocol。
1. registerSchemeForCustomProtocol
从方法名来猜测,它的作用的应该是注册一个自定义的 scheme,这样对于 WebKit 进程的所有网络请求,都会先检查是否有匹配的 scheme,有的话再走主进程的 NSURLProtocol 这一套流程。
博客作者猜测这么做可能是为了保证效率 (NSURLRequest 的 HTTPBody 属性在 WKWebView 中被忽略了应该也出于这个原因!— 这是个大坑 不能发POST请求了!),毕竟 IPC 代价挺高的。详细可以看: WebKit::CustomProtocolManager
和 WebKit::WebProcessPool
等相关源码
解决方案:
1 | Class cls = NSClassFromString(@"WKBrowsingContextController"); |
此时,[NSURLProtocol registerClass:[customeURLProtocol class]]
就可以生效了
2. 优化 - 私有API检测
关于私有 API
按照 @sunnyxx 的总结,Apple 检查私有 API 的使用,大概会采取下面几种手段:
- 是否 link 了私有 framework 或者公开 framework 中的私有符号,这可以防止开发者把私有 header 都 dump 出来供程序直接调用。
- 同上,使用@selector(_private_sel)加上-performSelector:的方式直接调用私有 API。
- 扫描所有符号,查看是否有继承自私有类,重载私有方法,方法名是否有重合。
- 扫描所有string,看字符串常量段是否出现和私有 API 对应的。
1 | Class cls = NSClassFromString(@"WKBrowsingContextController"); |
上面两行代码非常之符合第四条。
解决方案:
查询 WKWebView.h 可以看到,有个方法 - browsingContextController
的方法名跟 WKBrowsingContextController
长得很像,通过 KVC 取出来(没错,KVC 不但可以取 property 取 ivar,还可以取无入参 selector 的返回值)发现它就是 WKBrowsingContextController
的一个实例,这样一来这个私有类就可以通过 KVC 的方式来得到了:
1 | Class cls = [[[WKWebView new] valueForKey:@"browsingContextController"] class]; |
valueForKey
比直接使用 NSClassFromString
安全了许多。
其他解决方案:这些字符串也可以不明着写出来,只要运行时算出来就行,比如用 base64 编码啊,图片资源里藏一段啊,甚至通过服务器下发……
使用私有 API 的另一风险是兼容性问题
比如上面的 browsingContextController
就只能在 iOS 8.4 以后才能用,反注册 scheme 的方法 unregisterSchemeForCustomProtocol:
也是在 iOS 8.4 以后才被添加进来的。
要支持 iOS 8.0 ~ 8.3 机型的话,只能通过动态生成字符串的方式拿到 WKBrowsingContextControlle
,而且还不能反注册,不过这些问题都不大。至于向后兼容,这个也不用太担心,因为 iOS 发布新版本之前都会有开发者预览版的,那个时候可以提前关注测一下。对于以上的例子来说,如果将来哪个 iOS 版本移除了这个 API,那很可能是因为官方提供了完整的解决方案,到那时候自然也不需要以上的方法了。
1.5.3 对资源做缓存措施
1. 图片资源
通过response.MIMEType
判断如果是: image/gif
image/jpeg
image/jpg
image/png
利用SDWebImage提供的缓存api来存储数据:
1 | - (void)storeImage:(nullable UIImage *)image |
2. 文件
文件之类的我们是使用本地存储来做缓存
1.5.4 问题及处理
- 这么做有隐患,自定义
NSURLProtocol
会影响WKWebView
中POST请求,所以使用起来还得根据场景来看- 控制自定义的协议的开关时机
- 如果实在冲突可以再创建一个WKWebView、UIWebView的控制器,根据场景分开使用
- 有一阵,页面上有一些图片资源无法正常加载,下拉刷新无效,怀疑是缓存了错误资源,两个方面:1. CDN资源有问题 2. 缓存策略有问题。
- 不会拦截原生AFN请求(也不算问题,一般也没必要)
- 如果监控网络是通过注册NSURLProtocol来进行网络监控的,而且是用的AFN3.0,那么是拦截不到的,通过
sessionWithConfiguration:delegate:delegateQueue:
得到的session,他的configuration中已经有一个NSURLProtocol,所以不会走自定义的protocol(通过share得到的session没这个问题)
- 如果监控网络是通过注册NSURLProtocol来进行网络监控的,而且是用的AFN3.0,那么是拦截不到的,通过
解决方案:
- 我们将NSURLSessionConfiguration的属性
protocolClasses的get方法
hook掉,通过返回自定义的protocol,这样,我们就能够监控到通过sessionWithConfiguration:delegate:delegateQueue:
得到的session的网络请求 - 在AFHTTPSessionManager中注册
1 | NSMutableArray *protocols = [NSMutableArray arrayWithArray:manager.session.configuration.protocolClasses]; |
1.6 WKURLSchemeHandler的使用
看第三部分 WKURLSchemeHandler对比NSURLProtocol的优势,以及使用WKURLSchemeHandler实现请求拦截的问题与解决。
1.7 Cookie的传递
iOS下的cookie机制:
- iOS平台下每一个APP都有自己的Cookie,APP之间不共享Cookie,一个Cookie 对应一个NSHTTPCookie实体,并通过NSHTTPCookieStrorage进行管理。那些需要持久化的Cookie是存放在
~/Library/Cookies/Cookies.binarycookies
文件中的二进制格式。 - cookie是iOS系统默认持久化存储的,一般我们使用到cookie的地方,都要注意cookie的更新,删除。
1.7.1 UIWebview 相关API
1 | @interface NSHTTPCookieStorage : NSObject |
Cookie的生成途径有两种:
一种是访问网页,网页返回的是HTTP Header 中有 Set-Cookie指令进行Cookie 的设置,这里Cookie 的本地处理其实是由WebKit 进行的
1
[[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:cookie];
还有一种途径就是我们客户端通过手动设置的Cookie
1
[request setValue:[NSString stringWithFormat:@"%@=%@",[cookie name],[cookie value]] forHTTPHeaderField:@"Cookie"];
以上两种说的是UIWebView的设置方法
1.7.2 WKWebView相关API
WKWebView的取、设置,理论详见WKWebView 那些坑 — Cookie 问题
业界普遍认为 WKWebView 拥有自己的私有存储,不会将 Cookie 存入到标准的 Cookie 容器 NSHTTPCookieStorage 中。会忽略任何的默认网络存储器(NSURLCache
, NSHTTPCookieStorage
, NSCredentialStorage
) 和一些标准的自定义网络请求类(NSURLProtocol
,等等.),导致NSURLCache
和NSHTTPCookieStroage
无法操作(WKWebView)WebCore进程的缓存和Cookie
实践发现 WKWebView 实例其实也会将 Cookie 存储于 NSHTTPCookieStorage 中,但存储时机有延迟,在iOS 8上,当页面跳转的时候,当前页面的 Cookie 会写入 NSHTTPCookieStorage 中,而在 iOS 10 上,JS 执行 document.cookie 或服务器 set-cookie 注入的 Cookie 会很快同步到 NSHTTPCookieStorage 中,FireFox 工程师曾建议通过 reset WKProcessPool 来触发 Cookie 同步到 NSHTTPCookieStorage 中,实践发现不起作用,并可能会引发当前页面 session cookie 丢失等问题。
WKWebView Cookie 问题在于WKWebView 发起的请求不会自动带上存储于 NSHTTPCookieStorage 容器中的 Cookie。而UIWebView是自动注入cookie。
更新于2024.01.05.
测试发现:一个页面上通过
document.cookie
设置的Cookie,关闭WebView后,再次打开还是可以获取到。但是:
- document.cookie = ‘uid=lala’; 是指定当前host下的path,才能访问。其他path无法访问。
- document.cookie = ‘uid333=lala; expires=Sat, 01 Jan 2050 00:00:00 GMT; path=/‘; 是当前host下的所有path都可以访问到。
另外:WKWebview中发起的请求,通过抓包查看,请求头中也是会自动带上这个Cookie的!!
限制:
- 无法跨host访问Cookie
- 无法跨APP访问Cookie
与Cookie相同的情况就是WKWebView的缓存、凭据等。WKWebView都拥有自己的私有存储,因此和标准cocoa网络类兼容的不是那么好。
1. webView设置cookie
- JS注入的Cookie,比如PHP代码在Cookie容器中取是取不到的, javascript document.cookie能读取到,浏览器中也能看到。
- NSMutableURLRequest 注入的PHP等动态语言直接能从$_COOKIE对象中获取到,但是js读取不到,浏览器也看不到。
解决方案:
1 | // 1.在初始化时,通过js注入添加cookies |
2. webview取cookie
1 | //iOS11之前(好像失效了??解决无果,换UIWebView了) |
二、遇到的问题
在以前,一直以为Hybrid App开发是一种略显简单的事,不会使用太多能发挥移动端原生本身优势的复杂API,后来在新公司的工作(半混合式开发)过程中,发现混合式开发也是很多坑… 或者说WKWebView好多坑…
以下所说的内容,参考链接上基本上都有,本文的叙述方式主要是结合自己的经历(自己踩过的总结总是那么的深刻…[\捂脸])
应该在开始混合开发之前就看下这篇文章的,结果真的是等自己踩坑踩了一遍,总结之后,发现这篇文章上都有….[\大哭]
1. 加载URL的 encode问题
在数据网络请求或其他情况下,需要把URL中的一些特殊字符转换成UTF-8编码,比如:中文。解决无法加载的问题
编码
1 | // iOS 9以前 |
解码
1 | // iOS 9以前 |
总结:
- 混合开发中,最好将所有的URL的编解码问题都交给前端或者后端来做,毕竟移动端发版不够灵活。
- API编写时,要保证iOS与Android两端的处理一致,否则前端同学做处理就太麻烦了。
2. NSURLProtocol 造成的body数据丢失
在 WKWebView 上通过 loadRequest 发起的 post 请求 body 数据会丢失。
这个其实和WKWebview没有关系,这个是苹果为了提高效率加快流畅度所以在NSURLProtocol拦截之后索性就不复制body体内的东西,因为body的大小没有限制,开发者可能会把很大的数据放进去那就不好办了。
1 | //同样是由于进程间通信性能问题,HTTPBody字段被丢弃[request setHTTPMethod:@"POST"]; |
目前也已经有成熟的解决方案了,见KKJSBridge库。原理上都是hook ajax,不过细节上分两种:
这里只对比方案间相互比较的优缺点,共同的优点,就不赘述了。如果对私有 API 不敏感的,我是比较推荐使用方案一的。
方案一:Ajax Hook 部分 API + NSURLProtocol
这个方案对应的是这里的 KKJSBridge/AjaxProtocolHook
。
1. 原理介绍
此种方案,是只需要 hook ajax 中的 open/send 方法。
- 在 hook 的 send 方法里,先把要发送的 body 通过 JSBridge 发送到 Native 侧去缓存起来。
- 为每一个post请求设置一个id,对应其缓存起来的body数据。
- 缓存成功后,再去执行真实的 send 方法,NSURLProtocol 此时会拦截到该请求,然后取出之前缓存的 body 数据,重新拼接请求,就可以发送出去了。
- 然后通过 NSURLProtocol 把请求结果返回给 WebView 内核。
优点:
- 兼容性会更好,网络请求都是走 webview 原生的方式。
- hook 的逻辑会更少,会更加稳定。
- 可以更好的支持 ajax 获取二进制的数据。例如 H5 小游戏场景(白鹭引擎是通过异步获取图片资源)。
缺点:
- 需要使用到私有 API browsingContextController 去注册 http/https。(其实现在大部分的离线包方案也是使用了这个私有 API 了)
2. 网易云的设计实现
看第三部分
方案二:Ajax Hook 全部 API
这个方案对应的是这里的 KKJSBridge/AjaxHook
。
原理介绍:此种方案,是使用 hook 的 XMLHttpRequest 对象来代理真实的 XMLHttpRequest 去发送请求,相当于是需要 hook ajax 中的所有方法。
- 在 hook 的 open 方法里,调用 JSBridge 让 Native 去创建一个 NSMutableRequest 对象。
- 在 hook 的 send 方法里,把要发送的 body 通过 JSBridge 发送到 Native 侧,并把 body 设置给刚才创建的 NSMutableRequest 对象。
- 在 Native 侧完成请求后,通过 JS 执行函数,把请求结果通知给 JS 侧,JS 侧找到 hook 的 XMLHttpRequest 对象,最后调用 onreadystatechange 函数,让 H5 知道有请求结果了。
优点:
- 没有使用私有 API。
缺点:
- 需要 hook XMLHttpRequest 的所有方法。
- 请求结果是通过 JSBrdige 来进行传输的,性能上肯定没有原生的性能好。
- 不能支持 ajax 获取二进制的数据。要想支持的话,还需要额外的序列化工作。
方案三:body数据转移至header、转GET
问题:
- Header的大小好像是有限制的,有博主试过2M是没有问题,不过超过10M就直接Request timeout了。
- 当Body数据为二进制数据时这招也没辙了,因为Header里都是文本数据
- 如果不想缓存,那先把post转get、或者body参数存header中,缺点都是body有限制。这种适合参数较少时。注意有个坑就是修改header可能会导致发出options请求。—— 来自群友交流
方案四:HTTPBodyStream(未验证)
有博主查了大量的资料发现,既然post请求的httpbody没有苹果复制下来,那我们就不用httpbody,我们再往底层去看就会发现HTTPBodyStream这个东西我们可以通过它来获取请求的body体,具体代吗如下:
1 |
|
3. WKUserContentController造成内存泄漏
self -> webView -> WKWebViewConfiguration -> WKUserContentController -> self (addScriptMessageHandler)
以下的方法,并不能解决问题
1 | __weak typeof(self) copy_self = self; |
解决方案: 单独创建一个类实现WKScriptMessageHandler
协议,然后在该类中再创建一个协议,由self来实现协议。
1 | self -> webView -> WKWebViewConfiguration -> WKUserContentController -> weak delegate obj --delegate--> self |
示例代码:
1 | //1.创建一个新类WeakScriptMessageDelegate |
上面三步就可以解决控制器不能被释放的问题了。
4. WKWebView的白屏问题(拍照引起)
原理
WKWebView 自诩拥有更快的加载速度,更低的内存占用,但实际上 WKWebView 是一个多进程组件,Network Loading 以及 UI Rendering 在其它进程中执行。
换WKWebView加载网页后,App 进程内存消耗反而大幅下降,但是仔细观察会发现,Other Process 的内存占用会增加。在一些用 webGL 渲染的复杂页面,使用 WKWebView 总体的内存占用(App Process Memory + Other Process Memory)不见得比 UIWebView 少很多。
- 在 UIWebView 上当内存占用太大的时候,App Process 会 crash;
- 在 WKWebView 上当总体的内存占用比较大的时候,WebContent Process 会 crash,从而出现白屏现象
解决方案
总结下来,白屏的现象有几种:
- WKWebView的URL为空,出现白屏,这种现象可以通过loadRequest解决。
- WKWebView的URL不空,出现白屏、部分白屏、白屏部分能点击,这种现象无论是reload还是loadRequest都不能刷出网页。(可以尝试3、4)
方案1. ContentProcessDidTerminate
借助 iOS 9以后 WKNavigtionDelegate
新增了一个回调函数:
1 | - (void)webViewWebContentProcessDidTerminate:(WKWebView *)webView API_AVAILABLE(macosx(10.11), ios(9.0)); |
当 WKWebView 总体内存占用过大,页面即将白屏的时候,系统会调用上面的回调函数,我们在该函数里执行[webView reload]
(这个时候 webView.URL 取值尚不为 nil)解决白屏问题。在一些高内存消耗的页面可能会频繁刷新当前页面,H5侧也要做相应的适配操作。
方案2. 检测 webView.title 是否为空
并不是所有H5页面白屏的时候都会调用上面的回调函数,比如,最近遇到在一个高内存消耗的意见反馈H5页面上 present 系统相机,拍照完毕后返回原来页面的时候出现白屏现象(拍照过程消耗了大量内存,导致内存紧张,WebContent Process 被系统挂起),但上面的回调函数并没有被调用。
在WKWebView白屏的时候,另一种现象是 webView.titile 会被置空, 因此,可以在 viewWillAppear 的时候检测 webView.title
是否为空来 reload 页面。
注意:可能有的前端页面确实没写title标签,在前端移动端开发中是可能会有这种场景的,会造成页面反复刷新
综合以上两种方法可以解决绝大多数的白屏问题。
方案3. 检索WKCompositingView控件
(未验证,有人说不好使)
WKWebView的URL不空,出现白屏不能点击、白屏部分能点击、部分白屏能点击等,这种现象无论是reload、loadRequest、清缓存、setNeedsLayout都不能刷出网页,只能回收旧webview(webview = nil 后记得清除代理,移除监听,要不然会crash)创建新的 webview, 然后重新request。
1 | // 判断是否白屏 |
方案4. html中加入资源加载的监听
在本地html中加入资源加载的监听,只要发生错误,就调用location.reload();重载当前文档。
1 | //监控资源加载错误(img,script,css,以及jsonp) |
注:这段代码要放在head内,并且css不能内联。
6. WKWebView的截屏问题(做意见反馈)
WKWebView 下通过 -[CALayer renderInContext:]
实现截屏的方式失效,需要通过以下方式实现截屏功能:
1 | @implementation UIView (ImageSnapshot) |
然而这种方式依然解决不了 webGL 页面的截屏问题,Safari 以及 Chrome 这两个全量切换到 WKWebView 的浏览器也存在同样的问题:对webGL 页面的截屏结果不是空白就是纯黑图片。
7. window.alert()引起的crash问题(暂时没遇到)
8. WKWebView拦截协议
WKWebView内默认不允许iTunes、weixin等协议跳转。
UIWebView打开ituns.apple.com、跳转到appStore、拨打电话、唤起邮箱等一系列操作,UIWebView自己处理不了会自动交给UIApplication 来处理。
WKWebView上述事件WKWebView 不会自动交给UIApplication 来处理,除此之外,js端通过window.open() 打开新的网页的动作也被禁掉了。
9. User-Agent修改
- 在UIWebView初始化之前,全局设置User-Agent才会生效
- 在shouldStartLoadWithRequest可以给某个request设置UA,但是需要重新[webView loadUrl],注意判断条件,不要死循环
- 不要擅自修改webView的User-Agent,务必要跟前端反复确认,是否有用UA来做一些设备区分,进而做一些系统、机型适配问题。
10. didFinish不调用
WKWebView didFinishNavigation明明看起来页面加载完全,却不调用(一般只发生在第一次进入该页面)。经过自定义NSURLProtocol,拦截所有的H5加载资源,并在didCompleteWithError中打印资源的加载情况,发现有图片资源,域名有问题。
1 | Error Domain=NSURLErrorDomain Code=-1003 "未能找到使用指定主机名的服务器。 |
原因:DNS解析失败导致系统认定H5一直没加载完成!第二次再进入,系统缓存了DNS解析的映射记录,所以很快就认定资源错误,调用了didFinish方法。
11. UI细节问题
11.1 WKWebView中 h5绝对布局不生效
1 | // ios 11之后 |
然后:前端需要在meta标签中增加 iPhoneX的适配—适配方案viewport-fit: cover
11.2. iOS 12中WKWebView中表单 键盘
iOS 12中WKWebView中表单键盘弹起自动上移,导致的兼容问题。
WKWebView会自动监听键盘弹出,并做上下移动处理(效果如同IQKeyboardManage这些库),但是在iOS12中会有一些问题,键盘收起后,控件不恢复原状,或者部分控件消失等不兼容问题
解决方案:
1 | if(kSystemVersion < 12.0) { |
11.3 WKWebview会下移20
解决方案:
1 | //iOS11前 |
12. H5标签不可点击,Native不受影响
iOS 11系统上,WKWebView内H5标签不可点击,Native不受影响。
在频繁的切换页面、刷新WKWebView的情况下,会出现WKWebView卡死,所有的H5标签不可点击,Native的UI不受影响,TabBarVC的几个子控制器最为严重,有时候切换、刷新四五次左右,就会出现这种情况。
更新:结论:在viewWillAppear方法中调用了evaluateJavaScript: completionHandler:
方法,将该方法的调用移到viewDidAppear方法中即可。
下面是探索的一些步骤,也走了一些弯路,可绕过:
分别从内存、视图、网络请求几个方面入手,按照以下步骤定位问题:
对APP进行内存泄漏检测,优化了几处代码。毫无用处
WKWebView单独进程内存问题?因为有一些二级页面按照问题出现流程复现了N多次,都没有出现,所以暂时先排除
网速问题。发现网速差时,确实很容易复现,网速好的时候,试了好几次没复现!做了一些网络优化,比如及时cancel掉一些不需要的请求,没有效果。
视图加载、更新问题。猜测依据:一级页面更容易复现,且比二级页面多了一个Tabbar的视图。
结论:结合第3、4,猜测是网络过慢时,tabbar出现、隐藏,及WKWebView刷新、加载、渲染HTML,几种情况结合导致的WKWebView布局混乱。
最后解决方法:包含WKWebView的一级页面,
viewDidAppear
时重新设置了一下WKWebView的约束。(设置UIScrollViewContentInsetAdjustmentAutomatic = YES,没有效果)效果:大大改善了,但却没有根治问题。加了个保底方案,下拉刷新时,销毁旧WKWebView,创建新的,并loadRequest。(因为这些情况下iOS 11上出现的,且没有更低版本的测试机复现,所以暂时把修改限制在了iOS 11及以下的系统)
最后:有个最省事的方案,针对这些页面,将WKWebView替换成UIWebView。 可行,但逃避问题,不太可取,而且UIWebView、WKWebView各有一些特性,另一个不支持,比如WKWebView支持html,滚动时实时回调,而UIWebView只支持滚动停止时回调。且苹果已经不太支持UIWebView。还是早点拥抱WKWebView吧。
三、[转]网易云WKURLSchemeHandler拦截请求
WebView 在移动端的应用场景随处可见,在云音乐里也作为许多核心业务的入口。为了满足云音乐日益复杂的业务场景,我们一直在持续不断的优化 WebView 的性能。其中可以短时间内提升 WebView 加载速度的技术之一就是离线包技术。该技术能够节省网络加载耗时,对于体积较大的网页提升效果尤为明显。离线包技术中最关键的环节就是拦截 WebView 发出的请求将资源映射到本地离线包,而对于 WKWebView
的请求拦截 iOS 系统原生并没有提供直接的能力,因此本文将围绕 WKWebView
请求拦截进行探讨。
3.1 两种方案及WKURLSchemeHandler选定
我们研究了业内已有的 WKWebView
请求拦截方案,主要分为如下两种:
NSURLProtocol
NSURLProtocol
默认会拦截所有经过 URL Loading System 的请求,因此只要 WKWebView
发出的请求经过 URL Loading System 就可以被拦截。经过我们的尝试,发现 WKWebView
独立于应用进程运行,发出去的请求默认是不会经过 URL Loading System,需要我们额外进行 hook 才能支持,具体的方式可以参考 NSURLProtocol对WKWebView的处理。
URL Loading System (URL加载系统)使用 https 等标准协议或创建的自定义协议提供对 URL 标识的资源的访问。是个API集合 — developer.apple
WKURLSchemeHandler
WKURLSchemeHandler
是 iOS 11 引入的新特性,负责自定义请求的数据管理,如果需要支持 scheme 为 http 或 https请求的数据管理则需要 hook WKWebView
的 handlesURLScheme
: 方法,然后返回NO即可。
经过一番尝试和分析,我们从以下几个方面将两种方案进行对比:
- 隔离性:
NSURLProtocol
一经注册就是全局开启。一般来讲我们只会拦截自己的业务页面,但使用了NSURLProtocol
的方式后会导致应用内合作的三方页面也会被拦截从而被污染。WKURLSchemeHandler
则可以以页面为维度进行隔离,因为是跟随着WKWebViewConfiguration
进行配置。 - 稳定性:
NSURLProtocol
拦截过程中会丢失 Body,WKURLSchemeHandler
在 iOS 11.3 之前 (不包含) 也会丢失 Body,在 iOS 11.3 以后 WebKit 做了优化只会丢失 Blob 类型数据。 - 一致性:
WKWebView
发出的请求被NSURLProtocol
拦截后行为可能发生改变,比如想取消 video 标签的视频加载一般都是将资源地址 (src) 设置为空,但此时stopLoading
方法却不会调用,相比而言WKURLSchemeHandler
表现正常。
调研的结论是:WKURLSchemeHandler
在隔离性、稳定性、一致性上表现优于 NSURLProtocol
,但是想在生产环境投入使用必须要解决 Body 丢失的问题。
3.2 问题1:解决 Body 丢失
方案设计
通过上文可以得知只通过 WKURLSchemeHandler
进行请求拦截是无法覆盖所有的请求场景,因为存在 Body 丢失的情况。所以我们的研究重点就是确保如何不让 Body 数据丢失或者提前拿到 Body 数据然后再将其组装成一个完整的请求发出,很显然前者需要对 WebKit 源码进行改动,成本过高,因此我们选择了后者。通过修改 JavaScript 原生的 Fetch / XMLHttpRequest 等接口实现来提前拿到 Body 数据,方案设计如下图所示: — WKWebView 请求拦截探索与实践 — 网易云
具体流程主要为以下几点:
- 加载 HTML 文档的时候注入自定义的
Fetch
/XMLHttpRequest
对象脚本 - 发送请求之前收集 Body 等参数通过
WKScriptMessageHandler
传递给原生应用进行存储 - 原生应用存储完成之后调用约定好的 JavaScript 函数通知
WKWebView
保存完成 - 调用原生
Fetch
/XMLHttpRequest
等接口来发送请求 - 请求被
WKURLSchemeHandler
管理,取出对应的 Body 等参数进行组装然后发出
前端侧:脚本注入
1. 替换 Fetch 实现
脚本注入需要修改 Fetch
接口的处理逻辑,在请求发出去之前能将 Body 等参数收集起来传递给原生应用,主要解决的问题为以下两点:
- iOS 11.3 之前 Body 丢失问题
- iOS 11.3 之后 Body 中
Blob
类型数据丢失问题
针对第一点需要判断在 iOS 11.3 之前的设备发出的请求是否包含请求体,如果满足则在调用原生
Fetch
接口之前需要将请求体数据收集起来传递给原生应用。针对第二点同样需要判断在 iOS 11.3 之后的设备发出的请求是否包含请求体且请求体中是否带有
Blob
类型数据,如果满足则同上处理。
其余情况只需直接调用原生 Fetch
接口即可,保持原生逻辑。
1 | var nativeFetch = window.fetch |
2. 保存请求体数据到原生应用
通过 WKScriptMessageHandler
接口就能将请求体数据保存到原生应用,并且需要生成一个唯一标识符对应到具体的请求体数据以便后续取出。我们的思路是生成标准的 UUID 作为标识符然后随着请求体数据一起传递给原生应用进行保存,然后再将 UUID 标识符拼接到请求链接后,请求被 WKURLSchemeHandler
管理后会通过该标识符去获取具体的请求体数据然后组装成请求发出。
1 | function saveParamsToNative(url, opts) { |
3. 请求体解析
在 Fetch
接口中可以通过第二个 opts 参数拿到请求体参数即 opts.body,参考 MDN Fetch Body 可得知请求体的类型有七种。经过分析,可以将这七种数据类型分为三类进行解析编码处理,将 ArrayBuffer
、ArrayBufferView
、Blob
、File
归类为二进制类型,string
、URLSearchParams
归类为字符串类型,FormData
归类为复合类型,最后统一转换成字符串类型返回给原生应用。
1 | function getBodyString(body, callback) { |
二进制类型为了方便传输统一转换成 Base64 编码。字符串类型中 URLSearchParams
遍历之后可得到键值对。复合类型存储结构类似为字典,值可能为 string
或者 Blob
类型,所以需要遍历然后按照 Multipart/form-data 格式进行拼接。
4. 其它
注入的脚本主要内容如上述所示,示例中只是替换了 Fetch
的实现,XMLHttpRequest
也是按照同样的思路进行替换即可。云音乐由于最低版本支持到 iOS 11.0,而 FormData.prototype.entries
是在 iOS 11.2 以后的版本才支持,对于之前的版本可以修改 FormData.prototype.set
方法的实现来保存键值对,这里不多加赘述。除此之外,请求可能是由内嵌的 iframe
发出,此时直接调用 finishSaveCallbacks[identifier]()
是无效的,因为 finishSaveCallbacks 是挂载在 Main Window 上的,可以考虑使用 window.postMessage
方法来跟子 Window 进行通信。
APP侧:WKURLSchemeHandler 拦截请求
WKURLSchemeHandler
的注册和使用这里不再多加叙述,具体的可以参考上文中的调研部分以及苹果文档,这里我们主要聊一聊拦截过程中要注意的点
3.3 问题2:解决HTML重定向
一些读者可能会注意到上文调研部分我们在介绍 WKURLSchemeHandler
时把它的作用定义为自定义请求的数据管理。那么为什么不是自定义请求的数据拦截呢?理论上:
- 拦截为开发者提供了完整的重定向、鉴权、过程中数据的返回等逻辑处理、回调接口,开发者可以选择不关心请求逻辑,只用处理好过程中的数据即可。
- 数据管理则只会提供数据相关的接口,请求中涉及的其他逻辑它不会进行处理、回调,需要开发者自行处理,以保证能将最终的数据正确返回。
带着这两个定义,我们再一起对比下 WKURLSchemeTask
和 NSURLProtocol
协议,可见后者比前者多了重定向、鉴权等相关请求处理逻辑。
1 | API_AVAILABLE(macos(10.13), ios(11.0)) |
那么该如何在拦截过程中处理重定向响应?我们尝试着每次收到响应时都调用 didReceiveResponse:
方法,发现中间的重定向响应都会被最后接收到的响应覆盖掉,这样则会导致 WKWebView
无法感知到重定向,从而不会改变地址等相关信息,对于一些有判断路由的页面可能会带来一些意想不到的影响。
此时我们再次陷入困境,可以看出 WKURLSchemeHandler
在获取数据时并不支持重定向,因为苹果当初设计的时候只是把它作为单纯的数据管理。
其实每次响应我们都能拿到,只不过不能完整的传递给 WKWebView
而已。经过一番衡量,我们基于以下三点原因最终选择了重新加载的方式来解决 HTML 文档请求重定向的问题。
- 目前能修改的只有
Fetch
和XMLHttpRequest
接口的实现,对于文档请求和 HTML 标签发起请求都是浏览器内部行为,修改源码成本太大。 Fetch
和XMLHttpRequest
默认只会返回最终的响应,所以在服务端接口层面保证最终数据正确,丢失重定向响应影响不大。- 图片 / 视频 / 表单 / 样式表 / 脚本等资源同理也一般只需关心最终的数据正确即可。
接收到 HTML 文档的重定向响应则直接返回给 WKWebView
并取消后续加载。而对于其它资源的重定向,则选择丢弃。
1 | - (void)URLSession:(NSURLSession *)session |
WKWebView
收到响应数据后会调用 webView:decidePolicyForNavigationResponse:decisionHandler
方法来决定最后的跳转,在该方法中可以拿到重定向的目标地址 Location 进行重新加载。
1 | - (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler |
至此 HTML 文档重定向问题基本上暂告一段落,到本文发布之前我们还未发现一些边界问题,当然如果大家还有其它好的想法也欢迎随时讨论。
3.4 Cookie 同步
由于 WKWebView
与我们的应用不是同一个进程所以 WKWebView
和 NSHTTPCookieStorage
并不同步。这里不展开讲 WKWebView Cookie 同步的整个过程,只重点讨论下拦截过程中的 Cookie 同步。
由于请求最终是由原生应用发出的,所以 Cookie 读取和存储都是走 NSHTTPCookieStorage
。
值得注意的是,WKURLSchemeHandler
返回给 WKWebView
的响应中包含 Set-Cookie
信息,但是 WKWebView 并未设置到 document.cookie
上。在这里也可以佐证上文所述: WKURLSchemeHandler
只是负责数据管理,请求中涉及的逻辑需要开发者自行处理。
WKWebView
的 Cookie 同步可以通过 WKHTTPCookieStore
对象来实现
1 | - (void)URLSession:(NSURLSession *)session |
拦截过程中除了把原生应用的 Cookie 同步到 WKWebView
, 在修改 document.cookie
时也要同步到原生应用。经过尝试发现真机设备上 document.cookie
在修改后会主动延迟同步到 NSHTTPCookieStorage
中,但是模拟器并未做任何同步。对于一些修改完 document.cookie
就立刻发出去的请求可能不会立即带上改动的 Cookie 信息,因为拦截之后 Cookie
是走 NSHTTPCookieStorage
的。
我们的方案是修改 document.cookie
setter 方法实现,在 Cookie 设置完成之前先同步到原生应用。注意原生应用此时需要做好跨域校验,防止恶意页面对 Cookie 进行任意修改。
1 | (function() { |
3.5 NSURLSession 导致的内存泄露
通过 NSURLSession
的 sessionWithConfiguration:delegate:delegateQueue
构造方法来创建对象时 delegate 是被 NSURLSession
强引用的,这一点大家比较容易忽视。
我们会为每一个 WKURLSchemeHandler
对象创建一个 NSURLSession
对象然后将前者设置为后者的 delegate,这样就导致循环引用的产生。
建议在 WKWebView
销毁时调用 NSURLSession
的 invalidateAndCancel
方法来解除对 WKURLSchemeHandler
对象的强引用。
3.6 稳定性措施
经过上文可以看出如果跟系统 “对着干”(WKWebView
本身就不支持 http/https 请求拦截),会有很多意想不到的事情发生,也可能有很多的边界地方需要覆盖,所以我们必须得有一套完善的措施来提升拦截过程中的稳定性。
3.6.1 动态配置拦截开闭
我们可以通过动态下发黑名单的方式来关掉一些页面的拦截。云音乐默认会预加载两个空 WKWebView
,一个是注册了 WKURLSchemeHandler
的 WKWebView
来加载主站页面,并且支持黑名单关闭,另外一个则是普通的 WKWebView
来加载一些三方页面(因为三方页面的逻辑比较多样和复杂,而且我们也没有必要去拦截三方页面的请求)。除此之外对于一些刚开始尝试通过脚本注入来解决请求体丢失的团队,可能覆盖不了所有的场景,可以尝试动态下发的方式更新脚本,同样要对脚本内容做好签名防止别人恶意篡改。
3.6.2 监控
日志收集能帮助我们更好的去发现潜在的问题。拦截过程中所有的请求逻辑都统一收拢在 WKURLSchemeHandler
中,我们可以在一些关键链路上进行日志收集。比如可以收集注入的脚本是否执行异常、接收到 Body 是否丢失、返回的响应状态码是否正常等等。
3.6.3 完全代理前端请求
除上述措施外我们还可以将网络请求比如服务端 API 接口完全代理给客户端。前端只用将相应的参数通过 JSBridge 方式传递给原生应用然后通过原生应用的网络请求通道来获取数据。
该方式除了能减少拦截过程中潜在问题的发生,还能复用原生应用的一些网络相关的能力比如 HTTP DNS、反作弊等。
而且值得注意的是 iOS 14 苹果在 WKWebView
默认开启了 ITP (Intelligent Tracking Prevention) 智能防跟踪功能,受影响的地方主要是跨域 Cookie 和 Storage 等的使用。比如我们应用里有一些三方页面需要通过一个 iframe
内嵌我们的页面来达到授权能力,此时由于跨域默认是获取不到我们主站域名下的 Cookie, 如果走原生应用的代理请求就能解决类似的问题。
最后再次提醒大家如果使用这种方式记得做好鉴权校验,防止一些恶意页面调用该能力,毕竟原生应用的请求是没有跨域限制的。
小结
本文将 iOS 原生 WKURLSchemeHandler
与 JavaScript
脚本注入结合在一起,实现了 WKWebView
在离线包加载、免流等业务中需要的请求拦截能力,解决了拦截过程中可能存在的重定向、请求体丢失、Cookie 不同步等问题并能以页面为维度进行拦截隔离。
在探索过程中我们愈发的感受到技术是没有边界的,有时候可能由于平台的一些限制,单靠一方是无法实现一套完整的能力。只有将相关平台的技术能力结合在一起,才能制定出一套合理的技术方案。