在 WWDC 2017上,苹果 WebKit 和 Safari 工程师介绍了 WKWebView 新增的几个特性,相对 iOS 9 和 iOS 10,可谓充满惊喜,但也稍有遗憾。其中主要的三个特性:
Manage cookies
Provide custom resources
Filter unwanted content
Manage cookies
自 iOS 8系统推出后,苹果基本停止了对 UIWebView 的更新,并不断催促开发者使用 WKWebView, 然而直到现在还是有不少开发者对 WKWebView 处于观望状态,其中主要的原因之一便是 WKWebView 的 Cookie问题。iOS 11上,WKWebView 新增了 Ccookie 管理 API WKHTTPCookieStore,通过该接口可以设置、删除和查询 WKWebView cookie,甚至可以监听 cookie store 的变化。
WKWebViewConfiguration *configuration = [WKWebViewConfiguration new];
NSHTTPCookie *cookie = [NSHTTPCookie cookieWithProperties:@{NSHTTPCookieDomain:@".qq.com", NSHTTPCookiePath:@"/", NSHTTPCookieName:@"hello", NSHTTPCookieValue:@"world", NSHTTPCookieExpires:[NSDate dateWithTimeIntervalSinceNow:24*60*60]}];
WKWebsiteDataStore *webSiteDataStore = [WKWebsiteDataStore nonPersistentDataStore];
[webSiteDataStore.httpCookieStore setCookie:cookie completionHandler:nil];
configuration.websiteDataStore = webSiteDataStore;
WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds configuration:configuration];
self.view = webView;
[webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.qq.com"]]];
WKWebView Request 会自动带上 WKHTTPCookieStore 中的 Cookie, 正如 UIWebView Request 会自动带上 NSHTTPCookieStorage 中的 Cookie 一样;页面通过 document.cookie 或 Response Set-Cookie 设置的 Cookie 也会自动同步到 WKHTTPCookieStore 中。WKWebView Cookie 问题终于有了比较完美的解决方案(不用往 Request Header 里塞 Cookie,也不用注脚本种 Cookie,再也不用担心登录态丢失了😱)。实践发现,iOS 11 上 WKWebView cookie 不会和iOS 10一样自动同步到NSHTTPCookieStorage 容器中,对于混合使用 UIWebView 和 WKWebView 的业务,可能要在 WKHTTPCookieStore 和 NSHTTPCookieStorage 之间做些 Cookie 同步操作。
Provide custom resources
在 UIWebView 上,我们通常使用 NSURLProtocol 拦截请求,加载本地资源或缓存数据,提升页面加载速度;在 WKWebView 上,由于网络请求是在非主进程里发起,所以 NSURLProtocol 无法拦截到网络请求,iOS 11之前,除非利用 private api 或 - [WKWebView loadHTMLString: baseURL:] 接口, 否则是没办法实现 WKWebView 加载本地资源的。iOS 11上, WebKit 团队终于开放了 WKWebView 加载自定义资源的API,先上个简单的 Demo。
假设 HTML 文档中有一个 <img> 标签,我们希望它显示本地的一张图片 test.jpg,那么 H5 可以这样编码:
<imag src="customScheme://www.test.com/test.jpg">
Native 可以这样编码:
#import "ViewController.h"
#import <WebKit/WebKit.h>
@interface CustomURLSchemeHandler : NSObject<WKURLSchemeHandler>
@end
@implementation CustomURLSchemeHandler
//这里拦截到URLScheme为customScheme的请求后,读取本地图片test.jpg,并返回给WKWebView显示
- (void)webView:(WKWebView *)webView startURLSchemeTask:(id)urlSchemeTask {
NSURLRequest *request = urlSchemeTask.request;
UIImage *image = [UIImage imageNamed:@"test.jpg"];
NSData *data = UIImageJPEGRepresentation(image, 1.0);
NSURLResponse *response = [[NSURLResponse alloc] initWithURL:urlSchemeTask.request.URL MIMEType:@"image/jpeg" expectedContentLength:data.length textEncodingName:nil];
[urlSchemeTask didReceiveResponse:response];
[urlSchemeTask didReceiveData:data];
[urlSchemeTask didFinish];
}
- (void)webView:(WKWebView *)webVie stopURLSchemeTask:(id)urlSchemeTask {
}
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
WKWebViewConfiguration *configuration = [WKWebViewConfiguration new];
//设置URLSchemeHandler来处理特定URLScheme的请求,URLSchemeHandler需要实现WKURLSchemeHandler协议
//本例中WKWebView将把URLScheme为customScheme的请求交由CustomURLSchemeHandler类的实例处理
[configuration setURLSchemeHandler:[CustomURLSchemeHandler new] forURLScheme: @"customScheme"];
WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds configuration:configuration];
self.view = webView;
[webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.test.com"]]];
}
@end
大家注意到这里将本地自定义资源返回给 WKWebView 的几个接口(用法和长相是不是和 NSURLProtocolClient 很相似):
@protocol WKURLSchemeTask <NSObject>
- (void)didReceiveResponse:(NSURLResponse *)response;
- (void)didReceiveData:(NSData *)data;
- (void)didFinish;
- (void)didFailWithError:(NSError *)error;
可能大家会疑惑,这里为什么不将img src设置成 http://www.test.com/test.jpg, 同时设置 WKWebView 拦截 http 请求?笔者也这样乐观的思考过,实际结果是: WKWebView 只允许开发者拦截自定义 Scheme 的请求,如果在方法 - [WKWebViewConfiguration setURLSchemeHandler: forURLScheme:] 里设置 URLScheme: “http”,则 APP 会 crash , crash 信息为:
Terminating app due to uncaught exception 'NSInvalidArgumentException' reason: 'http' is a URL scheme that WKWebView handles natively
除了 “http” 外,WKWebView 还不允许拦截 Scheme 为 “https”、“ftp”、“file” 的请求,具体可以通过新接口 + [WKWebView handlesURLScheme:] 判断Scheme是否已经被WKWebView默认处理了。另外笔者写了一个简单的 Submit Request, 发现自定义 Scheme 请求 body 数据依然丢失😓。猜测 WebKit团队并没有解决跨进程Request Body Lost的问题,后续可以研究下WebKit源码,自定义 Scheme 可以限制用户只能做一些自定义资源加载,或许也符合苹果的安全和隐私政策。
只能拦截自定义 Scheme 的请求真是让人倍感遗憾,这意味着,不单H5同学要改变原来请求的Scheme, 调整 CSP 规则,客户端同学在本地资源不存在的时候,也要考虑是否将自定义 Scheme 的请求转换成 http 或 https 请求用NSURLSession重新发出,收到回包后再将数据返回给WKWebView。自定义 Scheme 请求也会遇到跨域、请求头Referer 字段丢失等问题。
Filter unwanted content
WWDC 2015上,WebKit 团队介绍了 Safari 上新增的 Content Blocker 特性,可以实现阻止页面内容加载或隐藏页面内容等功能。在WWDC 2017上,WebKit 团队将这一特性移植到了 WKWebView 上(感觉应用场景不是很大唉:joy:)。Content Blocking 通过 json 文件定义过滤规则,比如:
[{
"trigger": {
"url-filter": ".*"
},
"action": {
"type": "make-https"
}
},
{
"trigger": {
"url-filter": "testContentBlocking"
},
"action": {
"type": "block"
}
}]
这个过滤规则要求 WKWebView 把所有的 http 请求都转成 https,同时阻止 URL 中包含“testContentBlocking”的请求的加载。“trigger”字段通过正则表达式定义要过滤的请求,“action”字段定义针对这些请求要执行的操作,如block request loading,过滤规则的相关文档可以参考Safari Content-Blocking Rules Reference,定义好过滤规则后,通过新增的 API WKContentRuleListStore 将滤规则编译成高效的字节码传递给WKWebView;
NSString *jsonPath = [[NSBundle mainBundle] pathForResource:@"contentRuleList" ofType:@"json"];
NSString *jsonString = [NSString stringWithContentsOfFile:jsonPath encoding:NSUTF8StringEncoding error:nil];
[[WKContentRuleListStore defaultStore] compileContentRuleListForIdentifier: @"demoRuleList" encodedContentRuleList: jsonString completionHandler:^(WKContentRuleList *contentRuleList, NSError *error) {
WKWebViewConfiguration *configuration = [WKWebViewConfiguration new];
[configuration.userContentController addContentRuleList:contentRuleList];
WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds configuration:configuration];
self.view = webView;
[webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.test.com"]]];
}];
Others
除了上面介绍的三个主要新特性外,iOS 11 WKWebView也新增了一个截屏API:
- (void)takeSnapshotWithConfiguration:(WKSnapshotConfiguration *)snapshotConfiguration completionHandler:(void (^)(UIImage *snapshotImage, NSError *error))completionHandler;
可以截取可见的viewPort,设置截图尺寸,但是很遗憾,这个接口依然无法截取网页中用WebGL或Video标签渲染的视图,WKWebView上的截图操作建议还是交由H5处理。