iOS - OC 與 JS 交互六種方式總結(jié)

序言

在 APP 中，免不了與 H5頁(yè)面打交道，所以掌握 與 JS 交互就顯的至關(guān)重要，本文總結(jié)了常見(jiàn)的與 JS 交互方式。

一 UIWebView 攔截 URL
1.1 JS 調(diào)用原生 OC
- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
    NSURL * url = [request URL];
    if ([[url scheme] isEqualToString:@"firstclick"]) {  // firstClick://shareClick?title=分享的標(biāo)題&content=分享的內(nèi)容&url=鏈接地址&imagePath=圖片地址
        NSArray *params = [url.query componentsSeparatedByString:@"&"];
        
        NSMutableDictionary *tempDict = [NSMutableDictionary dictionary];
        NSMutableString *strM = [NSMutableString string];
        for (NSString *paramStr in params) {
            NSArray *dictArray = [paramStr componentsSeparatedByString:@"="];
            if (dictArray.count > 1) {
                NSString *decodeValue = [dictArray[1] stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
                decodeValue = [decodeValue stringByRemovingPercentEncoding];
                [tempDict setObject:decodeValue forKey:dictArray[0]];
                [strM appendString:decodeValue];
            }
        }
        UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"這是OC原生的彈出窗" message:strM delegate:self cancelButtonTitle:@"收到" otherButtonTitles:nil];
        [alertView show];
        NSLog(@"tempDic:%@",tempDict);
        return NO;
    }
    return YES;
}

注意事項(xiàng)

1.JS中的firstClick,在攔截到的url scheme全都被轉(zhuǎn)化為小寫(xiě)。
2.html 中需要設(shè)置編碼，否則中文參數(shù)可能會(huì)出現(xiàn)編碼問(wèn)題。
3.JS用打開(kāi)一個(gè)iFrame的方式替代直接用document.location的方式，以避免多次請(qǐng)求，被替換覆蓋的問(wèn)題

1.2 OC 調(diào)用 JS

在 OC 原生中

NSString *jsStr = [NSString stringWithFormat:@"showAlert('%@')",@"這里是JS中alert彈出的message"];
[self.webView stringByEvaluatingJavaScriptFromString:jsStr];

注意：該方法會(huì)同步返回一個(gè)字符串，因此是一個(gè)同步方法，可能會(huì)阻塞主線程。

在 html 文件中

function showAlert(message) {
  alert(message);
}

早期的JS與原生交互的開(kāi)源庫(kù)很多都是用得這種方式來(lái)實(shí)現(xiàn)的，例如：PhoneGap、WebViewJavascriptBridge。

效果圖

js_oc_intercept_url.gif
二 WKWebView攔截 URL
2.1 JS調(diào)用 OC

使用WKNavigationDelegate中的代理方法，攔截自定義的 URL 來(lái)實(shí)現(xiàn) JS 調(diào)用 OC 方法。

#pragma mark - WKNavigationDelegate

- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
    NSURL *URL = navigationAction.request.URL;
    NSString *scheme = [URL scheme];
    if ([scheme isEqualToString:@"haleyaction"]) {
        [self handleCustomAction:URL];
        decisionHandler(WKNavigationActionPolicyCancel);
        return;
    }
    decisionHandler(WKNavigationActionPolicyAllow);
}

注意點(diǎn)

如果實(shí)現(xiàn)了這個(gè)代理方法，就必須得調(diào)用decisionHandler這個(gè) block，否則會(huì)導(dǎo)致 app 奔潰。block 參數(shù)是一個(gè)枚舉值，WKNavigationActionPolicyCancel代表取消加載，相當(dāng)于UIWebView的代理方法return NO的情況；WKNavigationActionPolicyAllow代表允許加載，相當(dāng)于UIWebView的代理方法中 return YES的情況。

關(guān)于如何區(qū)分執(zhí)行不同的OC 方法，也與UIWebView的處理方式一樣,通過(guò)URL 的host 來(lái)區(qū)分執(zhí)行不同的方法：

#pragma mark - dealwith custom action

- (void)handleCustomAction:(NSURL *)URL {
    NSString *host = [URL host];
    
    if ([host isEqualToString:@"shareClick"]) {
        [self share:URL];
    } else if ([host isEqualToString:@"getLocation"]) {
        [self getLocation:URL];
    } else if ([host isEqualToString:@"setBGColor"]) {
        [self setBGColor:URL];
    } else if ([host isEqualToString:@"payAction"]) {
        [self payAction:URL];
    } else if ([host isEqualToString:@"shake"]) {
        [self shakeAction];
    } else if ([host isEqualToString:@"back"]) {
        [self goBack];
    }
}
2.2 OC 調(diào)用 JS 方法

JS 調(diào)用OC 方法后，有的操作可能需要將結(jié)果返回給JS。這時(shí)候就是OC 調(diào)用JS 方法的場(chǎng)景。
WKWebView 提供了一個(gè)新的方法evaluateJavaScript:completionHandler:，實(shí)現(xiàn)OC 調(diào)用JS 等場(chǎng)景。

- (void)getLocation:(NSURL *)URL {
    // 獲取位置信息
    NSLog(@"原生獲取位置信息操作");
    
    // 將結(jié)果返回給 JS
    NSString *jsStr = [NSString stringWithFormat:@"setLocation('%@')",@"廣東省廣州市白云區(qū)豪泉大廈"];
    [self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
        NSLog(@"%@----%@",result, error);
    }];
}

注意點(diǎn)

evaluateJavaScript:completionHandler:沒(méi)有返回值，JS 執(zhí)行成功還是失敗會(huì)在completionHandler 中返回。所以使用這個(gè)API 就可以避免執(zhí)行耗時(shí)的JS，或者alert 導(dǎo)致界面卡住的問(wèn)題。

運(yùn)行結(jié)果


JS_OC_WK_URL.gif
三 JavaScriptCore （UIWebView）
3.1 JS 調(diào)用原生 OC

在iOS 7之后，apple添加了一個(gè)新的庫(kù)JavaScriptCore，用來(lái)做JS交互，因此JS與原生OC交互也變得簡(jiǎn)單了許多。

首先導(dǎo)入JavaScriptCore庫(kù), 然后在OC中獲取JS的上下文。

JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

再然后定義好JS需要調(diào)用的方法，例如JS要調(diào)用share方法：
則可以在UIWebView加載url完成后，在其代理方法中添加要調(diào)用的share方法：

- (void)setupData {
    JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
    //定義好JS要調(diào)用的方法, share就是調(diào)用的share方法名
    context[@"share"] = ^() {
        NSLog(@"+++++++Begin Log+++++++");
        NSArray *args = [JSContext currentArguments];
        NSMutableString *strM = [NSMutableString string];
        for (JSValue *jsVal in args) {
            NSLog(@"%@", jsVal.toString);
            [strM appendString:jsVal.toString];
        }
        
        dispatch_async(dispatch_get_main_queue(), ^{
            UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"這是OC原生的彈出窗" message:strM delegate:self cancelButtonTitle:@"收到" otherButtonTitles:nil];
            [alertView show];
        });
        
        
        NSLog(@"-------End Log-------");
    };
}
3.2 OC 調(diào)用 JS

OC 調(diào)用 JS 方法有多種，首先介紹使用JavaScriptCore框架的方式。

  • 方式一

使用JSContext 的方法-evaluateScript，可以實(shí)現(xiàn) OC 調(diào)用 JS 方法

// 法一
- (void)transferJS {
    JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
    NSString *textJS = @"showAlert('這里是JS中alert彈出的message')";
    [context evaluateScript:textJS];
}

// 法二
- (void)transferJS {
    NSString *textJS = @"showAlert('這里是JS中alert彈出的message')";
    [[JSContext currentContext] evaluateScript:textJS];
}
  • 方式二
    使用 JSValue 的方法-callWithArguments，也可以實(shí)現(xiàn) OC 調(diào)用 JS 方法
JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
[context[@"showAlert"] callWithArguments:@[@"這里是JS中alert彈出的message"]];

效果圖


js_oc_javaScriptCore.gif
四 MessageHandler(WKWebView)

使用WKWebView的時(shí)候，如果想要實(shí)現(xiàn)JS調(diào)用OC方法，除了攔截URL之外，還有一種簡(jiǎn)單的方式。那就是利用WKWebView的新特性MessageHandler來(lái)實(shí)現(xiàn)JS調(diào)用原生方法。

4.0 怎么使用MessageHandler？

創(chuàng)建WKWebViewConfiguration對(duì)象，配置各個(gè)API對(duì)應(yīng)的MessageHandler。

WKUserContentController對(duì)象可以添加多個(gè)scriptMessageHandler。

然后在界面即將顯示的時(shí)候添加MessageHandler

- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    
    // addScriptMessageHandler 很容易導(dǎo)致循環(huán)引用
    // 控制器 強(qiáng)引用了WKWebView,WKWebView copy(強(qiáng)引用了）configuration， configuration copy （強(qiáng)引用了）userContentController
    // userContentController 強(qiáng)引用了 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"];
}

需要注意的是addScriptMessageHandler很容易引起循環(huán)引用，導(dǎo)致控制器無(wú)法被釋放，所以需要移除MessageHandler

- (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"];
}
4.1 實(shí)現(xiàn)協(xié)議方法 - JS調(diào)用 OC

這里實(shí)現(xiàn)了兩個(gè)協(xié)議<WKUIDelegate,WKScriptMessageHandler>，WKUIDelegate是因?yàn)槲以贘S中彈出了alert 。WKScriptMessageHandler是因?yàn)槲覀円幚鞪S調(diào)用OC方法的請(qǐng)求。

#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"]) {
        [self scanAction];
    } else if ([message.name isEqualToString:@"Location"]) {
        [self getLocation];
    } else if ([message.name isEqualToString:@"Share"]) {
        [self shareWithParams:message.body];
    }
}

WKScriptMessage有兩個(gè)關(guān)鍵屬性name 和 body。
因?yàn)槲覀兘o每一個(gè)OC 方法取了一個(gè)name，那么我們就可以根據(jù)name 來(lái)區(qū)分執(zhí)行不同的方法。body 中存著JS 要給OC 傳的參數(shù)。

關(guān)于參數(shù)body 的解析，我就舉一個(gè)body中放字典的例子，其他的稍后可以看demo。
解析JS 調(diào)用OC 實(shí)現(xiàn)分享的參數(shù)：

- (void)shareWithParams:(NSDictionary *)params {
    if (![params isKindOfClass:[NSDictionary class]]) {
        return;
    }
    NSString *title = [params objectForKey:@"title"];
    NSString *content = [params objectForKey:@"content"];
    NSString *url = [params objectForKey:@"url"];
    
    // 在這里執(zhí)行分享的操作
    NSLog(@"在這里執(zhí)行分享的操作");
    
    // 將分享結(jié)果返回給js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.webView evaluateJavaScript:jsStr completionHandler:^(id result, NSError *error) {
        NSLog(@"%@----%@",result, error);
    }];
}

message.boby 就是JS 里傳過(guò)來(lái)的參數(shù)。我們不同的方法先做一下容錯(cuò)性判斷。然后正常取值就可以了。

4.2 處理HTML中JS調(diào)用

下面只列舉一個(gè)shareClick()方法，其他看Demo

// 傳字典              
function shareClick(){
  window.webkit.messageHandlers.Share.postMessage({title:'測(cè)試分享的標(biāo)題',content:'測(cè)試分享的內(nèi)容',url:'http://www.baidu.com'});
}

function shareResult(channel_id,share_channel,share_url) {
    var content = channel_id+","+share_channel+","+share_url;
    asyncAlert(content);
    document.getElementById("returnValue").value = content;
}
            
function asyncAlert(content) {
    setTimeout(function(){
        alert(content);
    },1);
}
4.3 OC調(diào)用JS

這里使用WKWebView 實(shí)現(xiàn)OC 調(diào)用JS方法與之前說(shuō)的文章一樣，通過(guò)
- evaluateJavaScript:completionHandler:

// 將分享結(jié)果返回給js
NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
[self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
    NSLog(@"%@----%@",result, error);
}];
4.4 使用MessageHandler的好處
  • 1.在JS中寫(xiě)起來(lái)簡(jiǎn)單，不用再用創(chuàng)建URL的方式那么麻煩了。
  • 2.JS傳遞參數(shù)更方便。使用攔截URL的方式傳遞參數(shù)，只能把參數(shù)拼接在后面，如果遇到要傳遞的參數(shù)中有特殊字符，如&、=、？等，必須得轉(zhuǎn)換，否則參數(shù)解析肯定會(huì)出錯(cuò)。

效果圖如下圖所示

JS_OC_WK_MessageHandler.gif
五 WebViewJavascriptBridge(UIWebView)

詳情看下面文章鏈接
iOS下 JS 與 OC 互相調(diào)用(五) - UIWebView+WebViewJavascriptBridge

六 WebViewJavascriptBridge(WKWebView)

詳情看下面文章鏈接
iOS下 JS 與 OC 互相調(diào)用(六) - WKWebView+WKWebViewJavascriptBridge

詳細(xì)講解請(qǐng)看下面文章

iOS下 JS 與OC 互相調(diào)用(一) - UIWebView 攔截 URL
iOS下 JS 與OC 互相調(diào)用(二) - JavaScriptCore
iOS 下 JS 與 OC 互相調(diào)用(三) - WKWebView 攔截 URL
iOS下JS與OC互相調(diào)用(四)-MessageHandler
iOS下 JS 與 OC 互相調(diào)用(五) - UIWebView+WebViewJavascriptBridge
iOS下 JS 與 OC 互相調(diào)用(六) - WKWebView+WKWebViewJavascriptBridge

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容