iOS下JS與OC互相調用（三）--MessageHandler

使用WKWebView的時候，若是想要實現JS調用OC方法，除了攔截URL以外，還有一種簡單的方式。那就是利用WKWebView的新特性MessageHandler來實現JS調用原生方法。

MessageHandler 是什麼？

WKWebView 初始化時，有一個參數叫configuration，它是WKWebViewConfiguration類型的參數，而WKWebViewConfiguration有一個屬性叫userContentController，它又是WKUserContentController類型的參數。WKUserContentController對象有一個方法- addScriptMessageHandler:name:，我把這個功能簡稱爲MessageHandler。

- addScriptMessageHandler:name:有兩個參數，第一個參數是userContentController的代理對象，第二個參數是JS裏發送postMessage的對象。 因此要使用MessageHandler功能，就必需要實現WKScriptMessageHandler協議。 咱們在該API的描述裏能夠看到在JS中的使用方法：

window.webkit.messageHandlers.<name>.postMessage(<messageBody>)
//其中<name>，就是上面方法裏的第二個參數`name`。
//例如咱們調用API的時候第二個參數填@"Share"，那麼在JS裏就是:
//window.webkit.messageHandlers.Share.postMessage(<messageBody>)
//<messageBody>是一個鍵值對，鍵是body，值能夠有多種類型的參數。
// 在`WKScriptMessageHandler`協議中，咱們能夠看到mssage是`WKScriptMessage`類型，有一個屬性叫body。
// 而註釋裏寫明瞭body 的類型：
Allowed types are NSNumber, NSString, NSDate, NSArray, NSDictionary, and NSNull.
複製代碼

怎麼使用MessageHandler？

1.建立WKWebViewConfiguration對象，配置各個API對應的MessageHandler。

WKUserContentController對象能夠添加多個scriptMessageHandler。

看了示例代碼，會很容易理解。示例代碼以下：

// 這是建立configuration 的過程
    WKWebViewConfiguration *configuration = [[WKWebViewConfiguration alloc] init];
    WKPreferences *preferences = [WKPreferences new];
    preferences.javaScriptCanOpenWindowsAutomatically = YES;
    preferences.minimumFontSize = 40.0;
    configuration.preferences = preferences;
    

- (void)viewWillAppear:(BOOL)animated
{
    [super viewWillAppear:animated];
    // addScriptMessageHandler 很容易致使循環引用
    // 控制器 強引用了WKWebView,WKWebView copy(強引用了）configuration， configuration copy （強引用了）userContentController
    // userContentController 強引用了 self （控制器）
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"ScanAction"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"Location"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"Share"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"Color"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"Pay"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"Shake"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"GoBack"];
    [self.webView.configuration.userContentController addScriptMessageHandler:self name:@"PlaySound"];
}
複製代碼

須要注意的是addScriptMessageHandler很容易引發循環引用，致使控制器沒法被釋放，因此須要加入如下這段：

- (void)viewWillDisappear:(BOOL)animated
{
    [super viewWillDisappear:animated];
    
    // 所以這裏要記得移除handlers
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"ScanAction"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"Location"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"Share"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"Color"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"Pay"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"Shake"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"GoBack"];
    [self.webView.configuration.userContentController removeScriptMessageHandlerForName:@"PlaySound"];
}
複製代碼

2.建立WKWebView。

這裏沒什麼好說的，直接看示例代碼吧：

    self.webView = [[WKWebView alloc] initWithFrame:self.view.frame configuration:configuration];
    
    NSString *urlStr = [[NSBundle mainBundle] pathForResource:@"index.html" ofType:nil];
    NSURL *fileURL = [NSURL fileURLWithPath:urlStr];
    [self.webView loadFileURL:fileURL allowingReadAccessToURL:fileURL];
    
    self.webView.navigationDelegate = self;
    self.webView.UIDelegate = self;
    [self.view addSubview:self.webView];
複製代碼

3.實現協議方法。

我這裏實現了兩個協議<WKUIDelegate,WKScriptMessageHandler>，WKUIDelegate是由於我在JS中彈出了alert 。WKScriptMessageHandler是由於咱們要處理JS調用OC方法的請求。 先看實現協議方法的示例代碼：

#pragma mark - WKScriptMessageHandler
- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message
{
//    message.body  --  Allowed types are NSNumber, NSString, NSDate, NSArray,NSDictionary, and NSNull.
    if ([message.name isEqualToString:@"ScanAction"]) {
        NSLog(@"掃一掃");
    } else if ([message.name isEqualToString:@"Location"]) {
        [self getLocation];
    } else if ([message.name isEqualToString:@"Share"]) {
        [self shareWithParams:message.body];
    } else if ([message.name isEqualToString:@"Color"]) {
        [self changeBGColor:message.body];
    } else if ([message.name isEqualToString:@"Pay"]) {
        [self payWithParams:message.body];
    } else if ([message.name isEqualToString:@"Shake"]) {
        [self shakeAction];
    } else if ([message.name isEqualToString:@"GoBack"]) {
        [self goBack];
    } else if ([message.name isEqualToString:@"PlaySound"]) {
        [self playSound:message.body];
    }
}
複製代碼

WKScriptMessage有兩個關鍵屬性name 和 body。 由於咱們給每個OC 方法取了一個name，那麼咱們就能夠根據name 來區分執行不一樣的方法。body 中存着JS 要給OC 傳的參數。 關於參數body 的解析，我就舉一個body中放字典的例子，其餘的稍後能夠看demo。 解析JS 調用OC 實現分享的參數：

- (void)shareWithParams:(NSDictionary *)tempDic
{
    if (![tempDic isKindOfClass:[NSDictionary class]]) {
        return;
    }
    
    NSString *title = [tempDic objectForKey:@"title"];
    NSString *content = [tempDic objectForKey:@"content"];
    NSString *url = [tempDic objectForKey:@"url"];
    // 在這裏執行分享的操做
    
    // 將分享結果返回給js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
        NSLog(@"%@----%@",result, error);
    }];
}
複製代碼

message.boby 就是JS 裏傳過來的參數。咱們不一樣的方法先作一下容錯性判斷。而後正常取值就能夠了。

4.處理HTML中JS調用。

HMTL的源碼跟以前的HTML內容差很少，只有JS的調用部分改變了。

// 傳null
function scanClick() {
    window.webkit.messageHandlers.ScanAction.postMessage(null);
}
// 傳字典              
function shareClick() {
    window.webkit.messageHandlers.Share.postMessage({title:'測試分享的標題',content:'測試分享的內容',url:'http://www.baidu.com'});
}
// 傳字符串
function playSound() { 
    window.webkit.messageHandlers.PlaySound.postMessage('shake_sound_male.wav');
}
// 傳數組
function colorClick() {
    window.webkit.messageHandlers.Color.postMessage([67,205,128,0.5]);
}

複製代碼

5.OC調用JS

這裏使用WKWebView 實現OC 調用JS方法跟上一篇是同樣的，仍是利用 - evaluateJavaScript:completionHandler:。像下面這樣使用：

// 將分享結果返回給js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
        NSLog(@"%@----%@",result, error);
    }];
複製代碼

使用MessageHandler 的好處

• 1.在JS中寫起來簡單，不用再用建立URL的方式那麼麻煩了。
• 2.JS傳遞參數更方便。使用攔截URL的方式傳遞參數，只能把參數拼接在後面，若是遇到要傳遞的參數中有特殊字符，如&、=、？等，必須得轉換，不然參數解析確定會出錯。 例如傳遞的url是這樣的: http://www.baidu.com/share/openShare.htm?share_uuid=shdfxdfdsfsdf&name=1234556 使用攔截URL 的JS調用方式

loadURL("firstClick://shareClick?title=分享的標題&content=分享的內容&url=連接地址&imagePath=圖片地址"); }
複製代碼

將上面的url 放入連接地址這裏後，根本沒法區分share_uuid是其餘參數，仍是url裏附帶的參數。 可是使用MessageHandler 就能夠避免特殊字符引發的問題。

效果圖

更詳細的使用步驟仍是去工程中查看吧。地址：JS_OC_MessageHandler