iOS WebKit

10/19/2022 swiftioswebkit

WebKit框架中涉及的类很多,框架的设计十分面向对象和模块化。

WebKit 框架中最核心的类应该属于 WKWebView了,这个类专门用来渲染网页视图,其他类和协议都将基于它和服务于它。

  • WKWebView:网页的渲染与展示,通过WKWebViewConfiguration可以进行配置。
  • WKWebViewConfiguration:这个类专门用来配置WKWebView。
  • WKPreference:这个类用来进行M相关设置。
  • WKProcessPool:这个类用来配置进程池,与网页视图的资源共享有关。
  • WKUserContentController:这个类主要用来做native与JavaScript的交互管理。
  • WKUserScript:用于进行JavaScript注入。
  • WKScriptMessageHandler:这个类专门用来处理JavaScript调用native的方法。
  • WKNavigationDelegate:网页跳转间的导航管理协议,这个协议可以监听网页的活动。
  • WKNavigationAction:网页某个活动的示例化对象。
  • WKUIDelegate:用于交互处理JavaScript中的一些弹出框。
  • WKBackForwardList:堆栈管理的网页列表。
  • WKBackForwardListItem:每个网页节点对象。

# 快速使用

使用 WKWebViewConfiguration 对 WebView 进行配置。

使用下面的代码可以创建一个 WKWebView 视图,创建 WebView 视图时,需要使用WKWebViewConfiguration 来进行配置:

WKWebView * WK;
WKWebViewConfiguration * config = [[WKWebViewConfiguration alloc]init];
WK = [[WKWebView alloc]initWithFrame:CGRectMake(0, 0, self.view.frame.size.width, self.view.frame.size.height-40) configuration:config];
[WK loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.baidu.com"]]];

设置进程池

//设置进程池
WKProcessPool * pool = [[WKProcessPool alloc]init];
config.processPool = pool;

WKProcessPool 类中没有暴露任何属性和方法,配置为同一个进程池的 WebView 会共享数据,例如 Cookie、用户凭证等,开发者可以通过编写管理类来分配不同维度的 WebView 在不同进程池中。

进行偏好设置

//进行偏好设置
WKPreferences * preference = [[WKPreferences alloc]init];
//最小字体大小 当将javaScriptEnabled属性设置为NO时,可以看到明显的效果
preference.minimumFontSize = 0;
//设置是否支持 javaScript 默认是支持的
preference.javaScriptEnabled = YES;

//设置是否允许不经过用户交互由javaScript自动打开窗口
preference.javaScriptCanOpenWindowsAutomatically = YES;
config.preferences = preference;

WKPerference实例为WebView提供一个偏好设置。

管理native与JavaScript的交互行为

//设置内容交互控制器 用于处理JavaScript与native交互
WKUserContentController *userController = [[WKUserContentController alloc]init];
//设置处理代理并且注册要被js调用的方法名称
[userController addScriptMessageHandler:self name:@"name"];

//js注入,注入一个测试方法。
NSString *javaScriptSource = @"function userFunc(){window.webkit.messageHandlers.name.postMessage( {\"name\":\"HS\"})}";
WKUserScript *userScript = [[WKUserScript alloc] initWithSource:javaScriptSource injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:YES]; // forMainFrameOnly:NO(全局窗口),yes(只限主窗口)
[userController addUserScript:userScript];
config.userContentController = userController;

WKUserContentController 专门用来管理 native 与 JavaScript 的交互行为,addScriptMessageHandler:name:方法来注册要被 js 调用的方法名称,之后再 JavaScript 中使用window.webkit.messageHandlers.name.postMessage()方法来像 native 发送消息,支持 OC 中字典,数组,NSNumber 等原生数据类型,JavaScript 代码中的 name 要和上面注册的相同。在 native 代理的回调方法中,会获取到 JavaScript 传递进来的消息,如下:

- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message{
    //这里可以获取到JavaScript传递进来的消息
}

WKScriptMessage类是 JavaScript 传递的对象实例,其中属性如下:

//传递的消息主体
@property (nonatomic, readonly, copy) id body;
//传递消息的WebView
@property (nullable, nonatomic, readonly, weak) WKWebView *webView;
//传递消息的WebView当前页面对象
@property (nonatomic, readonly, copy) WKFrameInfo *frameInfo;
//消息名称
@property (nonatomic, readonly, copy) NSString *name;

WKUserContentController 实例的addUserScript:用于注入JavaScript代码。

缓存框架

// 设置数据存储store
config.websiteDataStore = [WKWebsiteDataStore defaultDataStore];

WebKit 框架采用其本身的缓存框架,WKWebsiteDataStore 类用来处理数据的存储,其中属性和方法如下:

@interface WKWebsiteDataStore : NSObject
// 获取默认的存储器 此存储器为持久性的会被写入磁盘
+ (WKWebsiteDataStore *)defaultDataStore;
// 获取一个临时的存储器
+ (WKWebsiteDataStore *)nonPersistentDataStore;
// 存储器是否是临时的
@property (nonatomic, readonly, getter=isPersistent) BOOL persistent;
// 所有可以存储的类型
+ (NSSet<NSString *> *)allWebsiteDataTypes;
@end

其他属性

// 设置是否将网页内容全部加载到内存后再渲染
config.suppressesIncrementalRendering = NO;
// 设置 HTML5 视频是否允许网页播放,设置为NO则会使用本地播放器
config.allowsInlineMediaPlayback =  YES;
// 设置是否允许ariPlay播放
config.allowsAirPlayForMediaPlayback = YES;
// 设置视频是否需要用户手动播放  设置为NO则会允许自动播放
config.requiresUserActionForMediaPlayback = NO;
// 设置是否允许画中画技术 在特定设备上有效
config.allowsPictureInPictureMediaPlayback = YES;
// 设置选择模式 是按字符选择 还是按模块选择
/*
typedef NS_ENUM(NSInteger, WKSelectionGranularity) {
    //按模块选择
    WKSelectionGranularityDynamic,
    //按字符选择
    WKSelectionGranularityCharacter,
} NS_ENUM_AVAILABLE_IOS(8_0);
*/
config.selectionGranularity = WKSelectionGranularityCharacter;

//设置请求的User-Agent信息中应用程序名称 iOS9后可用
config.applicationNameForUserAgent = @"HS";

# WKWebView 中的属性和方法解析

下面列举了WKWebView中常用的属性和方法。

//设置导航代理
@property (nullable, nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;
//设置UI代理
@property (nullable, nonatomic, weak) id <WKUIDelegate> UIDelegate;
//导航列表
@property (nonatomic, readonly, strong) WKBackForwardList *backForwardList;
//通过url加载网页视图
- (nullable WKNavigation *)loadRequest:(NSURLRequest *)request;
//通过文件加载网页视图
- (nullable WKNavigation *)loadFileURL:(NSURL *)URL allowingReadAccessToURL:(NSURL *)readAccessURL NS_AVAILABLE(10_11, 9_0);
//通过HTML字符串加载网页视图
- (nullable WKNavigation *)loadHTMLString:(NSString *)string baseURL:(nullable NSURL *)baseURL;
//通过data数据加载网页视图
- (nullable WKNavigation *)loadData:(NSData *)data MIMEType:(NSString *)MIMEType characterEncodingName:(NSString *)characterEncodingName baseURL:(NSURL *)baseURL NS_AVAILABLE(10_11, 9_0);
//渲染导航列表中的某个网页节点
- (nullable WKNavigation *)goToBackForwardListItem:(WKBackForwardListItem *)item;
//网页标题
@property (nullable, nonatomic, readonly, copy) NSString *title;
//网页的url
@property (nullable, nonatomic, readonly, copy) NSURL *URL;
//网页是否正在加载中
@property (nonatomic, readonly, getter=isLoading) BOOL loading;
//加载进度 可以监听这个属性的值配合UIProgressView来设计进度条
@property (nonatomic, readonly) double estimatedProgress;
//是否全部是安全连接
@property (nonatomic, readonly) BOOL hasOnlySecureContent;
//证书列表
@property (nonatomic, readonly, copy) NSArray *certificateChain;
//是否可以回退
@property (nonatomic, readonly) BOOL canGoBack;
//是否可以前进
@property (nonatomic, readonly) BOOL canGoForward;
//回退网页
- (nullable WKNavigation *)goBack;
//前进网页
- (nullable WKNavigation *)goForward;
//刷新网页
- (nullable WKNavigation *)reload;
//忽略缓存的刷新
- (nullable WKNavigation *)reloadFromOrigin;
//停止加载
- (void)stopLoading;
//执行JavaScript代码
- (void)evaluateJavaScript:(NSString *)javaScriptString completionHandler:(void (^ __nullable)(__nullable id, NSError * __nullable error))completionHandler;
//是否允许右滑返回手势
@property (nonatomic) BOOL allowsBackForwardNavigationGestures;

WKBackForwardList

WKBackForwardList 类为导航管理的网页列表类

@interface WKBackForwardList : NSObject
//当前所在的网页节点
@property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *currentItem;
//前进的一个网页节点
@property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *forwardItem;
//回退的一个网页节点
@property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *backItem;
//获取某个index的网页节点
- (nullable WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
//获取回退的节点数组
@property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *backList;
//获取前进的节点数组
@property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *forwardList;
@end

在 WebKit 中,网页节点被抽象成为了 WKBackForwardListItem 类,这个类中封装的属性如下:

@interface WKBackForwardListItem : NSObject
//当前节点的URL
@property (readonly, copy) NSURL *URL;
//当前节点的标题
@property (nullable, readonly, copy) NSString *title;
//创建此WebView的初始URL
@property (readonly, copy) NSURL *initialURL;

# Native 与 JavaScript 交互

WebKit中的 Native 与 JavaScript 的交互主要有4类。

1.JavaScript调用native方法

这种方式是由 WKUserContentController 注册,并在代理方法中实现的。

2.native调用JavaScript方法

这种方式通过 WKWebView 直接调用 evaluteJavaScript:completionHandler: 方法来实现。

3.将 JavaScript 代码注入

这种方式可以在网页中注入一些自定义的 JavaScript 代码,也可以注入自定义的方法,再使用evaluteJavaScript:completionHandler:来调用方法。JavaScript 代码的注入也是通过 WKUserContentController 来完成的,使用 addUserScript: 方法来注入 JavaScript,其中需要通过WKUserScript 类来生成要注入的对象,这个类使用如下方法来进行实例化:

/*
source为要注入的js代码
WKUserScriptInjectionTime 设置注入的时机
forMainFrameOnly 参数设置是否只在主页面注入
typedef NS_ENUM(NSInteger, WKUserScriptInjectionTime) {
    // 原js代码运行前注入
    WKUserScriptInjectionTimeAtDocumentStart,
    // 原js代码运行后注入
    WKUserScriptInjectionTimeAtDocumentEnd
} NS_ENUM_AVAILABLE(10_10, 8_0);

*/
- (instancetype)initWithSource:(NSString *)source injectionTime:(WKUserScriptInjectionTime)injectionTime forMainFrameOnly:(BOOL)forMainFrameOnly;

4.WKUIDelegate 来交互

这种方式主要用于相应 JavaScript 中的弹出框,后面会详细介绍这个协议。

# WKUIDelegate 协议中方法解析

WebKit考虑web页面的各种弹出框样式,如alert弹出框、Confirm选择框和TextInput输入框。WebKit为了让我们开发人员可以根据自己APP的风格设计各种不同的样式。对这些弹出框进行了封装。

//创建新的webView时调用的方法
-(WKWebView *)webView:(WKWebView *)webView createWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationAction windowFeatures:(WKWindowFeatures *)windowFeatures{
    return webView;
}

//关闭webView时调用的方法
-(void)webViewDidClose:(WKWebView *)webView{

}
//下面这些方法是交互JavaScript的方法
//JavaScript调用alert方法后回调的方法 message中为alert提示的信息 必须要在其中调用completionHandler()
-(void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(void))completionHandler{
    NSLog(@"%@",message);
    completionHandler();
}
//JavaScript调用confirm方法后回调的方法 confirm是js中的确定框,需要在block中把用户选择的情况传递进去
-(void)webView:(WKWebView *)webView runJavaScriptConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(BOOL))completionHandler{
    NSLog(@"%@",message);
    completionHandler(YES);
}
//JavaScript调用prompt方法后回调的方法 prompt 是 js 中的输入框 需要在 block 中把用户输入的信息传入
-(void)webView:(WKWebView *)webView runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(NSString * _Nullable))completionHandler{
    NSLog(@"%@",prompt);
    completionHandler(@"123");
}

# WKProcessPool

WKProcessPool 是用于配置进程池的,它与网页视图的资源共享有关。WKProcessPool 这个类中没有暴露任何的属性和方法。

配置为同一个进程池的 webView 之间可以共享数据(例如 cookie、localStorage 等)。

每一个 webView 都会有自己的一个 web 内容进程,这些进程会被放进 config 配置的 processPool 中,处于同一个 processPool 中的 web 内容进程之间会共享。但是 processPool 中的进程会有限制,一旦达到该限制,processPool 中的 web 内容进程之间将会停止共享。

WKWebView WKProcessPool 实例在 app 杀进程重启后会被重置,导致 WKProcessPool 中的 Cookie、session Cookie 数据丢失,目前也无法实现 WKProcessPool 实例本地化保存。

# WKNavagationDelegate 中方法解析

WKNavagationDelegate 协议重要有两个作用,监听页面渲染流程与控制页面跳转,其中方法如下:

/*
决定是否响应网页的某个动作,例如加载,回退,前进,刷新等,在这个方法中,必须执行decisionHandler()代码块,并将是否允许这个活动执行在block中进行传入
*/
/*
WKNavigationAction是网页动作的抽象化,其中封装了许多行为信息,后面会介绍
WKNavigationActionPolicy为开发者回执,枚举如下:
typedef NS_ENUM(NSInteger, WKNavigationActionPolicy) {
    //取消此次行为
    WKNavigationActionPolicyCancel,
    //允许此次行为
    WKNavigationActionPolicyAllow,
} NS_ENUM_AVAILABLE(10_10, 8_0);
*/
-(void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler{
    decisionHandler(WKNavigationActionPolicyAllow);
}
//需要响应身份验证时调用 同样在block中需要传入用户身份凭证
-(void)webView:(WKWebView *)webView didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition, NSURLCredential * _Nullable))completionHandler{
    //用户身份信息
    NSURLCredential *newCred = [NSURLCredential credentialWithUser:@""
                                                          password:@""
                                                       persistence:NSURLCredentialPersistenceNone];
    // 为 challenge 的发送方提供 credential
    [[challenge sender] useCredential:newCred
           forAuthenticationChallenge:challenge];
    completionHandler(NSURLSessionAuthChallengeUseCredential,newCred);
}
//接收到数据后是否允许执行渲染
/*
其中,WKNavigationResponse为请求回执信息
WKNavigationResponsePokicy为开发者回执,枚举如下:
typedef NS_ENUM(NSInteger, WKNavigationResponsePolicy) {
    //取消渲染
    WKNavigationResponsePolicyCancel,
    //允许渲染
    WKNavigationResponsePolicyAllow,
} NS_ENUM_AVAILABLE(10_10, 8_0);
*/
-(void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler{
    decisionHandler(WKNavigationResponsePolicyAllow);
}
//=====================下面这个协议方法用于监听流程=========================================
//页面加载启动时调用
-(void)webView:(WKWebView *)webView didStartProvisionalNavigation:(WKNavigation *)navigation{

}
//当主机接收到的服务重定向时调用
-(void)webView:(WKWebView *)webView didReceiveServerRedirectForProvisionalNavigation:(WKNavigation *)navigation{

}
//内容到达主机时调用
-(void)webView:(WKWebView *)webView didCommitNavigation:(WKNavigation *)navigation{

}
//主页加载完成时调用
-(void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation{

}
//提交发生错误时调用
-(void)webView:(WKWebView *)webView didFailNavigation:(WKNavigation *)navigation withError:(NSError *)error{

}
//主页数据加载发生错误时调用
-(void)webView:(WKWebView *)webView didFailProvisionalNavigation:(null_unspecified WKNavigation *)navigation withError:(nonnull NSError *)error{

}
//进程被终止时调用
-(void)webViewWebContentProcessDidTerminate:(WKWebView *)webView{

}

# 扩展

首先,在注册要被 JavaScript 调用的方法时需要设置代理,在不需要时需要将代理移除,WKUserContentController中也提供了移除这个代理的方法,如果不移除,将会造成 WebView 不能释放。

//注册一个监听方法
- (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;
//移除一个方法的监听
- (void)removeScriptMessageHandlerForName:(NSString *)name;

同样与注入 JavaScript 对应,也可以将注入的代码移除,方法如下:

//注入一个JavaScript抽象对象
- (void)addUserScript:(WKUserScript *)userScript;
//移除所有注入
- (void)removeAllUserScripts;

在上面,经常会见到 WKNavagationAction 这个类,这个类中封装的是一些页面活动信息,如下:

@interface WKNavigationAction : NSObject
//原页面
@property (nonatomic, readonly, copy) WKFrameInfo *sourceFrame;
//目标页面
@property (nullable, nonatomic, readonly, copy) WKFrameInfo *targetFrame;
//请求URL
@property (nonatomic, readonly, copy) NSURLRequest *request;
//活动类型
/*
typedef NS_ENUM(NSInteger, WKNavigationType) {
    //链接激活
    WKNavigationTypeLinkActivated,
    //提交操作
    WKNavigationTypeFormSubmitted,
    //前进操作
    WKNavigationTypeBackForward,
    //刷新操作
    WKNavigationTypeReload,
    //重提交操作 例如前进 后退 刷新
    WKNavigationTypeFormResubmitted,
    //其他类型
    WKNavigationTypeOther = -1,
} NS_ENUM_AVAILABLE(10_10, 8_0);
*/
@property (nonatomic, readonly) WKNavigationType navigationType;
@end

很多 Hybrid 框架迭代到 WKWebview 后就可以出现关于 Cookie 共享的一些问题,这些问题无外乎就两点:

  1. 原生请求(NSURLSessionDataTask、AFNetworking等和)WKWebview 之间 cookie 的共享
  2. 不同 WKWebview (包括webview内的ajax请求) 之间 Cookie 的共享

# 产生这个问题的原因是什么?

NSHTTPCookieStorage 是一个单例,用来管理整个项目的 Cookie,包括 UIWebview 的Cookie也是由其管理,因此在使用UIWebview的情况下是没有任何问题的。但是WKWebview的Cookie信息并不存储在NSHTTPCookieStorage中,其由 WKProcessPool 管理。

# 多WKWebview间Cookie的共享

先来看WKWebview之间Cookie的共享问题如何解决

方法一

默认情况下,每一个WKWebview对象持有一个WKProcessPool对象,因此可以通过单例化WKProcessPool的方式解决WKWebview间Cookie共享的问题,但是存在的问题是WKProcessPool不会被持久化,应用被杀死后会导致Cookie丢失,对于需要长久保存的Cookie并不合适。

方法二

使用NSHTTPCookieStorage对象去手动存取Cookie信息并注入到WKWebview中。先来说怎么取:

- (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler{
    if (@available(iOS 12.0, *)) {
        WKHTTPCookieStore *cookieStore = webView.configuration.websiteDataStore.httpCookieStore;
        [cookieStore getAllCookies:^(NSArray* cookies) {
            [self setCookie:cookies];
        }];
    }else {
        NSHTTPURLResponse *response = (NSHTTPURLResponse *)navigationResponse.response;
        NSArray *cookies =[NSHTTPCookie cookiesWithResponseHeaderFields:[response allHeaderFields] forURL:response.URL];
        [self setCookie:cookies];
    }
    decisionHandler(WKNavigationResponsePolicyAllow);
}
- (void)setCookie:(NSArray *)cookies {
    for (NSHTTPCookie *cookie in cookies) {
        NSHTTPCookie *httpCookie = [self fixExpiresDateWithCookie:cookie];
        [[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:httpCookie];
    }
}
- (NSHTTPCookie *)fixExpiresDateWithCookie:(NSHTTPCookie *)cookie{
    NSMutableDictionary *propertiesDic = [[cookie properties] mutableCopy];
    if (![propertiesDic valueForKey:@"expiresDate"]) {
        propertiesDic[NSHTTPCookieExpires] = [NSDate dateWithTimeIntervalSinceNow:60*60*24*7];
        propertiesDic[NSHTTPCookieDiscard] = 0;
    }
    NSHTTPCookie *newCookie = [NSHTTPCookie cookieWithProperties:propertiesDic];
    return newCookie;
}

代码比较简单,唯一需要注意的就是fixExpiresDateWithCookie这个方法的实现中修改了Cookie的过期时间NSHTTPCookieExpires与是否丢弃NSHTTPCookieDiscard字段,修改原因是因为后端不愿意改代码,喝喝,当然也可以理解,B/S架构中session-only=1这样的设置较为安全,也是常态化操作,但是对于客户端多个webview对象就很尴尬了。同时这个操作的确可能带了信息泄露的安全问题,安全风险一定需要注意

接下来说怎么注入到WKWebview中去,有两种思路:

第一种是通过WKUserScript去注入,但是注入时机会影响服务器可能拿不到Cookie。

第二种方法是在构造NSURLRequest的时候去修改请求头,也直接上代码了:

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url cachePolicy:NSURLRequestUseProtocolCachePolicy timeoutInterval:20.0];
NSMutableString *cookiesString = [NSMutableString string];
NSArray *tmpCookies = [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookiesForURL:url];

for (NSHTTPCookie * cookie in tmpCookies) {
    NSString *cookieString = [NSString stringWithFormat:@"%@=%@;",cookie.name,cookie.value];
    [cookiesString appendString:cookieString];
}
[request setValue:cookiesString forHTTPHeaderField:@"Cookie"];
[self loadRequest:request];

# 原生请求与WKWebview之间Cookie的共享

获取和保存Cookie的方式与上面类似,再处理网络请求response的地方调用如下类似代码:

- (void)syncSwordCookies:(NSURLResponse *)response forURL:(NSURL *)url {
    NSDictionary *respHeader = [(NSHTTPURLResponse *)response allHeaderFields];
    NSArray *cookies = [NSHTTPCookie cookiesWithResponseHeaderFields:respHeader forURL:url];
    NSHTTPCookieStorage *cookieStorage = [NSHTTPCookieStorage sharedHTTPCookieStorage];
    for (NSHTTPCookie *cookie in cookies) {
        [cookieStorage setCookie:[self fixExpiresDateWithCookie:cookie]];
    }
}

Cookie都保存在NSHTTPCookieStorage中后,原生请求自动共享Cookie,webview注入方式即与前面说的WKWebview一样的,就不用赘述了,但是唯一要注意的地方就是 NSHTTPCookieStorage 保存有一个耗时时间,大概零点几秒,不能在保存后立刻去同步到WKWebview中去,否则容易取不到 Cookie。

# App进程的Cookie和WebProcess进程的Cookie如何同步?

因为在iOS 11之后,WKWebView统一使用WKHTTPCookieStore来管理Cookie, 而WKHTTPCookieStore 提供了 WKHTTPCookieStoreObserver 来监听Cookie的变化。

这样的话,我们就可以在监听到 WKWebViewCookie 发生变化的时候,将Cookie同步到App进程。

这样的话,我们就可以在监听到WKWebViewCookie发生变化的时候,将Cookie同步到App进程。

func setupWebView() {
    ...
    webView.configuration.websiteDataStore.httpCookieStore.add(self)
}

// WKHTTPCookieStoreObserver协议的方法
func cookiesDidChange(in cookieStore: WKHTTPCookieStore) {
    cookieStore.getAllCookies { array in
        array.forEach {
            HTTPCookieStorage.shared.setCookie($0)
        }
    }
}

值得注意的是,这样的话,两种不同进程的Cookie都会持久化到本地。所以如果要HTTPCookieStorage的Cookie不持久化到本地的话,可以添加“discard”字段在HTTPCookie中,这也就是相当于设置“sessionOnly”属性了。

# App进程的Cookie如何同步到WebProcess呢?

这个时候假设一个场景:App客户端请求了一个URL,服务器收到之后使用了Set-Cookies,当App客户端收到服务器的Response之后,需要把Cookies同步到WKWebView,那么如何实现呢?

可以采用淘宝技术分享中提到的解决方案: 我们可以通过 HOOK NSHTTPCookieStorage 中读写 Cookie 的接口,并且监听网络请求中 "Set-Cookie" 关键字,在 App 进程 Cookie 发生变化时同步到 WKWebView。

# NSHTTPCookieStorage与WKHTTPCookieStore的同步问题

首先明确一点,系统确实做了NSHTTPCookieStorage与WKHTTPCookieStore的同步,但是由于WKHTTPCookieStore的cookie操作都是在异步线程,所以从NSHTTPCookieStoreage同步到WKHTTPCookieStore时,会遇到两个问题:

  1. 同步时机不确定
  2. 同步任务在异步线程

举个简单的列子:NSHTTPCookieStoreage对URL1新增/修改cookie1后,立刻使webView打开URL1,那么webView的请求时无法获取到新增/修改后的cookie1的。

  • 从WKHTTPCookieStore同步到NSHTTPCookieStorage的cookie操作,都是安全的,及时的,因为NSHTTPCookieStorage的cookie操作在主线程操作

  • 从NSHTTPCookieStorage同步到WKHTTPCookieStore的cookie操作,是不安全的,不及时的,因为WKHTTPCookieStore的cookie操作都为异步线程且时机也是无法控制的

# Cookie同步方案

iOS 11系统官方提供了同步 Cookie 的API,故 iOS 11 系统前后区分处理。

iOS 11 及之后的系统可通过 WKHTTPCookieStore 来管理 HTTP Cookie 信息,WKHTTPCookieStore 存储在 WKWebsiteDataStore 中,关系如下:

WKWebViewConfiguration -> WKWebsiteDataStore -> WKHTTPCookieStore

综上我们有两个时机去设置 Cookie,一个是初始化 WKWebview 时,一个是发起请求时。注意 WKHTTPCookieStore 设置 Cookie 是一个异步的操作,所以在页面初始化时设置 Cookie 会存在发起请求时,Cookie 没有全部设置完毕的情况。

较好的方案为在 loadRequest 时,先设置 Cookie ,在设置成功的回调中再发起网络请求。

# WKWebView 拦截请求技术调研

业内已有的 WKWebView 请求拦截方案,主要分为如下两种

  • NSURLProtocol
  • WKURLSchemeHandler

# NSURLProtocol

NSURLProtocol 默认会拦截所有经过 URL Loading System 的请求,因此只要 WKWebView 发出的请求经过 URL Loading System 就可以被拦截。经过我们的尝试,发现 WKWebView 独立于应用进程运行,发出去的请求默认是不会经过 URL Loading System,需要我们额外进行 hook 才能支持,具体实时可参考:NSURLProtocol对WKWebView的处理 (opens new window)

虽然NSURLProtocol可以拦截监听每一个URL Loading System中发出request请求,记住是 URL Loading System 中那些类发出的请求,也支持AFNetwoking,UIWebView发出的 request,NSURLProtocol 都可以拦截和监听。

因为 WKWebView 在独立进程里执行网络请求。一旦注册 http(s) scheme 后,网络请求将从 Network Process 发送到 App Process,这样 NSURLProtocol 才能拦截网络请求。

但是在 WebKit2 的设计里使用 MessageQueue 进行进程之间的通信,Network Process 会将请求 encode 成一个 Message,然后通过 IPC(进程间通信) 发送给 App Process。出于性能的原因,encode 的时候 将HTTPBody 和 HTTPBodyStream 这两个字段丢弃掉(坑)

因此,如果通过registerSchemeForCustomProtocol注册了 http(s) scheme, 那么由 WKWebView 发起的所有 http(s)请求都会通过 IPC 传给主进程 NSURLProtocol 处理,导致 post 请求 body 被清空。

//苹果开源的 WebKit2 源码暴露了私有API:
+ [WKBrowsingContextController registerSchemeForCustomProtocol:]

//通过注册 http(s) scheme 后 WKWebView 将可以使用 NSURLProtocol 拦截 http(s) 请求:
Class cls = NSClassFromString(@"WKBrowsingContextController”);
 SEL sel = NSSelectorFromString(@"registerSchemeForCustomProtocol:"); 
if ([(id)cls respondsToSelector:sel]) { 
        // 注册http(s) scheme, 把 http和https请求交给 NSURLProtocol处理 
        [(id)cls performSelector:sel withObject:@"http"]; 
        [(id)cls performSelector:sel withObject:@"https"]; 
}

说明1:名目张胆使用私有API,是过不了AppStore审核的,具体使用什么办法,想来你也懂(hun xiao)。

说明2:一旦打开ATS开关:Allow Arbitrary Loads 选项设置为NO,通过 registerSchemeForCustomProtocol 注册了 http(s) scheme,WKWebView 发起的所有 http(s) 网络请求将被阻塞(即便将Allow Arbitrary Loads in Web Content 选项设置为YES);

说明3:iOS11之后可以通过WKURLSchemeHandler去完成对WKWebView的请求拦截,不需要再调用私有API解决上述问题了。

# WKURLSchemeHandler

WKURLSchemeHandler是iOS11就推出的,用于处理自定义请求的方案,不过并不能处理Http、Https等常规scheme。

WKURLSchemeHandler 负责自定义请求的数据管理,如果需要支持 scheme 为 http 或 https请求的数据管理则需要 hook WKWebView 的 handlesURLScheme: 方法,然后返回 NO 即可:

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Method originalMethod1 = class_getClassMethod(self, @selector(handlesURLScheme:));
        Method swizzledMethod1 = class_getClassMethod(self, @selector(yyhandlesURLScheme:));
        method_exchangeImplementations(originalMethod1, swizzledMethod1);
    });
}

+ (BOOL)yyhandlesURLScheme:(NSString *)urlScheme {
    if ([urlScheme isEqualToString:@"http"] || [urlScheme isEqualToString:@"https"] || [urlScheme isEqualToString:@"file"]) {
        return NO;  //这里让返回NO,应该是默认不走系统断言或者其他判断啥的
    } else {
        return [self handlesURLScheme:urlScheme];
    }
}
  • 隔离性: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 丢失的问题。

WKWebView自定义资源 scheme

  • 向WKWebView 注册 customScheme, 比如 dynamic://, 而不是https或http,避免对https或http请求的影响。

  • 保证使用离线包功能的请求,没有post方式,遇到customScheme请求,比如dynamic://www.dynamicalbumlocalimage.com/,通过 NSURLProtocol 拦截这个请求并加载离线数据。

  • iOS 11上, WebKit 提供的WKURLSchemeHandler可实现拦截,需要注意的只允许开发者拦截自定义 Scheme 的请求,不允许拦截 “http”、“https”、“ftp”、“file” 等的请求,否则会crash。

  • 重定向问题,WKURLSchemeHandler 在获取数据时并不支持重定向

上次更新: 10/20/2022, 5:36:35 AM