WKWebView API介紹
WKWebView的頭文件聲明
// webview 配置阴挣,具體看下面
@property (nonatomic, readonly, copy) WKWebViewConfiguration *configuration;
// 導(dǎo)航代理
@property (nullable, nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;
// 用戶交互代理
@property (nullable, nonatomic, weak) id <WKUIDelegate> UIDelegate;
// 頁面前進(jìn)押桃、后退列表
@property (nonatomic, readonly, strong) WKBackForwardList *backForwardList;
// 默認(rèn)構(gòu)造器
- (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configuration NS_DESIGNATED_INITIALIZER;
// 已不再使用
- (instancetype)initWithCoder:(NSCoder *)coder NS_UNAVAILABLE;
// 與UIWebView一樣的加載請求API
- (nullable WKNavigation *)loadRequest:(NSURLRequest *)request;
// 加載URL
- (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);
// 前進(jìn)或者后退到某一頁面
- (nullable WKNavigation *)goToBackForwardListItem:(WKBackForwardListItem *)item;
// 頁面的標(biāo)題戳葵,這昆支持KVO的
@property (nullable, nonatomic, readonly, copy) NSString *title;
// 當(dāng)前請求的URL司蔬,它是支持KVO的
@property (nullable, nonatomic, readonly, copy) NSURL *URL;
// 標(biāo)識當(dāng)前是否正在加載內(nèi)容中闰非,它是支持KVO的
@property (nonatomic, readonly, getter=isLoading) BOOL loading;
// 當(dāng)前加載的進(jìn)度鹅颊,范圍為[0, 1]
@property (nonatomic, readonly) double estimatedProgress;
// 標(biāo)識頁面中的所有資源是否通過安全加密連接來加載纵竖,它是支持KVO的
@property (nonatomic, readonly) BOOL hasOnlySecureContent;
// 當(dāng)前導(dǎo)航的證書鏈彩匕,支持KVO
@property (nonatomic, readonly, copy) NSArray *certificateChain NS_AVAILABLE(10_11, 9_0);
// 是否可以招待goback操作腔剂,它是支持KVO的
@property (nonatomic, readonly) BOOL canGoBack;
// 是否可以執(zhí)行g(shù)ofarward操作,支持KVO
@property (nonatomic, readonly) BOOL canGoForward;
// 返回上一頁面驼仪,如果不能返回掸犬,則什么也不干
- (nullable WKNavigation *)goBack;
// 進(jìn)入下一頁面,如果不能前進(jìn)绪爸,則什么也不干
- (nullable WKNavigation *)goForward;
// 重新載入頁面
- (nullable WKNavigation *)reload;
// 重新從原始URL載入
- (nullable WKNavigation *)reloadFromOrigin;
// 停止加載數(shù)據(jù)
- (void)stopLoading;
// 執(zhí)行JS代碼
- (void)evaluateJavaScript:(NSString *)javaScriptString completionHandler:(void (^ __nullable)(__nullable id, NSError * __nullable error))completionHandler;
// 標(biāo)識是否支持左湾碎、右swipe手勢是否可以前進(jìn)、后退
@property (nonatomic) BOOL allowsBackForwardNavigationGestures;
// 自定義user agent奠货,如果沒有則為nil
@property (nullable, nonatomic, copy) NSString *customUserAgent NS_AVAILABLE(10_11, 9_0);
// 在iOS上默認(rèn)為NO介褥,標(biāo)識不允許鏈接預(yù)覽
@property (nonatomic) BOOL allowsLinkPreview NS_AVAILABLE(10_11, 9_0);
WKWebViewConfiguration配置
WKWebViewConfiguration *config = [[WKWebViewConfiguration alloc] init];
WKPreferences偏好設(shè)置
// 設(shè)置偏好設(shè)置
config.preferences = [[WKPreferences alloc] init];
// 默認(rèn)為0
config.preferences.minimumFontSize = 10;
// 默認(rèn)認(rèn)為YES
config.preferences.javaScriptEnabled = YES;
// 在iOS上默認(rèn)為NO,表示不能自動通過窗口打開
config.preferences.javaScriptCanOpenWindowsAutomatically = NO;
WKProcessPool內(nèi)容處理池
WKProcessPool并沒有公開任何的屬性或者方法递惋,不需要配置:
config.processPool = [[WKProcessPool alloc] init];
WKUserContentController內(nèi)容交互控制器
我們要通過JS與webview內(nèi)容交互柔滔,就需要到這個類了,它的所有屬性及方法說明如下:
// 只讀屬性萍虽,所有添加的WKUserScript都在這里可以獲取到
@property (nonatomic, readonly, copy) NSArray<WKUserScript *> *userScripts;
// 注入JS
- (void)addUserScript:(WKUserScript *)userScript;
// 移除所有注入的JS
- (void)removeAllUserScripts;
// 添加scriptMessageHandler到所有的frames中睛廊,則都可以通過
// window.webkit.messageHandlers.<name>.postMessage(<messageBody>)
// 發(fā)送消息
// 比如,JS要調(diào)用我們原生的方法杉编,就可以通過這種方式了
- (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;
// 根據(jù)name移除所注入的scriptMessageHandler
- (void)removeScriptMessageHandlerForName:(NSString *)name;
WKUserScript
在WKUserContentController中超全,所有使用到WKUserScript。WKUserContentController是用于與JS交互的類邓馒,而所注入的JS是WKUserScript對象嘶朱。它的所有屬性和方法如下:
// JS源代碼
@property (nonatomic, readonly, copy) NSString *source;
// JS注入時間
@property (nonatomic, readonly) WKUserScriptInjectionTime injectionTime;
// 只讀屬性,表示JS是否應(yīng)該注入到所有的frames中還是只有main frame.
@property (nonatomic, readonly, getter=isForMainFrameOnly) BOOL forMainFrameOnly;
// 初始化方法绒净,用于創(chuàng)建WKUserScript對象
// source:JS源代碼
// injectionTime:JS注入的時間
// forMainFrameOnly:是否只注入main frame
- (instancetype)initWithSource:(NSString *)source injectionTime:(WKUserScriptInjectionTime)injectionTime forMainFrameOnly:(BOOL)forMainFrameOnly;
WKUserScriptInjectionTime
它是一個枚舉類型见咒,只有在文檔開始加載時注入和加載結(jié)束時注入。
typedef NS_ENUM(NSInteger, WKUserScriptInjectionTime) {
WKUserScriptInjectionTimeAtDocumentStart,
WKUserScriptInjectionTimeAtDocumentEnd
} NS_ENUM_AVAILABLE(10_10, 8_0);
WKWebsiteDataStore存儲的Web內(nèi)容
iOS9.0以后才能使用這個類挂疆。它是代表webview不同的數(shù)據(jù)類型改览,包括cookies、disk缤言、memory caches宝当、WebSQL、IndexedDB數(shù)據(jù)庫和本地存儲胆萧。
從這里看庆揩,要優(yōu)化Webview好像可以通過它來實(shí)現(xiàn),不過要求iOS9.0以上才能使用〉耄現(xiàn)在6.0都沒有拋棄的我订晌,從來不能考慮這種最新的。
WKProcessPool并沒有公開任何的屬性或者方法蚌吸,不需要配置:
// 默認(rèn)數(shù)據(jù)存儲
+ (WKWebsiteDataStore *)defaultDataStore;
// 返回非持久化存儲锈拨,數(shù)據(jù)不會寫入文件系統(tǒng)
+ (WKWebsiteDataStore *)nonPersistentDataStore;
// 已經(jīng)不可用
- (instancetype)init NS_UNAVAILABLE;
// 只讀屬性,表示是否是持久化存儲
@property (nonatomic, readonly, getter=isPersistent) BOOL persistent;
// 獲取所有web內(nèi)容的數(shù)據(jù)存儲類型集羹唠,比如cookies奕枢、disk等
+ (NSSet<NSString *> *)allWebsiteDataTypes;
// 獲取某些指定數(shù)據(jù)存儲類型的數(shù)據(jù)
- (void)fetchDataRecordsOfTypes:(NSSet<NSString *> *)dataTypes completionHandler:(void (^)(NSArray<WKWebsiteDataRecord *> *))completionHandler;
// 刪除某些指定類型的數(shù)據(jù)
- (void)removeDataOfTypes:(NSSet<NSString *> *)dataTypes forDataRecords:(NSArray<WKWebsiteDataRecord *> *)dataRecords completionHandler:(void (^)(void))completionHandler;
// 刪除某些指定類型的數(shù)據(jù)且修改日期是指定的日期
- (void)removeDataOfTypes:(NSSet<NSString *> *)websiteDataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler;
所有的dataTypes是下面這些系統(tǒng)所定義的:
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的數(shù)據(jù)存儲記錄類型佩微,它只有兩個屬性:
// 通常是域名
@property (nonatomic, readonly, copy) NSString *displayName;
// 存儲的數(shù)據(jù)類型集
@property (nonatomic, readonly, copy) NSSet<NSString *> *dataTypes;
WKSelectionGranularity選擇粒度
它表示在webview上選擇內(nèi)容的粒度缝彬,只有下面這兩種類型:
typedef NS_ENUM(NSInteger, WKSelectionGranularity) {
WKSelectionGranularityDynamic,
WKSelectionGranularityCharacter,
} NS_ENUM_AVAILABLE_IOS(8_0);
它是用于webview內(nèi)容交互時選擇內(nèi)容的粒度類型設(shè)置。比如說哺眯,當(dāng)使用WKSelectionGranularityDynamic時谷浅,而所選擇的內(nèi)容是單個塊,這時候granularity可能會是單個字符奶卓;當(dāng)所選擇的web內(nèi)容不限制于某個塊時一疯,granularity可能會是單個塊。
WKNavigationDelegate
@protocol WKNavigationDelegate <NSObject>
@optional
// 決定導(dǎo)航的動作寝杖,通常用于處理跨域的鏈接能否導(dǎo)航违施。WebKit對跨域進(jìn)行了安全檢查限制,不允許跨域瑟幕,因此我們要對不能跨域的鏈接
// 單獨(dú)處理磕蒲。但是,對于Safari是允許跨域的只盹,不用這么處理辣往。
// 這個是決定是否Request
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler;
// 決定是否接收響應(yīng)
// 這個是決定是否接收response
// 要獲取response,通過WKNavigationResponse對象獲取
- (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler;
// 當(dāng)main frame的導(dǎo)航開始請求時殖卑,會調(diào)用此方法
- (void)webView:(WKWebView *)webView didStartProvisionalNavigation:(null_unspecified WKNavigation *)navigation;
// 當(dāng)main frame接收到服務(wù)重定向時站削,會回調(diào)此方法
- (void)webView:(WKWebView *)webView didReceiveServerRedirectForProvisionalNavigation:(null_unspecified WKNavigation *)navigation;
// 當(dāng)main frame開始加載數(shù)據(jù)失敗時,會回調(diào)
- (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error;
// 當(dāng)main frame的web內(nèi)容開始到達(dá)時孵稽,會回調(diào)
- (void)webView:(WKWebView *)webView didCommitNavigation:(null_unspecified WKNavigation *)navigation;
// 當(dāng)main frame導(dǎo)航完成時许起,會回調(diào)
- (void)webView:(WKWebView *)webView didFinishNavigation:(null_unspecified WKNavigation *)navigation;
// 當(dāng)main frame最后下載數(shù)據(jù)失敗時十偶,會回調(diào)
- (void)webView:(WKWebView *)webView didFailNavigation:(null_unspecified WKNavigation *)navigation withError:(NSError *)error;
// 這與用于授權(quán)驗(yàn)證的API,與AFN园细、UIWebView的授權(quán)驗(yàn)證API是一樣的
- (void)webView:(WKWebView *)webView didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential *__nullable credential))completionHandler;
// 當(dāng)web content處理完成時惦积,會回調(diào)
- (void)webViewWebContentProcessDidTerminate:(WKWebView *)webView NS_AVAILABLE(10_11, 9_0);
@end
WKNavigationActionPolicy
導(dǎo)航動作決定策略:
typedef NS_ENUM(NSInteger, WKNavigationActionPolicy) {
WKNavigationActionPolicyCancel,
WKNavigationActionPolicyAllow,
} NS_ENUM_AVAILABLE(10_10, 8_0);
它是枚舉類型,只有Cancel和Allow這兩種猛频。設(shè)置為Cancel就是不允許導(dǎo)航狮崩,就不會跳轉(zhuǎn)鏈接。
WKNavigationResponse
WKNavigationResponse是導(dǎo)航響應(yīng)類鹿寻,通過它可以獲取相關(guān)響應(yīng)的信息:
NS_CLASS_AVAILABLE(10_10, 8_0)
@interface WKNavigationResponse : NSObject
// 是否是main frame
@property (nonatomic, readonly, getter=isForMainFrame) BOOL forMainFrame;
// 獲取響應(yīng)response
@property (nonatomic, readonly, copy) NSURLResponse *response;
// 是否顯示MIMEType
@property (nonatomic, readonly) BOOL canShowMIMEType;
@end
只有接收響應(yīng)與不接收響應(yīng)兩種睦柴。
WKNavigationAction
WKNavigationAction對象包含關(guān)于導(dǎo)航的action的信息,用于make policy decisions毡熏。它只有以下幾個屬性:
// 正在請求的導(dǎo)航的frame
@property (nonatomic, readonly, copy) WKFrameInfo *sourceFrame;
// 目標(biāo)frame坦敌,如果這是新的window,它會是nil
@property (nullable, nonatomic, readonly, copy) WKFrameInfo *targetFrame;
// 導(dǎo)航類型招刹,如下面的小標(biāo)題WKNavigationType
@property (nonatomic, readonly) WKNavigationType navigationType;
// 導(dǎo)航的請求
@property (nonatomic, readonly, copy) NSURLRequest *request;
WKNavigationType
WKNavigationType類型是枚舉類型恬试,它的可選值如下:
typedef NS_ENUM(NSInteger, WKNavigationType) {
// 鏈接已經(jīng)點(diǎn)擊
WKNavigationTypeLinkActivated,
// 表單提交
WKNavigationTypeFormSubmitted,
// 前進(jìn)、后退
WKNavigationTypeBackForward,
// 重新載入
WKNavigationTypeReload,
// 表單重新提交
WKNavigationTypeFormResubmitted,
// 其它
WKNavigationTypeOther = -1,
} NS_ENUM_AVAILABLE(10_10, 8_0);
WKUIDelegate
@protocol WKUIDelegate <NSObject>
@optional
// 創(chuàng)建新的webview
// 可以指定配置對象疯暑、導(dǎo)航動作對象训柴、window特性
- (nullable WKWebView *)webView:(WKWebView *)webView createWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationAction windowFeatures:(WKWindowFeatures *)windowFeatures;
// webview關(guān)閉時回調(diào)
- (void)webViewDidClose:(WKWebView *)webView NS_AVAILABLE(10_11, 9_0);
// 調(diào)用JS的alert()方法
- (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(void))completionHandler;
// 調(diào)用JS的confirm()方法
- (void)webView:(WKWebView *)webView runJavaScriptConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(BOOL result))completionHandler;
// 調(diào)用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中可以前進(jìn)或者后退的頁面列表。其聲明如下:
NS_CLASS_AVAILABLE(10_10, 8_0)
@interface WKBackForwardList : NSObject
// 當(dāng)前正在顯示的item(頁面)
@property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *currentItem;
// 后一頁妇拯,如果沒有就是nil
@property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *backItem;
// 前一頁幻馁,如果沒有就是nil
@property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *forwardItem;
// 根據(jù)下標(biāo)獲取某一個頁面的item
- (nullable WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
// 可以進(jìn)行g(shù)oback操作的頁面列表
@property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *backList;
// 可以進(jìn)行g(shù)oforward操作的頁面列表
@property (nonatomic, readonly, copy) NSArray *forwardList;
@end
WKBackForwardListItem
頁面導(dǎo)航前進(jìn)、后退列表項:
@interface WKBackForwardListItem : NSObject
// 該頁面的URL
@property (readonly, copy) NSURL *URL;
// 該頁面的title
@property (nullable, readonly, copy) NSString *title;
// 初始請求該item的請求的URL
@property (readonly, copy) NSURL *initialURL;
@end