WKWebView API精講(OC)

WKWebView

看看WKWebView的頭文件聲明：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103

// webview 配置，具體看下面 @property (nonatomic, readonly, copy) WKWebViewConfiguration *configuration;   // 導航代理 @property (nullable, nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;   // 用戶交互代理 @property (nullable, nonatomic, weak) id <WKUIDelegate> UIDelegate;   // 頁面前進、後退列表 @property (nonatomic, readonly, strong) WKBackForwardList *backForwardList;   // 默認構造器 - (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configurationNS_DESIGNATED_INITIALIZER;   // 已不再使用 - (instancetype)initWithCoder:(NSCoder *)coder NS_UNAVAILABLE;   // 與UIWebView一樣的加載請求API - (nullable WKNavigation *)loadRequest:(NSURLRequest *)request;   // 加載URL - (nullable WKNavigation *)loadFileURL:(NSURL *)URL allowingReadAccessToURL:(NSURL *)readAccessURLNS_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;   // 頁面的標題，這昆支持KVO的 @property (nullable, nonatomic, readonly, copy) NSString *title;   // 當前請求的URL，它是支持KVO的 @property (nullable, nonatomic, readonly, copy) NSURL *URL;   // 標識當前是否正在加載內容中，它是支持KVO的 @property (nonatomic, readonly, getter=isLoading) BOOL loading;   // 當前加載的進度，範圍爲[0, 1] @property (nonatomic, readonly) double estimatedProgress;   // 標識頁面中的所有資源是否通過安全加密連接來加載，它是支持KVO的 @property (nonatomic, readonly) BOOL hasOnlySecureContent;   // 當前導航的證書鏈，支持KVO @property (nonatomic, readonly, copy) NSArray *certificateChain NS_AVAILABLE(10_11, 9_0);   // 是否可以招待goback操作，它是支持KVO的 @property (nonatomic, readonly) BOOL canGoBack;   // 是否可以執行gofarward操作，支持KVO @property (nonatomic, readonly) BOOL canGoForward;   // 返回上一頁面，如果不能返回，則什麼也不幹 - (nullable WKNavigation *)goBack;   // 進入下一頁面，如果不能前進，則什麼也不幹 - (nullable WKNavigation *)goForward;   // 重新載入頁面 - (nullable WKNavigation *)reload;   // 重新從原始URL載入 - (nullable WKNavigation *)reloadFromOrigin;   // 停止加載數據 - (void)stopLoading;   // 執行JS代碼 - (void)evaluateJavaScript:(NSString *)javaScriptString completionHandler:(void (^ __nullable)(__nullable id,NSError * __nullable error))completionHandler;   // 標識是否支持左、右swipe手勢是否可以前進、後退 @property (nonatomic) BOOL allowsBackForwardNavigationGestures;   // 自定義user agent，如果沒有則爲nil @property (nullable, nonatomic, copy) NSString *customUserAgent NS_AVAILABLE(10_11, 9_0);   // 在iOS上默認爲NO，標識不允許鏈接預覽 @property (nonatomic) BOOL allowsLinkPreview NS_AVAILABLE(10_11, 9_0);   #if TARGET_OS_IPHONE /*! @abstract The scroll view associated with the web view. */ @property (nonatomic, readonly, strong) UIScrollView *scrollView; #endif   #if !TARGET_OS_IPHONE // 標識是否支持放大手勢，默認爲NO @property (nonatomic) BOOL allowsMagnification;   // 放大因子，默認爲1 @property (nonatomic) CGFloat magnification;   // 根據設置的縮放因子來縮放頁面，並居中顯示結果在指定的點 - (void)setMagnification:(CGFloat)magnification centeredAtPoint:(CGPoint)point;   #endif

WKWebViewConfiguration配置

1 2 3

WKWebViewConfiguration *config = [[WKWebViewConfiguration alloc] init];

WKPreferences偏好設置

目前在iOS平臺上偏好設置只有三個屬性可以設置，如下：

1 2 3 4 5 6 7 8 9 10

// 設置偏好設置 config.preferences = [[WKPreferences alloc] init]; // 默認爲0 config.preferences.minimumFontSize = 10; // 默認認爲YES config.preferences.javaScriptEnabled = YES; // 在iOS上默認爲NO，表示不能自動通過窗口打開 config.preferences.javaScriptCanOpenWindowsAutomatically = NO;

WKProcessPool內容處理池

WKProcessPool並沒有公開任何的屬性或者方法，不需要配置：

1 2 3

config.processPool = [[WKProcessPool alloc] init];

其實我們也沒有必須去創建它。

WKUserContentController內容交互控制器

我們要通過JS與webview內容交互，就需要到這個類了，它的所有屬性及方法說明如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

// 只讀屬性，所有添加的WKUserScript都在這裏可以獲取到 @property (nonatomic, readonly, copy) NSArray<WKUserScript *> *userScripts;   // 注入JS - (void)addUserScript:(WKUserScript *)userScript;   // 移除所有注入的JS - (void)removeAllUserScripts;   // 添加scriptMessageHandler到所有的frames中，則都可以通過 // window.webkit.messageHandlers.<name>.postMessage(<messageBody>) // 發送消息 // 比如，JS要調用我們原生的方法，就可以通過這種方式了 - (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;   // 根據name移除所注入的scriptMessageHandler - (void)removeScriptMessageHandlerForName:(NSString *)name;

WKUserScript

在WKUserContentController中，所有使用到WKUserScript。WKUserContentController是用於與JS交互的類，而所注入的JS是WKUserScript對象。它的所有屬性和方法如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

// JS源代碼 @property (nonatomic, readonly, copy) NSString *source;   // JS注入時間 @property (nonatomic, readonly) WKUserScriptInjectionTime injectionTime;   // 只讀屬性，表示JS是否應該注入到所有的frames中還是隻有main frame. @property (nonatomic, readonly, getter=isForMainFrameOnly) BOOL forMainFrameOnly;   // 初始化方法，用於創建WKUserScript對象 // source：JS源代碼 // injectionTime：JS注入的時間 // forMainFrameOnly：是否只注入main frame - (instancetype)initWithSource:(NSString *)source injectionTime:(WKUserScriptInjectionTime)injectionTimeforMainFrameOnly:(BOOL)forMainFrameOnly;

WKUserScriptInjectionTime

1 2 3 4 5 6

typedef NS_ENUM(NSInteger, WKUserScriptInjectionTime) {     WKUserScriptInjectionTimeAtDocumentStart,     WKUserScriptInjectionTimeAtDocumentEnd } NS_ENUM_AVAILABLE(10_10, 8_0);

它是一個枚舉類型，只有在文檔開始加載時注入和加載結束時注入。

WKWebsiteDataStore存儲的Web內容

iOS9.0以後才能使用這個類。它是代表webview不同的數據類型，包括cookies、disk、memory caches、WebSQL、IndexedDB數據庫和本地存儲。

從這裏看，要優化Webview好像可以通過它來實現，不過要求iOS9.0以上才能使用。現在6.0都沒有拋棄的我，從來不能考慮這種最新的。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

// 默認數據存儲 + (WKWebsiteDataStore *)defaultDataStore;   // 返回非持久化存儲，數據不會寫入文件系統 + (WKWebsiteDataStore *)nonPersistentDataStore;   // 已經不可用 - (instancetype)init NS_UNAVAILABLE;   // 只讀屬性，表示是否是持久化存儲 @property (nonatomic, readonly, getter=isPersistent) BOOL persistent;   // 獲取所有web內容的數據存儲類型集，比如cookies、disk等 + (NSSet<NSString *> *)allWebsiteDataTypes;   // 獲取某些指定數據存儲類型的數據 - (void)fetchDataRecordsOfTypes:(NSSet<NSString *> *)dataTypes completionHandler:(void (^)(NSArray<WKWebsiteDataRecord *> *))completionHandler;   // 刪除某些指定類型的數據 - (void)removeDataOfTypes:(NSSet<NSString *> *)dataTypes forDataRecords:(NSArray<WKWebsiteDataRecord *>*)dataRecords completionHandler:(void (^)(void))completionHandler;   // 刪除某些指定類型的數據且修改日期是指定的日期 - (void)removeDataOfTypes:(NSSet<NSString *> *)websiteDataTypes modifiedSince:(NSDate *)datecompletionHandler:(void (^)(void))completionHandler;

所有的dataTypes是下面這些系統所定義的：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

WK_EXTERN NSString * const WKWebsiteDataTypeDiskCache NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeMemoryCache NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeOfflineWebApplicationCache NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeCookies NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeSessionStorage NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeLocalStorage NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeWebSQLDatabases NS_AVAILABLE(10_11, 9_0);   WK_EXTERN NSString * const WKWebsiteDataTypeIndexedDBDatabases NS_AVAILABLE(10_11, 9_0);

WKWebsiteDataRecord

iOS9.0以後纔可用。

website的數據存儲記錄類型，它只有兩個屬性：

1 2 3 4 5 6 7

// 通常是域名 @property (nonatomic, readonly, copy) NSString *displayName;   // 存儲的數據類型集 @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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

@protocol WKNavigationDelegate <NSObject>   @optional   // 決定導航的動作，通常用於處理跨域的鏈接能否導航。WebKit對跨域進行了安全檢查限制，不允許跨域，因此我們要對不能跨域的鏈接 // 單獨處理。但是，對於Safari是允許跨域的，不用這麼處理。 // 這個是決定是否Request - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationActiondecisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler;   // 決定是否接收響應 // 這個是決定是否接收response // 要獲取response，通過WKNavigationResponse對象獲取 - (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse*)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler;   // 當main frame的導航開始請求時，會調用此方法 - (void)webView:(WKWebView *)webView didStartProvisionalNavigation:(null_unspecified WKNavigation*)navigation;   // 當main frame接收到服務重定向時，會回調此方法 - (void)webView:(WKWebView *)webView didReceiveServerRedirectForProvisionalNavigation:(null_unspecifiedWKNavigation *)navigation;   // 當main frame開始加載數據失敗時，會回調 - (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(null_unspecified WKNavigation *)navigationwithError:(NSError *)error;   // 當main frame的web內容開始到達時，會回調 - (void)webView:(WKWebView *)webView didCommitNavigation:(null_unspecified WKNavigation *)navigation;   // 當main frame導航完成時，會回調 - (void)webView:(WKWebView *)webView didFinishNavigation:(null_unspecified WKNavigation *)navigation;   // 當main frame最後下載數據失敗時，會回調 - (void)webView:(WKWebView *)webView didFailNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error;   // 這與用於授權驗證的API，與AFN、UIWebView的授權驗證API是一樣的 - (void)webView:(WKWebView *)webView didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge*)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential*__nullable credential))completionHandler;   // 當web content處理完成時，會回調 - (void)webViewWebContentProcessDidTerminate:(WKWebView *)webView NS_AVAILABLE(10_11, 9_0);   @end

WKNavigationActionPolicy

導航動作決定策略：

1 2 3 4 5 6

typedef NS_ENUM(NSInteger, WKNavigationActionPolicy) {     WKNavigationActionPolicyCancel,     WKNavigationActionPolicyAllow, } NS_ENUM_AVAILABLE(10_10, 8_0);

它是枚舉類型，只有Cancel和Allow這兩種。設置爲Cancel就是不允許導航，就不會跳轉鏈接。

WKNavigationResponsePolicy

1 2 3 4 5 6

typedef NS_ENUM(NSInteger, WKNavigationResponsePolicy) {     WKNavigationResponsePolicyCancel,     WKNavigationResponsePolicyAllow, } NS_ENUM_AVAILABLE(10_10, 8_0);

WKNavigationResponse

WKNavigationResponse是導航響應類，通過它可以獲取相關響應的信息：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

NS_CLASS_AVAILABLE(10_10, 8_0) @interface WKNavigationResponse : NSObject   // 是否是main frame @property (nonatomic, readonly, getter=isForMainFrame) BOOL forMainFrame;   // 獲取響應response @property (nonatomic, readonly, copy) NSURLResponse *response;   // 是否顯示MIMEType @property (nonatomic, readonly) BOOL canShowMIMEType;   @end

只有接收響應與不接收響應兩種。

WKNavigationAction

WKNavigationAction對象包含關於導航的action的信息，用於make policy decisions。它只有以下幾個屬性：

1 2 3 4 5 6 7 8 9 10 11 12 13

// 正在請求的導航的frame @property (nonatomic, readonly, copy) WKFrameInfo *sourceFrame;   // 目標frame，如果這是新的window，它會是nil @property (nullable, nonatomic, readonly, copy) WKFrameInfo *targetFrame;   // 導航類型，如下面的小標題WKNavigationType @property (nonatomic, readonly) WKNavigationType navigationType;   // 導航的請求 @property (nonatomic, readonly, copy) NSURLRequest *request;

WKNavigationType

WKNavigationType類型是枚舉類型，它的可選值如下:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

typedef NS_ENUM(NSInteger, WKNavigationType) { // 鏈接已經點擊     WKNavigationTypeLinkActivated,     // 表單提交     WKNavigationTypeFormSubmitted,     // 前進、後退     WKNavigationTypeBackForward,     // 重新載入     WKNavigationTypeReload,     // 表單重新提交     WKNavigationTypeFormResubmitted,     // 其它     WKNavigationTypeOther = -1, } NS_ENUM_AVAILABLE(10_10, 8_0);

WKUIDelegate

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

@protocol WKUIDelegate <NSObject>   @optional   // 創建新的webview // 可以指定配置對象、導航動作對象、window特性 - (nullable WKWebView *)webView:(WKWebView *)webView createWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationActionwindowFeatures:(WKWindowFeatures *)windowFeatures;   // webview關閉時回調 - (void)webViewDidClose:(WKWebView *)webView NS_AVAILABLE(10_11, 9_0);   // 調用JS的alert()方法 - (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)messageinitiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(void))completionHandler;   // 調用JS的confirm()方法 - (void)webView:(WKWebView *)webView runJavaScriptConfirmPanelWithMessage:(NSString *)messageinitiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(BOOL result))completionHandler;   // 調用JS的prompt()方法 - (void)webView:(WKWebView *)webView runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(nullable NSString *)defaultText initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(NSString *__nullable result))completionHandler;   @end

WKBackForwardList

WKBackForwardList表示webview中可以前進或者後退的頁面列表。其聲明如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

NS_CLASS_AVAILABLE(10_10, 8_0) @interface WKBackForwardList : NSObject   // 當前正在顯示的item（頁面） @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *currentItem;   // 後一頁，如果沒有就是nil @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *backItem;   // 前一頁，如果沒有就是nil @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *forwardItem;   // 根據下標獲取某一個頁面的item - (nullable WKBackForwardListItem *)itemAtIndex:(NSInteger)index;   // 可以進行goback操作的頁面列表 @property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *backList;   // 可以進行goforward操作的頁面列表 @property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *forwardList;   @end

WKBackForwardListItem

頁面導航前進、後退列表項：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

NS_CLASS_AVAILABLE(10_10, 8_0) @interface WKBackForwardListItem : NSObject   // 該頁面的URL @property (readonly, copy) NSURL *URL;   // 該頁面的title @property (nullable, readonly, copy) NSString *title;   // 初始請求該item的請求的URL @property (readonly, copy) NSURL *initialURL;   @end

最後

本篇文章只是講解了WKWebView所有相關的類的API，先閱讀過本篇文章，再繼續往下閱讀實戰篇文章！

關注下一篇：WKWebView與H5交互實戰

原文:https://yq.aliyun.com/articles/37072