美文网首页
WKWebView API精讲(OC)

WKWebView API精讲(OC)

作者: 2897275c8a00 | 来源:发表于2017-09-27 16:43 被阅读60次

    WKWebView

    看看WKWebView的头文件声明:

    WKWebView

    // webview 配置,具体看下面

    @property(nonatomic,readonly,copy)WKWebViewConfiguration*configuration;

    // 导航代理

    @property(nullable,nonatomic,weak)idnavigationDelegate;

    // 用户交互代理

    @property(nullable,nonatomic,weak)idUIDelegate;

    // 页面前进、后退列表

    @property(nonatomic,readonly,strong)WKBackForwardList*backForwardList;

    // 默认构造器

    -(instancetype)initWithFrame:(CGRect)frameconfiguration:(WKWebViewConfiguration*)configurationNS_DESIGNATED_INITIALIZER;

    // 已不再使用

    -(instancetype)initWithCoder:(NSCoder*)coderNS_UNAVAILABLE;

    // 与UIWebView一样的加载请求API

    -(nullableWKNavigation*)loadRequest:(NSURLRequest*)request;

    // 加载URL

    -(nullableWKNavigation*)loadFileURL:(NSURL*)URLallowingReadAccessToURL:(NSURL*)readAccessURLNS_AVAILABLE(10_11,9_0);

    // 直接加载HTML

    -(nullableWKNavigation*)loadHTMLString:(NSString*)stringbaseURL:(nullableNSURL*)baseURL;

    // 直接加载data

    -(nullableWKNavigation*)loadData:(NSData*)dataMIMEType:(NSString*)MIMETypecharacterEncodingName:(NSString*)characterEncodingNamebaseURL:(NSURL*)baseURLNS_AVAILABLE(10_11,9_0);

    // 前进或者后退到某一页面

    -(nullableWKNavigation*)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)BOOLloading;

    // 当前加载的进度,范围为[0, 1]

    @property(nonatomic,readonly)doubleestimatedProgress;

    // 标识页面中的所有资源是否通过安全加密连接来加载,它是支持KVO的

    @property(nonatomic,readonly)BOOLhasOnlySecureContent;

    // 当前导航的证书链,支持KVO

    @property(nonatomic,readonly,copy)NSArray*certificateChainNS_AVAILABLE(10_11,9_0);

    // 是否可以招待goback操作,它是支持KVO的

    @property(nonatomic,readonly)BOOLcanGoBack;

    // 是否可以执行gofarward操作,支持KVO

    @property(nonatomic,readonly)BOOLcanGoForward;

    // 返回上一页面,如果不能返回,则什么也不干

    -(nullableWKNavigation*)goBack;

    // 进入下一页面,如果不能前进,则什么也不干

    -(nullableWKNavigation*)goForward;

    // 重新载入页面

    -(nullableWKNavigation*)reload;

    // 重新从原始URL载入

    -(nullableWKNavigation*)reloadFromOrigin;

    // 停止加载数据

    -(void)stopLoading;

    // 执行JS代码

    -(void)evaluateJavaScript:(NSString*)javaScriptStringcompletionHandler:(void(^__nullable)(__nullableid,NSError*__nullableerror))completionHandler;

    // 标识是否支持左、右swipe手势是否可以前进、后退

    @property(nonatomic)BOOLallowsBackForwardNavigationGestures;

    // 自定义user agent,如果没有则为nil

    @property(nullable,nonatomic,copy)NSString*customUserAgentNS_AVAILABLE(10_11,9_0);

    // 在iOS上默认为NO,标识不允许链接预览

    @property(nonatomic)BOOLallowsLinkPreviewNS_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)BOOLallowsMagnification;

    // 放大因子,默认为1

    @property(nonatomic)CGFloatmagnification;

    // 根据设置的缩放因子来缩放页面,并居中显示结果在指定的点

    -(void)setMagnification:(CGFloat)magnificationcenteredAtPoint:(CGPoint)point;

    #endif

    WKWebViewConfiguration配置

    WKWebViewConfiguration*config=[[WKWebViewConfigurationalloc]init];

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

    // 设置偏好设置

    config.preferences=[[WKPreferencesalloc]init];

    // 默认为0

    config.preferences.minimumFontSize=10;

    // 默认认为YES

    config.preferences.javaScriptEnabled=YES;

    // 在iOS上默认为NO,表示不能自动通过窗口打开

    config.preferences.javaScriptCanOpenWindowsAutomatically=NO;

    WKProcessPool内容处理池

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

    config.processPool=[[WKProcessPoolalloc]init];

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

    WKUserContentController内容交互控制器

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

    // 只读属性,所有添加的WKUserScript都在这里可以获取到

    @property(nonatomic,readonly,copy)NSArray*userScripts;

    // 注入JS

    -(void)addUserScript:(WKUserScript*)userScript;

    // 移除所有注入的JS

    -(void)removeAllUserScripts;

    // 添加scriptMessageHandler到所有的frames中,则都可以通过

    // window.webkit.messageHandlers..postMessage()

    // 发送消息

    // 比如,JS要调用我们原生的方法,就可以通过这种方式了

    -(void)addScriptMessageHandler:(id)scriptMessageHandlername:(NSString*)name;

    // 根据name移除所注入的scriptMessageHandler

    -(void)removeScriptMessageHandlerForName:(NSString*)name;

    WKUserScript

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

    // JS源代码

    @property(nonatomic,readonly,copy)NSString*source;

    // JS注入时间

    @property(nonatomic,readonly)WKUserScriptInjectionTimeinjectionTime;

    // 只读属性,表示JS是否应该注入到所有的frames中还是只有main frame.

    @property(nonatomic,readonly,getter=isForMainFrameOnly)BOOLforMainFrameOnly;

    // 初始化方法,用于创建WKUserScript对象

    // source:JS源代码

    // injectionTime:JS注入的时间

    // forMainFrameOnly:是否只注入main frame

    -(instancetype)initWithSource:(NSString*)sourceinjectionTime:(WKUserScriptInjectionTime)injectionTimeforMainFrameOnly:(BOOL)forMainFrameOnly;

    WKUserScriptInjectionTime

    typedefNS_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都没有抛弃的我,从来不能考虑这种最新的。

    // 默认数据存储

    +(WKWebsiteDataStore*)defaultDataStore;

    // 返回非持久化存储,数据不会写入文件系统

    +(WKWebsiteDataStore*)nonPersistentDataStore;

    // 已经不可用

    -(instancetype)initNS_UNAVAILABLE;

    // 只读属性,表示是否是持久化存储

    @property(nonatomic,readonly,getter=isPersistent)BOOLpersistent;

    // 获取所有web内容的数据存储类型集,比如cookies、disk等

    +(NSSet*)allWebsiteDataTypes;

    // 获取某些指定数据存储类型的数据

    -(void)fetchDataRecordsOfTypes:(NSSet*)dataTypescompletionHandler:(void(^)(NSArray*))completionHandler;

    // 删除某些指定类型的数据

    -(void)removeDataOfTypes:(NSSet*)dataTypesforDataRecords:(NSArray*)dataRecordscompletionHandler:(void(^)(void))completionHandler;

    // 删除某些指定类型的数据且修改日期是指定的日期

    -(void)removeDataOfTypes:(NSSet*)websiteDataTypesmodifiedSince:(NSDate*)datecompletionHandler:(void(^)(void))completionHandler;

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

    WK_EXTERNNSString*constWKWebsiteDataTypeDiskCacheNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeMemoryCacheNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeOfflineWebApplicationCacheNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeCookiesNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeSessionStorageNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeLocalStorageNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeWebSQLDatabasesNS_AVAILABLE(10_11,9_0);

    WK_EXTERNNSString*constWKWebsiteDataTypeIndexedDBDatabasesNS_AVAILABLE(10_11,9_0);

    WKWebsiteDataRecord

    iOS9.0以后才可用。

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

    // 通常是域名

    @property(nonatomic,readonly,copy)NSString*displayName;

    // 存储的数据类型集

    @property(nonatomic,readonly,copy)NSSet*dataTypes;

    WKSelectionGranularity选择粒度

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

    typedefNS_ENUM(NSInteger,WKSelectionGranularity){

    WKSelectionGranularityDynamic,

    WKSelectionGranularityCharacter,

    }NS_ENUM_AVAILABLE_IOS(8_0);

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

    WKNavigationDelegate

    @protocolWKNavigationDelegate

    @optional

    // 决定导航的动作,通常用于处理跨域的链接能否导航。WebKit对跨域进行了安全检查限制,不允许跨域,因此我们要对不能跨域的链接

    // 单独处理。但是,对于Safari是允许跨域的,不用这么处理。

    // 这个是决定是否Request

    -(void)webView:(WKWebView*)webViewdecidePolicyForNavigationAction:(WKNavigationAction*)navigationActiondecisionHandler:(void(^)(WKNavigationActionPolicy))decisionHandler;

    // 决定是否接收响应

    // 这个是决定是否接收response

    // 要获取response,通过WKNavigationResponse对象获取

    -(void)webView:(WKWebView*)webViewdecidePolicyForNavigationResponse:(WKNavigationResponse*)navigationResponsedecisionHandler:(void(^)(WKNavigationResponsePolicy))decisionHandler;

    // 当main frame的导航开始请求时,会调用此方法

    -(void)webView:(WKWebView*)webViewdidStartProvisionalNavigation:(null_unspecifiedWKNavigation*)navigation;

    // 当main frame接收到服务重定向时,会回调此方法

    -(void)webView:(WKWebView*)webViewdidReceiveServerRedirectForProvisionalNavigation:(null_unspecifiedWKNavigation*)navigation;

    // 当main frame开始加载数据失败时,会回调

    -(void)webView:(WKWebView*)webViewdidFailProvisionalNavigation:(null_unspecifiedWKNavigation*)navigationwithError:(NSError*)error;

    // 当main frame的web内容开始到达时,会回调

    -(void)webView:(WKWebView*)webViewdidCommitNavigation:(null_unspecifiedWKNavigation*)navigation;

    // 当main frame导航完成时,会回调

    -(void)webView:(WKWebView*)webViewdidFinishNavigation:(null_unspecifiedWKNavigation*)navigation;

    // 当main frame最后下载数据失败时,会回调

    -(void)webView:(WKWebView*)webViewdidFailNavigation:(null_unspecifiedWKNavigation*)navigationwithError:(NSError*)error;

    // 这与用于授权验证的API,与AFN、UIWebView的授权验证API是一样的

    -(void)webView:(WKWebView*)webViewdidReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge*)challengecompletionHandler:(void(^)(NSURLSessionAuthChallengeDispositiondisposition,NSURLCredential*__nullablecredential))completionHandler;

    // 当web content处理完成时,会回调

    -(void)webViewWebContentProcessDidTerminate:(WKWebView*)webViewNS_AVAILABLE(10_11,9_0);

    @end

    WKNavigationActionPolicy

    导航动作决定策略:

    typedefNS_ENUM(NSInteger,WKNavigationActionPolicy){

    WKNavigationActionPolicyCancel,

    WKNavigationActionPolicyAllow,

    }NS_ENUM_AVAILABLE(10_10,8_0);

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

    WKNavigationResponsePolicy

    typedefNS_ENUM(NSInteger,WKNavigationResponsePolicy){

    WKNavigationResponsePolicyCancel,

    WKNavigationResponsePolicyAllow,

    }NS_ENUM_AVAILABLE(10_10,8_0);

    WKNavigationResponse

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

    NS_CLASS_AVAILABLE(10_10,8_0)

    @interfaceWKNavigationResponse: NSObject

    // 是否是main frame

    @property(nonatomic,readonly,getter=isForMainFrame)BOOLforMainFrame;

    // 获取响应response

    @property(nonatomic,readonly,copy)NSURLResponse*response;

    // 是否显示MIMEType

    @property(nonatomic,readonly)BOOLcanShowMIMEType;

    @end

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

    WKNavigationAction

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

    // 正在请求的导航的frame

    @property(nonatomic,readonly,copy)WKFrameInfo*sourceFrame;

    // 目标frame,如果这是新的window,它会是nil

    @property(nullable,nonatomic,readonly,copy)WKFrameInfo*targetFrame;

    // 导航类型,如下面的小标题WKNavigationType

    @property(nonatomic,readonly)WKNavigationTypenavigationType;

    // 导航的请求

    @property(nonatomic,readonly,copy)NSURLRequest*request;

    WKNavigationType

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

    typedefNS_ENUM(NSInteger,WKNavigationType){

    // 链接已经点击

    WKNavigationTypeLinkActivated,

    // 表单提交

    WKNavigationTypeFormSubmitted,

    // 前进、后退

    WKNavigationTypeBackForward,

    // 重新载入

    WKNavigationTypeReload,

    // 表单重新提交

    WKNavigationTypeFormResubmitted,

    // 其它

    WKNavigationTypeOther=-1,

    }NS_ENUM_AVAILABLE(10_10,8_0);

    WKUIDelegate

    @protocolWKUIDelegate

    @optional

    // 创建新的webview

    // 可以指定配置对象、导航动作对象、window特性

    -(nullableWKWebView*)webView:(WKWebView*)webViewcreateWebViewWithConfiguration:(WKWebViewConfiguration*)configurationforNavigationAction:(WKNavigationAction*)navigationActionwindowFeatures:(WKWindowFeatures*)windowFeatures;

    // webview关闭时回调

    -(void)webViewDidClose:(WKWebView*)webViewNS_AVAILABLE(10_11,9_0);

    // 调用JS的alert()方法

    -(void)webView:(WKWebView*)webViewrunJavaScriptAlertPanelWithMessage:(NSString*)messageinitiatedByFrame:(WKFrameInfo*)framecompletionHandler:(void(^)(void))completionHandler;

    // 调用JS的confirm()方法

    -(void)webView:(WKWebView*)webViewrunJavaScriptConfirmPanelWithMessage:(NSString*)messageinitiatedByFrame:(WKFrameInfo*)framecompletionHandler:(void(^)(BOOLresult))completionHandler;

    // 调用JS的prompt()方法

    -(void)webView:(WKWebView*)webViewrunJavaScriptTextInputPanelWithPrompt:(NSString*)promptdefaultText:(nullableNSString*)defaultTextinitiatedByFrame:(WKFrameInfo*)framecompletionHandler:(void(^)(NSString*__nullableresult))completionHandler;

    @end

    WKBackForwardList

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

    NS_CLASS_AVAILABLE(10_10,8_0)

    @interfaceWKBackForwardList: 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

    -(nullableWKBackForwardListItem*)itemAtIndex:(NSInteger)index;

    // 可以进行goback操作的页面列表

    @property(nonatomic,readonly,copy)NSArray*backList;

    // 可以进行goforward操作的页面列表

    @property(nonatomic,readonly,copy)NSArray*forwardList;

    @end

    WKBackForwardListItem

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

    NS_CLASS_AVAILABLE(10_10,8_0)

    @interfaceWKBackForwardListItem: 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 API精讲(OC)

          本文链接:https://www.haomeiwen.com/subject/sfiuextx.html