WKWebview 秒开的实践及踩坑之路_编程技术

WKWebview 秒开的实践及踩坑之路

优化背景

众所周知，H5 的部分优势(开发快，迭代快，热更新)是很明显的，公司客户端的部分业务都是由 H5 来实现的，网络好的情况下体验也是很不错的
但是其实 H5 的体验是比原生差的，这就需要想办法如何提高 H5 加载速度，优化体验，首屏的加载速度还是很影响体验的

加载速度

关于加载速度慢有很多文章都已经详细解释了，h5在加载工作中做了很多事

初始化 webview -> 请求页面 -> 下载数据 -> 解析HTML -> 请求 js/css 资源 -> dom 渲染 -> 解析 JS 执行 -> JS 请求数据 -> 解析渲染 -> 下载渲染图片

WKWebview 秒开的实践及踩坑之路

一般页面在 dom 渲染后才能展示，可以发现，H5 首屏渲染白屏问题的原因关键在于，如何优化减少从请求下载页面到渲染之间这段时间的耗时。

前后端优化

这其中可做的优化特别多，前后端能够做的是：

降低请求量：减少 HTTP 请求数, 合并资源，minify / gzip 压缩，webP，lazyLoad。
因为手机浏览器同时响应请求是 4 个，4 个的请求数也许不是特别靠谱，没有查到出处，但是肯定是越少越好。
HTTP 协议缓存请求，离线缓存 manifest，离线数据缓存 localStorage。
加快请求速度：预解析 DNS，减少域名数，并行加载，CDN 分发。
渲染：JS/CSS 优化，加载顺序，服务端渲染模板直出。

一般情况下，只要对照这个列表，对比差异就基本能搞定绝大部分前端性能问题了。不过我们在里面仔细再分析下，对首屏启动速度影响最大的就是网络请求，包括请求 HTML、css、image 等静态资源和展示数据的请求。所以客户端内，优化最关键的其实就是如何缓存这些网络资源，也就是离线包缓存方案。

离线包方案的实践

方案选型是两种

基于 LocalWebServer 实现 WKWebView 离线资源加载
使用 WKURLSchemeHandler 实现 WKWebView 离线资源加载

LocalWebServer

基于 iOS 的 local web server，目前大致有以下几种较为完善的框架：

CocoaHttpServer (支持 iOS、macOS 及多种网络场景)
GCDWebServer (基于 iOS，不支持 https 及 webSocket)
Telegraph (Swift 实现，功能较上面两类更完善)

当时采用的是 GCDWebServer，在打开 APP 后直接启动Webserver，H5 的链接直接替换成本地 localhost + 端口号链接的地址。

本来的方案是本地服务器和远端h5服务器同步下载资源，下载后客户端请求本地服务器的路径，如未找到相应的资源再请求远端服务器的资源文件。

测试过程中碰到很多奇怪的问题(暂不一一举例)，也有提到以下问题并且时间紧急所以并未做进一步的深入:

资源访问权限安全问题
APP 前后台切换时，服务重启性能耗时问题
服务运行时，电量及 CPU 占有率问题
多线程及磁盘 IO 问题

WKURLSchemeHandler

关于离线包

前端项目的静态资源直接打包成 zip 包，APP 在启动时开始下载该包并解压到本地。WKWebview 通过 WKURLSchemeHandler 拦截并加载本地资源文件。关于离线包的分发，就是普通的 zip 离线包和一个版本控制的 json 文件，每次打离线包会修改 json 文件里的版本号，并附有离线包下载地址。此处可以优化的更好，但暂时并不需要太复杂。

离线包的下载和解压

只是简单的下载并解压到本地资源路径，关于版本比对的代码这里没有展示出来，自行注意，避免每次都全量更新。

/* 创建网络下载对象 */
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];
/* 下载地址 */
NSURL *url = [NSURL URLWithString:request.urlParameters.path];
NSURLRequest *request = [NSURLRequest requestWithURL:url];
/* 下载路径 */
//获取Document文件
NSString * docsdir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
NSString * zipFilePath = [docsdir stringByAppendingPathComponent:@"zip"];//将需要创建的串拼接到后面
NSString * H5FilePath = [docsdir stringByAppendingPathComponent:@"H5"];
NSFileManager *fileManager = [NSFileManager defaultManager];
BOOL zipIsDir = NO;
BOOL H5IsDir = NO;
// fileExistsAtPath 判断一个文件或目录是否有效，isDirectory判断是否一个目录
BOOL zipexisted = [fileManager fileExistsAtPath:zipFilePath isDirectory:&zipIsDir];
BOOL H5Existed = [fileManager fileExistsAtPath:H5FilePath isDirectory:&H5IsDir];
if ( !(zipIsDir == YES && zipexisted == YES) ) {//如果文件夹不存在
[fileManager createDirectoryAtPath:zipFilePath withIntermediateDirectories:YES attributes:nil error:nil];
}
if (!(H5IsDir == YES && H5Existed == YES) ) {
[fileManager createDirectoryAtPath:H5FilePath withIntermediateDirectories:YES attributes:nil error:nil];
}
//删除
// [[NSFileManager defaultManager] removeItemAtPath:zipFilePath error:nil];
NSString *filePath = [zipFilePath stringByAppendingPathComponent:url.lastPathComponent];
/* 开始请求下载 */
NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:^(NSProgress * _Nonnull downloadProgress) {
NSLog(@"下载进度：%.0f％", downloadProgress.fractionCompleted * 100);
} destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
/* 设定下载到的位置 */
return [NSURL fileURLWithPath:filePath];
} completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) {
NSTimeInterval delta = CACurrentMediaTime() - self->start;
NSLog(@"下载完成，耗时：%f",delta);
// filePath就是你下载文件的位置，你可以解压，也可以直接拿来使用
NSString *imgFilePath = [filePath path];// 将NSURL转成NSString
NSString *zipPath = imgFilePath;
//删除
// [[NSFileManager defaultManager] removeItemAtPath:H5FilePath error:nil];
[fileManager createDirectoryAtPath:H5FilePath withIntermediateDirectories:YES attributes:nil error:nil];
//解压
[SSZipArchive unzipFileAtPath:zipPath toDestination:H5FilePath];
//清理缓存
[DLCommenHelper clearWebCache];
}];
[downloadTask resume];

WKWebview 缓存池

美团有篇文章提到，在使用 iOS 10 的模拟器测试 WKWebView 的加载速度，首次初始化的时间耗时有 700 多毫秒。其实本人用 iOS 13 的真机，发现初始化的时间约在 200 毫秒左右甚至更短。虽然只占整个加载时间的特别小的一部分，但是本着能优则优的原则还是做了处理，也就是预加载 Webview。

新建了一个单例类 SDIWKWebViewPool，默认缓存池里的数量是 10 个

+ (instancetype)sharedInstance {
static dispatch_once_t onceToken;
static SDIWKWebViewPool *instance = nil;
dispatch_once(&onceToken,^{
instance = [[super allocWithZone:NULL] init];
});
return instance;
}
+ (id)allocWithZone:(struct _NSZone *)zone{
return [self sharedInstance];
}
- (instancetype)init
{
self = [super init];
if (self) {
self.initialViewsMaxCount = 10;
self.preloadedViews = [NSMutableArray arrayWithCapacity:self.initialViewsMaxCount];
}
return self;
}

在合适的地方提前调用 //预加载wkwebview [[SDIWKWebViewPool sharedInstance] prepareWithCount:10];,自行选择在 delegate 或主页面初始化的时候调用。

/**
预初始化若干WKWebView
@param count 个数
*/
- (void)prepareWithCount:(NSUInteger)count {
NSTimeInterval start = CACurrentMediaTime();
// Actually does nothing, only initialization must be called.
while (self.preloadedViews.count < MIN(count,self.initialViewsMaxCount)) {
id preloadedView = [self createPreloadedView];
if (preloadedView) {
[self.preloadedViews addObject:preloadedView];
} else {
break;
}
}
NSTimeInterval delta = CACurrentMediaTime() - start;
NSLog(@"=======初始化耗时：%f", delta);
}
/**
从池中获取一个WKWebView
@return WKWebView
*/
- (WKWebView *)getWKWebViewFromPool {
if (!self.preloadedViews.count) {
NSLog(@"不够啦！");
return [self createPreloadedView];
} else {
id preloadedView = self.preloadedViews.firstObject;
[self.preloadedViews removeObject:preloadedView];
return preloadedView;
}
}

创建 webview 的方法如下,需要注意的是 kWKWebViewReuseScheme，WKWebView 需要注册这个 scheme 才能实现拦截，这个是 WKWebview 拦截需要的准备工作。
SDICustomURLSchemeHandler 是我的自定义拦截类

关于这里的版本为什么设置成 iOS 12 以上，WKURLSchemeHandler 是苹果 iOS 11 就已推出，但是有发现某款机型在 iOS 11.2 上拦截失效，导致产生 Webview 白屏。所以这里一刀切，直接 12 以上才处理。其实 iOS 12 一下的用户量特别少，所以不需要太担心。

//scheme定义
#define kWKWebViewReuseScheme @"kwebview"
/**
创建一个WKWebView
@return WKWebView
*/
- (WKWebView *)createPreloadedView {
WKUserContentController *userContentController = WKUserContentController.new;
WKWebViewConfiguration *configuration = [[WKWebViewConfiguration alloc] init];
NSString *cookieSource = [NSString stringWithFormat:@"document.cookie = 'API_SESSION=%@';", [SAMKeychain usertoken]];
WKUserScript *cookieScript = [[WKUserScript alloc] initWithSource:cookieSource injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO];
[userContentController addUserScript:cookieScript];
// 赋值userContentController
configuration.userContentController = userContentController;
configuration.preferences.javaScriptEnabled = YES;
configuration.suppressesIncrementalRendering = YES; // 是否支持记忆读取
[configuration.preferences setValue:@YES forKey:@"allowFileAccessFromFileURLs"];//支持跨域
// WKWebViewConfiguration *wkWebConfig = [[WKWebViewConfiguration alloc] init];
// WKUserContentController *wkUController = [[WKUserContentController alloc] init];
// wkWebConfig.userContentController = wkUController;
if (@available(iOS 12.0, *)) {
[configuration setURLSchemeHandler:[[SDICustomURLSchemeHandler alloc] init] forURLScheme:kWKWebViewReuseScheme];
} else {
// Fallback on earlier versions
}
WKWebView *wkWebView = [[WKWebView alloc]initWithFrame:CGRectZero configuration:configuration];
//根据自己的业务
wkWebView.allowsBackForwardNavigationGestures = YES;
return wkWebView;
}

替换 url scheme

if (@available(iOS 12.0, *)) {
if([urlString hasPrefix:@"http"] && [urlString containsString:@"ui-h5"]){
urlString = [urlString stringByReplacingOccurrencesOfString:@"https" withString:kWKWebViewReuseScheme];
}
}

这里是通过规则直接把 https 替换为 kWKWebViewReuseScheme,也就是替换 url scheme http(s) 为自定义协议，完成这一步后，拦截生效。

需要注意的有两点:

前端这边加载 js 等资源都是用相对路径，前端的 ajax 请求，像 post 请求，scheme 使用 http(s) 不使用自定义协议，这样native 不会拦截，完全交给 H5 与服务器交互，就不会发生发送 post 请求，body 丢失的情况。
在我的项目里，H5 对服务器的请求都是通过 native 端来转发的，所以也不存在拦截 post 请求，body 丢失的情况。所以上面这样的改动对 H5 端是无侵入式的，不需要修改业务代码。

最最重要的自定义 SDICustomURLSchemeHandler 类

- (void)webView:(WKWebView *)webView startURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask
API_AVAILABLE(ios(12.0)){
dispatch_sync(self.serialQueue, ^{
[_taskVaildDic setValue:@(YES) forKey:urlSchemeTask.description];
});
NSDictionary *headers = urlSchemeTask.request.allHTTPHeaderFields;
NSString *accept = headers[@"Accept"];
//当前的requestUrl的scheme都是customScheme
NSString *requestUrl = urlSchemeTask.request.URL.absoluteString;
NSString *fileName = [[requestUrl componentsSeparatedByString:@"?"].firstObject componentsSeparatedByString:@"ui-h5/"].lastObject;
NSString *replacedStr = [requestUrl stringByReplacingOccurrencesOfString:kWKWebViewReuseScheme withString:@"https"];
self.replacedStr = replacedStr;
//Intercept and load local resources.
if ((accept.length >= @"text".length && [accept rangeOfString:@"text/html"].location != NSNotFound)) {//html 拦截
[self loadLocalFile:fileName urlSchemeTask:urlSchemeTask];
} else if ([self isMatchingRegularExpressionPattern:@"\\.(js|css)" text:requestUrl]) {//js、css
[self loadLocalFile:fileName urlSchemeTask:urlSchemeTask];
} else if (accept.length >= @"image".length && [accept rangeOfString:@"image"].location != NSNotFound) {//image
NSString *key = [[SDWebImageManager sharedManager] cacheKeyForURL:[NSURL URLWithString:replacedStr]];
[[SDWebImageManager sharedManager].imageCache queryImageForKey:key options:SDWebImageRetryFailed context:nil completion:^(UIImage * _Nullable image, NSData * _Nullable data, SDImageCacheType cacheType) {
if (image) {
NSData *imgData = UIImageJPEGRepresentation(image, 1);
NSString *mimeType = [self getMIMETypeWithCAPIAtFilePath:fileName] ?: @"image/jpeg";
[self resendRequestWithUrlSchemeTask:urlSchemeTask mimeType:mimeType requestData:imgData];
} else {
[self loadLocalFile:fileName urlSchemeTask:urlSchemeTask];
}
}];
} else {
//return an empty json.
NSData *data = [NSJSONSerialization dataWithJSONObject:@{ } options:NSJSONWritingPrettyPrinted error:nil];
[self resendRequestWithUrlSchemeTask:urlSchemeTask mimeType:@"text/html" requestData:data];
}
}
-(BOOL)isMatchingRegularExpressionPattern:(NSString *)pattern text:(NSString *)text{
NSError *error = NULL;
NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:pattern options:NSRegularExpressionCaseInsensitive error:&error];
NSTextCheckingResult *result = [regex firstMatchInString:text options:0 range:NSMakeRange(0, [text length])];
return MHObjectIsNil(result)?NO:YES;
}

上面的代码是拦截资源请求后的处理代码。收到拦截请求后，先获取本地资源包对应的资源，转换成 data 回传给 webView 进行渲染处理;若本地没有，则 customScheme 替换成 https 的 url 重发请求通知 webview，这就是基本流程。
以下就是加载本地资源和重发请求的代码

//Load local resources, eg: html、js、css...
- (void)loadLocalFile:(NSString *)fileName urlSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask API_AVAILABLE(ios(11.0)){
if(![self->_taskVaildDic boolValueForKey:urlSchemeTask.description default:NO] || !urlSchemeTask || fileName.length == 0){
return;
}
NSString * docsdir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
NSString * H5FilePath = [[docsdir stringByAppendingPathComponent:@"H5"] stringByAppendingPathComponent:@"h5"];
//If the resource do not exist, re-send request by replacing to http(s).
NSString *filePath = [H5FilePath stringByAppendingPathComponent:fileName];
if (![[NSFileManager defaultManager] fileExistsAtPath:filePath]) {
NSLog(@"开始重新发送网络请求");
if ([self.replacedStr hasPrefix:kWKWebViewReuseScheme]) {
self.replacedStr =[self.replacedStr stringByReplacingOccurrencesOfString:kWKWebViewReuseScheme withString:@"https"];
NSLog(@"请求地址:%@",self.replacedStr);
}
self.replacedStr = [NSString stringWithFormat:@"%@?%@",self.replacedStr,[SAMKeychain h5Version]?:@""];
start = CACurrentMediaTime();//开始加载时间
NSLog(@"web请求开始地址:%@",self.replacedStr);
@weakify(self)
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:self.replacedStr]];
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
@strongify(self)
if([self->_taskVaildDic boolValueForKey:urlSchemeTask.description default:NO] == NO || !urlSchemeTask){
return;
}
[urlSchemeTask didReceiveResponse:response];
[urlSchemeTask didReceiveData:data];
if (error) {
[urlSchemeTask didFailWithError:error];
} else {
NSTimeInterval delta = CACurrentMediaTime() - self->start;
NSLog(@"=======web请求结束地址%@：：：%f", self.replacedStr, delta);
[urlSchemeTask didFinish];
}
}];
[dataTask resume];
[session finishTasksAndInvalidate];
} else {
NSLog(@"filePath:%@",filePath);
if(![self->_taskVaildDic boolValueForKey:urlSchemeTask.description default:NO] || !urlSchemeTask || fileName.length == 0){
NSLog(@"return");
return;
}
NSData *data = [NSData dataWithContentsOfFile:filePath options:NSDataReadingMappedIfSafe error:nil];
[self resendRequestWithUrlSchemeTask:urlSchemeTask mimeType:[self getMIMETypeWithCAPIAtFilePath:filePath] requestData:data];
}
}
- (void)resendRequestWithUrlSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask
mimeType:(NSString *)mimeType
requestData:(NSData *)requestData API_AVAILABLE(ios(11.0)) {
if(![self->_taskVaildDic boolValueForKey:urlSchemeTask.description default:NO] || !urlSchemeTask|| !urlSchemeTask.request || !urlSchemeTask.request.URL){
return;
}
NSString *mimeType_local = mimeType ? mimeType : @"text/html";
NSData *data = requestData ? requestData : [NSData data];
NSURLResponse *response = [[NSURLResponse alloc] initWithURL:urlSchemeTask.request.URL
MIMEType:mimeType_local
expectedContentLength:data.length
textEncodingName:nil];
[urlSchemeTask didReceiveResponse:response];
[urlSchemeTask didReceiveData:data];
[urlSchemeTask didFinish];
}

整个过程中遇到的一些踩坑点

1. 'The task has already been stopped'崩溃问题

_taskVaildDic 是一个 NSMutableDictionary，它里面存的是以当前的 urlSchemeTask做 key，拦截开始时设置 YES，收到停止通知时设置 NO。这是由于在快速切换 webview 时，之前的 urlSchemeTask 已经停止但是后面再次调用了它的方法就会产生该崩溃。
在实际使用过程中，用 bugly 监控到还是会有该崩溃发生，只不过次数特别少，一天约四五条左右。还在寻找问题的原因中。

- (void)webView:(WKWebView *)webView startURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask
API_AVAILABLE(ios(12.0)){
dispatch_sync(self.serialQueue, ^{
[_taskVaildDic setValue:@(YES) forKey:urlSchemeTask.description];
});
}
- (void)webView:(nonnull WKWebView *)webView stopURLSchemeTask:(nonnull id<WKURLSchemeTask>)urlSchemeTask API_AVAILABLE(ios(12.0)){
NSError *error = [NSError errorWithDomain:urlSchemeTask.request.URL.absoluteString code:0 userInfo:NULL];
NSLog(@"weberror:%@",error);
dispatch_sync(self.serialQueue, ^{
[self->_taskVaildDic setValue:@(NO) forKey:urlSchemeTask.description];
});
}