WKWebView API精讲(OC)

转载于：http://blog.csdn.net/hdfqq188816190/article/details/52067798

WKWebView

看看WKWebView的头文件声明：

[objc] view plain copy

1. // webview 配置，具体看下面  
2. @property(nonatomic,readonly, copy) WKWebViewConfiguration*configuration;  
3.    
4. // 导航代理  
5. @property (nullable, nonatomic, weak) id<WKNavigationDelegate> navigationDelegate;  
6.    
7. // 用户交互代理  
8. @property(nullable,nonatomic, weak) id<WKUIDelegate> UIDelegate;  
9.    
10. // 页面前进、后退列表  
11. @property (nonatomic,readonly, strong) WKBackForwardList*backForwardList;  
12.    
13. // 默认构造器  
14. -(instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration*)configurationNS_DESIGNATED_INITIALIZER;  
15.    
16. // 已不再使用  
17. - (instancetype)initWithCoder:(NSCoder*)coder NS_UNAVAILABLE;  
18.    
19. // 与UIWebView一样的加载请求API  
20. -(nullable WKNavigation*)loadRequest:(NSURLRequest*)request;  
21.    
22. // 加载URL  
23. - (nullableWKNavigation *)loadFileURL:(NSURL*)URL allowingReadAccessToURL:(NSURL*)readAccessURLNS_AVAILABLE(10_11,9_0);  
24.    
25. // 直接加载HTML  
26. -(nullable WKNavigation*)loadHTMLString:(NSString*)string baseURL:(nullableNSURL *)baseURL;  
27.    
28. // 直接加载data  
29. - (nullableWKNavigation *)loadData:(NSData*)data MIMEType:(NSString*)MIMEType characterEncodingName:(NSString*)characterEncodingName baseURL:(NSURL*)baseURL NS_AVAILABLE(10_11,9_0);  
30.    
31. // 前进或者后退到某一页面  
32. -(nullable WKNavigation*)goToBackForwardListItem:(WKBackForwardListItem*)item;  
33.    
34. // 页面的标题，这昆支持KVO的  
35. @property (nullable, nonatomic, readonly, copy)NSString *title;  
36.    
37. // 当前请求的URL，它是支持KVO的  
38. @property(nullable,nonatomic, readonly, copy)NSURL *URL;  
39.    
40. // 标识当前是否正在加载内容中，它是支持KVO的  
41. @property (nonatomic,readonly, getter=isLoading)BOOL loading;  
42.    
43. // 当前加载的进度，范围为[0, 1]  
44. @property(nonatomic,readonly) double estimatedProgress;  
45.    
46. // 标识页面中的所有资源是否通过安全加密连接来加载，它是支持KVO的  
47. @property (nonatomic,readonly) BOOL hasOnlySecureContent;  
48.    
49. // 当前导航的证书链，支持KVO  
50. @property(nonatomic,readonly, copy) NSArray*certificateChain NS_AVAILABLE(10_11,9_0);  
51.    
52. // 是否可以招待goback操作，它是支持KVO的  
53. @property (nonatomic,readonly) BOOL canGoBack;  
54.    
55. // 是否可以执行gofarward操作，支持KVO  
56. @property(nonatomic,readonly) BOOL canGoForward;  
57.    
58. // 返回上一页面，如果不能返回，则什么也不干  
59. - (nullableWKNavigation *)goBack;  
60.    
61. // 进入下一页面，如果不能前进，则什么也不干  
62. -(nullable WKNavigation*)goForward;  
63.    
64. // 重新载入页面  
65. - (nullableWKNavigation *)reload;  
66.    
67. // 重新从原始URL载入  
68. -(nullable WKNavigation*)reloadFromOrigin;  
69.    
70. // 停止加载数据  
71. - (void)stopLoading;  
72.    
73. // 执行JS代码  
74. -(void)evaluateJavaScript:(NSString*)javaScriptString completionHandler:(void(^ __nullable)(__nullableid, NSError * __nullable error))completionHandler;  
75.    
76. // 标识是否支持左、右swipe手势是否可以前进、后退  
77. @property (nonatomic)BOOL allowsBackForwardNavigationGestures;  
78.    
79. // 自定义user agent，如果没有则为nil  
80. @property(nullable,nonatomic, copy) NSString*customUserAgent NS_AVAILABLE(10_11,9_0);  
81.    
82. // 在iOS上默认为NO，标识不允许链接预览  
83. @property (nonatomic)BOOL allowsLinkPreviewNS_AVAILABLE(10_11,9_0);  
84.    
85. #if TARGET_OS_IPHONE  
86. /*! @abstract The scroll view associated with the web view. 
87. */  
88. @property(nonatomic,readonly, strong) UIScrollView*scrollView;  
89. #endif  
90.    
91. #if !TARGET_OS_IPHONE  
92. // 标识是否支持放大手势，默认为NO  
93. @property (nonatomic)BOOL allowsMagnification;  
94.    
95. // 放大因子，默认为1  
96. @property(nonatomic)CGFloat magnification;  
97.    
98. // 根据设置的缩放因子来缩放页面，并居中显示结果在指定的点  
99. - (void)setMagnification:(CGFloat)magnification centeredAtPoint:(CGPoint)point;  
100.    
101. #endif  

WKWebViewConfiguration配置

 

WKWebViewConfiguration *config = [[WKWebViewConfigurationalloc] init];

WKPreferences偏好设置

目前在iOS平台上偏好设置只有三个属性可以设置，如下：

[objc] view plain copy

1. / 设置偏好设置  
2. config.preferences=[[WKPreferencesalloc] init];  
3. // 默认为0  
4. config.preferences.minimumFontSize=10;  
5. // 默认认为YES  
6. config.preferences.javaScriptEnabled=YES;  
7. // 在iOS上默认为NO，表示不能自动通过窗口打开  
8. config.preferences.javaScriptCanOpenWindowsAutomatically=NO;  

WKProcessPool内容处理池

WKProcessPool并没有公开任何的属性或者方法，不需要配置：

config.processPool=[[WKProcessPoolalloc] init];

其实我们也没有必须去创建它。

WKUserContentController内容交互控制器

我们要通过JS与webview内容交互，就需要到这个类了，它的所有属性及方法说明如下：

[objc] view plain copy

1. // 只读属性，所有添加的WKUserScript都在这里可以获取到  
2. @property(nonatomic,readonly,copy) NSArray<WKUserScript*>*userScripts;  
3.    
4. // 注入JS  
5. - (void)addUserScript:(WKUserScript*)userScript;  
6.    
7. // 移除所有注入的JS  
8. -(void)removeAllUserScripts;  
9.    
10. // 添加scriptMessageHandler到所有的frames中，则都可以通过  
11. // window.webkit.messageHandlers.<name>.postMessage(<messageBody>)  
12. // 发送消息  
13. // 比如，JS要调用我们原生的方法，就可以通过这种方式了  
14. -(void)addScriptMessageHandler:(id<WKScriptMessageHandler>)scriptMessageHandler name:(NSString*)name;  
15.    
16. // 根据name移除所注入的scriptMessageHandler  
17. - (void)removeScriptMessageHandlerForName:(NSString*)name;  

WKUserScript

在WKUserContentController中，所有使用到WKUserScript。WKUserContentController是用于与JS交互的类，而所注入的JS是WKUserScript对象。它的所有属性和方法如下：

[objc] view plain copy

1. // JS源代码  
2. @property(nonatomic,readonly,copy) NSString*source;  
3.    
4. // JS注入时间  
5. @property (nonatomic,readonly)WKUserScriptInjectionTime injectionTime;  
6.    
7. // 只读属性，表示JS是否应该注入到所有的frames中还是只有main frame.  
8. @property(nonatomic,readonly,getter=isForMainFrameOnly)BOOLforMainFrameOnly;  
9.    
10. // 初始化方法，用于创建WKUserScript对象  
11. // source：JS源代码  
12. // injectionTime：JS注入的时间  
13. // forMainFrameOnly：是否只注入main frame  
14. -(instancetype)initWithSource:(NSString*)source injectionTime:(WKUserScriptInjectionTime)injectionTime forMainFrameOnly:(BOOL)forMainFrameOnly;  

WKUserScriptInjectionTime 

[objc] view plain copy

1. typedef NS_ENUM(NSInteger,WKUserScriptInjectionTime){  
2.     WKUserScriptInjectionTimeAtDocumentStart,  
3.     WKUserScriptInjectionTimeAtDocumentEnd  
4. }NS_ENUM_AVAILABLE(10_10,8_0);  

它是一个枚举类型，只有在文档开始加载时注入和加载结束时注入。

WKWebsiteDataStore存储的Web内容

iOS9.0以后才能使用这个类。它是代表webview不同的数据类型，包括cookies、disk、memory caches、WebSQL、IndexedDB数据库和本地存储。

从这里看，要优化Webview好像可以通过它来实现，不过要求iOS9.0以上才能使用。现在6.0都没有抛弃的我，从来不能考虑这种最新的。

[objc] view plain copy

1. // 默认数据存储  
2. +(WKWebsiteDataStore*)defaultDataStore;  
3.    
4. // 返回非持久化存储，数据不会写入文件系统  
5. + (WKWebsiteDataStore*)nonPersistentDataStore;  
6.    
7. // 已经不可用  
8. -(instancetype)initNS_UNAVAILABLE;  
9.    
10. // 只读属性，表示是否是持久化存储  
11. @property (nonatomic,readonly,getter=isPersistent)BOOLpersistent;  
12.    
13. // 获取所有web内容的数据存储类型集，比如cookies、disk等  
14. +(NSSet<NSString*>*)allWebsiteDataTypes;  
15.    
16. // 获取某些指定数据存储类型的数据  
17. - (void)fetchDataRecordsOfTypes:(NSSet<NSString*>*)dataTypes completionHandler:(void(^)(NSArray<WKWebsiteDataRecord*>*))completionHandler;  
18.    
19. // 删除某些指定类型的数据  
20. -(void)removeDataOfTypes:(NSSet<NSString*>*)dataTypes forDataRecords:(NSArray<WKWebsiteDataRecord*>*)dataRecords completionHandler:(void(^)(void))completionHandler;  
21.    
22. // 删除某些指定类型的数据且修改日期是指定的日期  
23. - (void)removeDataOfTypes:(NSSet<NSString*>*)websiteDataTypes modifiedSince:(NSDate*)date completionHandler:(void(^)(void))completionHandler;  

所有的dataTypes是下面这些系统所定义的：

 

[objc] view plain copy

1. WK_EXTERN NSString*constWKWebsiteDataTypeDiskCacheNS_AVAILABLE(10_11,9_0);  
2.    
3. WK_EXTERN NSString*constWKWebsiteDataTypeMemoryCacheNS_AVAILABLE(10_11,9_0);  
4.    
5. WK_EXTERN NSString*constWKWebsiteDataTypeOfflineWebApplicationCacheNS_AVAILABLE(10_11,9_0);  
6.    
7. WK_EXTERN NSString*constWKWebsiteDataTypeCookiesNS_AVAILABLE(10_11,9_0);  
8.    
9. WK_EXTERN NSString*constWKWebsiteDataTypeSessionStorageNS_AVAILABLE(10_11,9_0);  
10.    
11. WK_EXTERN NSString*constWKWebsiteDataTypeLocalStorageNS_AVAILABLE(10_11,9_0);  
12.    
13. WK_EXTERN NSString*constWKWebsiteDataTypeWebSQLDatabasesNS_AVAILABLE(10_11,9_0);  
14.    
15. WK_EXTERN NSString*constWKWebsiteDataTypeIndexedDBDatabasesNS_AVAILABLE(10_11,9_0);  

WKWebsiteDataRecord

iOS9.0以后才可用。

website的数据存储记录类型，它只有两个属性：

[objc] view plain copy

1. // 通常是域名  
2. @property(nonatomic,readonly,copy) NSString*displayName;  
3.    
4. // 存储的数据类型集  
5. @property (nonatomic,readonly,copy) NSSet<NSString*>*dataTypes;  

WKSelectionGranularity选择粒度

它表示在webview上选择内容的粒度，只有下面这两种类型：

 

1

2

3

4

5

6

 

typedef NS_ENUM(NSInteger,WKSelectionGranularity){

    WKSelectionGranularityDynamic,

    WKSelectionGranularityCharacter,

}NS_ENUM_AVAILABLE_IOS(8_0);

 

它是用于webview内容交互时选择内容的粒度类型设置。比如说，当使用WKSelectionGranularityDynamic时，而所选择的内容是单个块，这时候granularity可能会是单个字符；当所选择的web内容不限制于某个块时，granularity可能会是单个块。

 

WKNavigationDelegate

[objc] view plain copy

1. @protocol WKNavigationDelegate<NSObject>  
2.   
3. @optional  
4. 1.导航监听  
5.   
6. #pragma mark - WKNavigationDelegate 页面跳转  
7. #pragma mark 在发送请求之前，决定是否跳转  
8. - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler;  
9.   
10. #pragma mark 身份验证  
11. - (void)webView:(WKWebView *)webView didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential *__nullable credential))completionHandler;  
12.   
13. #pragma mark 在收到响应后，决定是否跳转  
14. - (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler;  
15.   
16. #pragma mark 接收到服务器跳转请求之后调用  
17. - (void)webView:(WKWebView *)webView didReceiveServerRedirectForProvisionalNavigation:(null_unspecified WKNavigation *)navigation;  
18.   
19. #pragma mark WKNavigation导航错误  
20. - (void)webView:(WKWebView *)webView didFailNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error;  
21.   
22. #pragma mark WKWebView终止  
23. - (void)webViewWebContentProcessDidTerminate:(WKWebView *)webView;  
24.   
25. 2.页面监听  
26.   
27. #pragma mark - WKNavigationDelegate 页面加载  
28. #pragma mark 页面开始加载时调用  
29. - (void)webView:(WKWebView *)webView didStartProvisionalNavigation:(null_unspecified WKNavigation *)navigation;  
30.   
31. #pragma mark 当内容开始返回时调用  
32. - (void)webView:(WKWebView *)webView didCommitNavigation:(null_unspecified WKNavigation *)navigation;  
33.   
34. #pragma mark 页面加载完成之后调用  
35. - (void)webView:(WKWebView *)webView didFinishNavigation:(null_unspecified WKNavigation *)navigation;  
36.   
37. #pragma mark 页面加载失败时调用  
38. - (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error;  
39.   
40. @end  

WKNavigationActionPolicy

导航动作决定策略：

[objc] view plain copy

1. typedef NS_ENUM(NSInteger,WKNavigationActionPolicy){  
2.     WKNavigationActionPolicyCancel,  
3.     WKNavigationActionPolicyAllow,  
4. }NS_ENUM_AVAILABLE(10_10,8_0);  

它是枚举类型，只有Cancel和Allow这两种。设置为Cancel就是不允许导航，就不会跳转链接。

WKNavigationResponsePolicy

[objc] view plain copy

1. typedef NS_ENUM(NSInteger,WKNavigationResponsePolicy){  
2.     WKNavigationResponsePolicyCancel,  
3.     WKNavigationResponsePolicyAllow,  
4. }NS_ENUM_AVAILABLE(10_10,8_0);  

WKNavigationResponse

WKNavigationResponse是导航响应类，通过它可以获取相关响应的信息：

[objc] view plain copy

1. NS_CLASS_AVAILABLE(10_10,8_0)  
2. @interface WKNavigationResponse: NSObject  
3.    
4. // 是否是main frame  
5. @property (nonatomic,readonly,getter=isForMainFrame)BOOLforMainFrame;  
6.    
7. // 获取响应response  
8. @property(nonatomic,readonly,copy) NSURLResponse*response;  
9.    
10. // 是否显示MIMEType  
11. @property (nonatomic,readonly)BOOL canShowMIMEType;  
12.    
13. @end  

只有接收响应与不接收响应两种。

WKNavigationAction

WKNavigationAction对象包含关于导航的action的信息，用于make policy decisions。它只有以下几个属性：

[objc] view plain copy

1. // 正在请求的导航的frame  
2. @property(nonatomic,readonly,copy) WKFrameInfo*sourceFrame;  
3.    
4. // 目标frame，如果这是新的window，它会是nil  
5. @property (nullable, nonatomic, readonly, copy)WKFrameInfo*targetFrame;  
6.    
7. // 导航类型，如下面的小标题WKNavigationType  
8. @property(nonatomic,readonly)WKNavigationType navigationType;  
9.    
10. // 导航的请求  
11. @property (nonatomic,readonly,copy) NSURLRequest*request;  

WKNavigationType

WKNavigationType类型是枚举类型，它的可选值如下:

[objc] view plain copy

1. typedef NS_ENUM(NSInteger,WKNavigationType){  
2. // 链接已经点击  
3.     WKNavigationTypeLinkActivated,  
4.     // 表单提交  
5.     WKNavigationTypeFormSubmitted,  
6.     // 前进、后退  
7.     WKNavigationTypeBackForward,  
8.     // 重新载入  
9.     WKNavigationTypeReload,  
10.     // 表单重新提交  
11.     WKNavigationTypeFormResubmitted,  
12.     // 其它  
13.     WKNavigationTypeOther=-1,  
14. }NS_ENUM_AVAILABLE(10_10,8_0);  

WKUIDelegate

[objc] view plain copy

1. @protocol WKUIDelegate<NSObject>  
2.    
3. @optional  
4.    
5. // 创建新的webview  
6. // 可以指定配置对象、导航动作对象、window特性  
7. - (nullableWKWebView*)webView:(WKWebView*)webView createWebViewWithConfiguration:(WKWebViewConfiguration*)configuration forNavigationAction:(WKNavigationAction*)navigationAction windowFeatures:(WKWindowFeatures*)windowFeatures;  
8.    
9. // webview关闭时回调  
10. -(void)webViewDidClose:(WKWebView*)webViewNS_AVAILABLE(10_11,9_0);  
11.    
12. // 调用JS的alert()方法  
13. - (void)webView:(WKWebView*)webView runJavaScriptAlertPanelWithMessage:(NSString*)message initiatedByFrame:(WKFrameInfo*)frame completionHandler:(void(^)(void))completionHandler;  
14.    
15. // 调用JS的confirm()方法  
16. -(void)webView:(WKWebView*)webView runJavaScriptConfirmPanelWithMessage:(NSString*)message initiatedByFrame:(WKFrameInfo*)frame completionHandler:(void(^)(BOOLresult))completionHandler;  
17.    
18. // 调用JS的prompt()方法  
19. - (void)webView:(WKWebView*)webView runJavaScriptTextInputPanelWithPrompt:(NSString*)prompt defaultText:(nullableNSString*)defaultText initiatedByFrame:(WKFrameInfo*)frame completionHandler:(void(^)(NSString*__nullableresult))completionHandler;  
20.    
21. @end  

WKBackForwardList

WKBackForwardList表示webview中可以前进或者后退的页面列表。其声明如下：

[objc] view plain copy

1. NS_CLASS_AVAILABLE(10_10,8_0)  
2. @interface WKBackForwardList: NSObject  
3.    
4. // 当前正在显示的item（页面）  
5. @property (nullable, nonatomic, readonly, strong)WKBackForwardListItem*currentItem;  
6.    
7. // 后一页，如果没有就是nil  
8. @property(nullable,nonatomic,readonly, strong)WKBackForwardListItem*backItem;  
9.    
10. // 前一页，如果没有就是nil  
11. @property (nullable, nonatomic, readonly, strong)WKBackForwardListItem*forwardItem;  
12.    
13. // 根据下标获取某一个页面的item  
14. -(nullableWKBackForwardListItem*)itemAtIndex:(NSInteger)index;  
15.    
16. // 可以进行goback操作的页面列表  
17. @property (nonatomic,readonly,copy) NSArray<WKBackForwardListItem*>*backList;  
18.    
19. // 可以进行goforward操作的页面列表  
20. @property(nonatomic,readonly,copy) NSArray<WKBackForwardListItem*>*forwardList;  
21.    
22. @end  

WKBackForwardListItem

页面导航前进、后退列表项： 

[objc] view plain copy

1. NS_CLASS_AVAILABLE(10_10,8_0)  
2. @interface WKBackForwardListItem: NSObject  
3.    
4. // 该页面的URL  
5. @property (readonly, copy) NSURL*URL;  
6.    
7. // 该页面的title  
8. @property(nullable,readonly,copy) NSString*title;  
9.    
10. // 初始请求该item的请求的URL  
11. @property (readonly, copy) NSURL*initialURL;  
12.    
13. @end  

最后

本篇文章只是讲解了WKWebView所有相关的类的API，先阅读过本篇文章，再继续往下阅读实战篇文章！