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];
    }
}

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 就可以避免特殊字符引起的問題。

demo地址:  https://github.com/domanc/HYBridWKWebView-MessageHandler.git