1. 程式人生 > >iOS開發-------基於WKWebView的原生與JavaScript資料互動

iOS開發-------基於WKWebView的原生與JavaScript資料互動

WKWebView是iOS8.0之後用以替代UIWebView的網頁瀏覽器,包含在WebKit中,可以通過 @import WebKit 匯入。

如果工程需要適配iOS7,那麼請在iOS7中使用UIWebView。

如果是iOS8.0以上,請果斷的選擇WKWebView吧,無論是從功能,載入速度還是效能上,它都是不二的選擇。


畢業回公司有段時間了,與其說比較忙,不如說最近接觸的東西有點小多,並且還是多數自己之前聞所未聞的,整個人就顯得比較浮躁,所以就沒有對見識到的東西進行整理,感覺挺對不住自己的,知錯就改,之後會慢慢的將看到的、學到的比較好的東西進行整理,記錄一下,希望能在幫助俺那不靠譜的記性同時,也能夠幫助有同樣困惑的小夥伴。

不過這裡並不會非常具體的介紹WKWebView如何使用以及各種協議物件是什麼作用,畢竟Google一下就會有很多介紹WKWebView的文章,並且他們都寫得很好很詳細,大家感興趣的可以Google一下。給大家推薦一個WKWebView的新特性與使用

這裡記錄的互動僅僅的是進行一些資料的互動,對於其他的UI互動以及響應互動,請檢視一下上面推薦的博文,寫的真的很詳細;如果大家有更好的互動方式,也麻煩大家告知一下3Q

iOS客戶端 -> Web端

言歸正傳,我們用WKWebView載入一個HTML檔案(載入網路網頁其實是一個道理的),萬一進行某個操作的時候需要原生給web傳遞一個數據(至於什麼資料,需要根據具體的需求來確定),這裡就以一個字串進行舉例:

在需要與Web進行復雜互動的時候,通常都需要在例項化WKWebView

的之前,先例項化一個WKWebView的配置物件(WKWebViewConfiguration型別),對javaScript的注入第一步就是需要處理一下這個配置物件:

//初始化webView的配置物件
let configuration = WKWebViewConfiguration()

//比如這就是需要傳遞給web的引數
let name = "RITL"

//宣告一個WKUserScript物件
let script:WKUserScript = WKUserScript(source: "function callJavaScript() {ObjCToJavaScript('\(name)');}"
, injectionTime: .AtDocumentStart, forMainFrameOnly: true) //對Script物件進行新增 configuration.userContentController.addUserScript(script)


因為自己的Demo中的觸發點在於導航欄中的Do按鈕(開發中,這個觸發點是由實際需求確定的):

//響應Do
@IBAction func doTap(sender: AnyObject)
{
    //呼叫的JS方法,執行
    let js = "callJavaScript()";
    webView.evaluateJavaScript(js) { (object, error) in
    }//與iOS8之前的UIWebView類似
}

It’s OK? 總感覺還是還差一步的,既然有addXXX這句,是不是應該有removeXXX呢,還真有,也就差這麼一步

deinit
{  
    //刪除注入的JS
    webView.configuration.userContentController.removeAllUserScripts()
}


Demo的HTML語句比較low,但僅僅的就是為了測試,所以就忍了吧0.0

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>我是HTML標題</title>
    </head>

    <script>
        //原生呼叫該方法,並通過接收傳入的引數進行下一步操作
        function ObjCToJavaScript(name)
        {
            //修改label顯示的title
            document.getElementById("Text").innerText = name;
        }
    </script>

    <body>
        <label id ="Text" style = "margin-top: 100px ; display: block; font-size:100px;">Text</label>
    </body>
</html>

<!--  總結一下,其實從上面的描述也就看出來了,所謂的原生對JS進行傳值的實質說白了就是修改了響應JS的觸發點>

最後看一下傳值互動的效果,由客戶端將字串“RITL"傳遞給web,經由JS方法修改label標籤的值:

Web端 -> iOS客戶端

這個傳值方向是目前為止,我在專案中應用的比較廣泛的一種,在WKWebView之前(UIWebView),想要獲得JS中對客戶端傳的引數值,基本有方法有如下兩種:

  1. web端通過重定向,將傳遞的引數拼接成自定義的格式,將引數作為url進行重新定向,客戶端通過實現WebView的代理方法獲取到重定向的url,通過解析字串進而獲得傳出的引數(0.0 是不是覺得好low啊);

  2. 藉助大神寫好的第三方庫,比如:JavaScriptWebView等完成WebView與JS間的傳值。但這裡也說一下自己的看法,這種情況多數是將WebView的代理以及控制權交給了三方中的某個管理類,能完成資訊互動的同時也表示著我們失去了對WebView的資訊互動控制權,個人覺得不是很爽。當然,除此之外還有什麼辦法呢T^T。

    相比UIWebView,WKWebView中就為我們提供了看起來更加高大上同時也讓我們不失去對WebView控制權的互動方法,真所謂一舉兩得。
    

與第一種方向相同,同樣操作webView的配置物件,在WKWebView的配置物件中對javaScript互動資料進行監聽,方法如下:

//webView的配置物件對傳出資料的名字進行監聽,此時負責接收JS訊息處理的物件不要忘記履行協議<WKScriptMessageHandler>
[self.webView.configuration.userContentController addScriptMessageHandler:self name:name];


<WKScriptMessageHandler>協議也比較給力,只有一個協議方法:

#pragma mark - <WKScriptMessageHandler>

//通過接收JS傳出訊息的name進行捕捉的回撥方法
- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message
{
    if([message.name isEqualToString:name])//此處name為JS傳出資訊打包的標誌<name>
    {
        //用message.body獲得JS傳出的引數體
        //handle coding..
    }
}

Web端在需要客戶端配合的時候通過如下程式碼進行觸發:

/* 一個抽象模型 */
window.webkit.messageHandlers.
<name>.postMessage(<messageBody>)

/* 具體例項 */

/*JS的傳出語句如下,那麼name = "RITL"*/
window.webKit.messagehandlers.RITL.postMessage("RITL-GOGOGO")

/*外部要想獲得上面的資訊則進行如下監聽*/
[self.webView.configuration.userContentController addScriptMessageHandler:self name:@"RITL"];

/*獲得傳出的字串引數,即"RITL-GOGOGO"*/
NSString * dataString = message.body;


預定javaScript處理結束了,也能完成各種互動動作,如果這個時候大家能想得到add必有remove的規則,我表示此時內心無比欣慰,突然感覺這篇博文真的沒有白寫,那麼習慣性的在dealloc中進行監聽登出吧:

/** 登出 */
[self.webView.configuration.userContentController removeScriptMessageHandlerForName:name];


BUT!!!!!

記憶體洩露

通常我們認為上面的做法已經很好的完成需求,如果是仔細或者對系統性能比較關注的開發者,相信肯定會在dealloc中打一個斷點來求證一下,那麼這個時候我們就會發現,Dealloc根本不走!沒錯,根本不走!

PS: (這一點讓我想起來之前專案中NSTimer造成的記憶體洩露問題,跟上面的問題簡直是異曲同工之理(額,原理可能不一樣,但效果是一樣的,就是當前的控制器不會釋放,被強引用了,So? 自然也不會走dealloc方法))。

難不成-addScriptMessageHandler:name:個方法會對Handler進行強引用?要不換成__weak吧? No!!!! NSTimer造成記憶體洩露的時候換成歸零弱引用好使麼,不好使吧!那麼解決方法就和解決NSTimer的方法類似了。

通過轉移代理物件(額,其實就是引用物件)來完成強引用的轉移,從而讓當前控制器得以釋放,進而remove掉messagehandler, 完成對轉移代理物件釋放,將記憶體洩露堵住:

下面是我解決響應方法的一個實現類:

/*CB_YZZBScriptMessageHandler.h*/
#import <Foundation/Foundation.h>

@import WebKit;

NS_ASSUME_NONNULL_BEGIN

@interface CB_YZZBScriptMessageHandler : NSObject<WKScriptMessageHandler>

@property (nullable, nonatomic, weak)id <WKScriptMessageHandler> delegate;

/** 建立方法 */
- (instancetype)initWithDelegate:(id <WKScriptMessageHandler>)delegate;

/** 便利構造器 */
+ (instancetype)scriptWithDelegate:(id <WKScriptMessageHandler>)delegate;;

@end

NS_ASSUME_NONNULL_END





/*CB_YZZBScriptMessageHandler.m*/
@implementation CB_YZZBScriptMessageHandler

-(instancetype)initWithDelegate:(id<WKScriptMessageHandler>)delegate
{
    if (self = [super init])
    {
        _delegate = delegate;
    }

    return self;
}


+(instancetype)scriptWithDelegate:(id<WKScriptMessageHandler>)delegate
{
    return [[CB_YZZBScriptMessageHandler alloc]initWithDelegate:delegate];
}


#pragma mark - <WKScriptMessageHandler>
- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message
{
    [self.delegate userContentController:userContentController didReceiveScriptMessage:message];
}

@end

使用的時候轉一下強引用物件就OK啦

//例項引用物件
CB_YZZBScriptMessageHandler * messageHandle = [CB_YZZBScriptMessageHandler scriptWithDelegate:self];

//註冊JS資訊處理
[self.webView.configuration.userContentController addScriptMessageHandler:messageHandle name:@"RITL"];

取消長按響應

- (void)webView:(WKWebView *)webView didFinishNavigation:(null_unspecified WKNavigation *)navigation
{
    //注入不響應的JS方法即可
    [webView evaluateJavaScript:@"document.documentElement.style.webkitTouchCallout='none';" completionHandler:^(id _Nullable result, NSError * _Nullable error) {}];
}