WKWebView踩坑记录

近期在项目中有大量需求需要用WKWebView来实现，有在项目中尝试使用WKWebView拦截URL，拦截广告或者获取视频播放地址，以及和h5混合开发，有遇到过一些坑，现在记录部分典型问题以供后续遇到时查阅。

1、 WKWebview 拦截http/https请求

1.1、NSURLProtocol方式

WKWebView 在独立于 app 进程之外的进程中执行网络请求，请求数据不经过主进程，所以在 WKWebView 上直接使用 NSURLProtocol 无法拦截请求。但苹果开源的 webKit2 源码暴露了私有API：

+ [WKBrowsingContextController registerSchemeForCustomProtocol:]

使用上面的方法后，如果有post请求，会丢失request的body。在之前一个实际案例中想要获取视频播放的真实播放地址时，发现不少网站在获取真实视频源前会有一个验证，验证用的post请求，此方法会导致 body丢失，从而无法获取真实地址，网页上的播放窗口黑屏，提示：md5失败。另外此方式也依赖私有api，伴随着一定的审核风险。

1.2、WKURLSchemeHandler方式

WKURLSchemeHandler 是 iOS11 就推出的，用于处理自定义请求的方案，不过并不能处理 HTTP、HTTPS 等常规 scheme。但是现在有另外一个方法，代码如下：

#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<WKURLSchemeTask>)urlSchemeTask{
    NSURLRequest *request = urlSchemeTask.request;
    //在下面处理拦截到的HTTP和HTTPS请求,处理完后再次发起请求, 注意要处理didReceiveResponse:  didReceiveData: didFinish三个方法回调
    if ([request.URL.scheme containsString:@"https"]) {
        
    }else if ([request.URL.scheme containsString:@"http"]){
        
    }
    //    UIImage *image = [UIImage imageNamed:@"test.jpg"];
    //    NSData *data = UIImageJPEGRepresentation(image, 1.0);
    //    NSURLResponse *response = [[NSURLResponse alloc] initWithURL: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
@interface ViewController ()

@end

@implementation ViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    //如下是以APP为视角写的处理WKWebview请求的方式,如果要AOP,就需要hook WKWebview的initwithFrame方法,在里面处理WKWebview的请求
    WKWebViewConfiguration *configuration = [WKWebViewConfiguration new];
    CustomURLSchemeHandler *handler = [[CustomURLSchemeHandler alloc]init];
    NSMutableDictionary *handlers = [configuration valueForKey:@"_urlSchemeHandlers"];
    handlers[@"https"] = handler;//修改handler,将HTTP和HTTPS也一起拦截
    handlers[@"http"] = handler;
    WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds configuration:configuration];
    self.view = webView;
    [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.test.com"]]];
}
@end

该方法接入方便，能较好的解决问题，但遗憾的是上面的方法已经失效，经验证在iOS 12.2以及之后的系统版本中使用上面方法运行时会报错。报错内容如下：

Terminating app due to uncaught exception 'NSUnknownKeyException', reason: '[<WKWebViewConfiguration 0x121d0eec0> valueForUndefinedKey:]: this class is not key value coding-compliant for the key _urlSchemeHandlers.'

2、 WKWebview 白屏问题

2.1、白屏时WKCompositingView 为空的情况

先说下我遇到白屏问题的场景：在支付页面点击支付唤起微信支付支付后，回到h5页面，load一个新的请求时遇到。
经过多次模拟和对比，发现每次白屏的时候webview都缺少一个WKCompositingView的子视图，针对此场景解决方案是，在页面进入前台时遍历wkwebview的子视图（等0.5s后遍历，否则会发现每次都缺少该view.），如果没有该类型的view，则创建新的 webview，然后重新request，记得在创建新的webView时要先回收到白屏的webView,否则可能会出现问题。
判断是否白屏代码如下：

// 判断是否白屏
- (BOOL)isBlankView:(UIView*)view
{
    Class wkCompositingView =NSClassFromString(@"WKCompositingView");
    
    if ([view isKindOfClass:[wkCompositingView class]]) {
        return NO;
    }
    for(UIView*subView in view.subviews) {
        if (![self isBlankView:subView])
        {
            return NO;
        }
    }
    return YES;
}

2.1、其他原因的白屏

在寻找解决方案时发现还有其他可能会导致白屏问题，由于我自己没有遇到过，暂时无法验证。其他原因导致的白屏请看：https://blog.csdn.net/Asia_ZhangQQ/article/details/82812825

3、native/js交互

这里主要记录一个数据传递问题，在Apple提供的方法中无法同步返回数据给JS方法，WKWebView不能像UIWebView一样利用javaScriptCore交互，如果想要使用原生的方法传递数据给，必须通过native调用JS的方式以传参形式传递数据。总得来说，有下面几种方式来完成数据传递：

3.1、JS 调用native方法，native方法中立刻调用JS方法，通过传参的形式将数据给到JS。(对JS来说是异步收到返回值的)

3.2、利用开源框架WebViewJavascriptBridge完成（同步）

[self.bridge registerHandler:@"ObjC Echo" handler:^(id data, WVJBResponseCallback responseCallback) {
    NSLog(@"ObjC Echo called with: %@", data);
    responseCallback(data);
}];
[self.bridge callHandler:@"JS Echo" data:nil responseCallback:^(id responseData) {
    NSLog(@"ObjC received response: %@", responseData);
}];

3.3、在简书上看到另一种思路，通过拦截alert的方式，将数据传递给JS，此方法本人还未尝试，有兴趣的同学可以试一下。《iOS WKWebView与JS交互》

// 交互。可输入的文本。
 - (void)webView:(WKWebView *)webView runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(NSString * _Nullable))completionHandler 
 {
    NSLog(@"%@---%@",prompt,defaultText); completionHandler(@"xxxxx");//这里就是要返回给JS的返回值
 }

4、 显示native异常view（有点击重试按钮）和loading框

在某些场景，需要使用原生的loading以及native的异常view，该类问题主要需要解决以下几个问题：

4.1、何时开始loading，何时关闭loading

• 首次loadrequest时开始loading
• 在异常view,点击重试按钮时开始loading
• 在- (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation触发时停止loading
• 在- (void)webView:(WKWebView *)webView didFailNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error触发时停止loading
• 在- (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(WKNavigation *)navigation withError:(nonnull NSError *)error触发时停止loading
• 另外还有一种场景需要特别强调，如果页面在webView上已经看到页面显示了，但页面还没有完全加载完（进度没有达到100%），就会出现loading画面叠加在呈现的内容上，体验很差，为了减少此情况我们应该监听页面加载进度，当页面加载到一定进度时，停止loading。代码如下：

- (void)observeValueForKeyPath:(NSString *)keyPath
                      ofObject:(id)object
                        change:(NSDictionary<NSString *, id> *)change
                       context:(void *)context {
    if ([keyPath isEqualToString:@"estimatedProgress"]) {
        if (self.userWebView.estimatedProgress >= 0.8f) {
            if (!_lastRequestIsFail) {
                // 请求失败也会使进度 = 1
                [self.loadingView stopLoading];
                [self hidenEmptyTip];
            }
        }
    }
}

4.1、何时显示异常view，何时关闭异常view

• 在- (void)webView:(WKWebView *)webView didFailNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error触发时显示异常
• 在- (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(WKNavigation *)navigation withError:(nonnull NSError *)error触发时显示异常
• 在- (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation触发时隐藏异常
• 在异常view,点击重试按钮时隐藏异常
• 在页面进度加载到指定值时隐藏异常