iOS Native與JavaScript交互
說(shuō)到 Native 與 JS 做交互，就不得不提一嘴 HyBird Mobile App。
Hybird 的翻譯結(jié)果并不是很文明(擦汗，不知道為啥很多翻譯軟件會(huì)譯為“雜種”，但我更喜歡將它翻譯為“混合、混血”)，Hybird App 我對(duì)它的理解為通過(guò) Web 網(wǎng)絡(luò)技術(shù)(如 HTML，CSS 和 JavaScript)與 Native 相結(jié)合的混合移動(dòng)應(yīng)用程序。
那么我們來(lái)看一下 Hybird 對(duì)比 Native 有哪些優(yōu)劣：
因?yàn)?Hybird 的靈活性(更改 Web 頁(yè)面內(nèi)的 JS 就可以直接生效不必重新發(fā)版)以及通用性(一份 H5 玩遍公眾號(hào)、Android、iOS)再加上門(mén)檻低(前端玩家過(guò)來(lái)可以無(wú)痛上手開(kāi)擼)的優(yōu)勢(shì)，所以在非核心功能模塊使用 Web 通過(guò) Hybird 的方式實(shí)現(xiàn)可能從各方面都會(huì)稍微好一些。而 Native 則可以在核心功能和設(shè)備硬件的調(diào)用上為 JS 提供強(qiáng)有力的支持。
雖然現(xiàn)在很多技術(shù)如 RN 和 Weex 等通過(guò) JS 直接寫(xiě) Native 的技術(shù)出現(xiàn)，對(duì) Hybird App 沖擊很大。但是由于 Hybird 技術(shù)門(mén)檻低(幾乎無(wú)學(xué)習(xí)成本)等原因，國(guó)內(nèi)很多公司包括大廠(chǎng)依舊沒(méi)有完全拋棄它，畢竟合適的才是***的!
Hybird 的發(fā)展史
H5 發(fā)布
Html5 是在 2014 年 9 月份正式發(fā)布的，這一次的發(fā)布做了一個(gè)***的改變就是“從以前的 XML 子集升級(jí)成為一個(gè)獨(dú)立集合”。
H5 滲入 Mobile App 開(kāi)發(fā)
Native APP 開(kāi)發(fā)中有一個(gè) webview 的組件(Android 中是 webview，iOS 有 UIWebview和 WKWebview)，這個(gè)組件可以加載 Html 文件。
在 H5 大行其道之前，webview 加載的 web 頁(yè)面單調(diào)(因?yàn)橹荒芗虞d一些靜態(tài)資源)。可自打 H5 火了之后，在很多仿生框架的幫助下，前端玩家們開(kāi)發(fā)的 H5 頁(yè)面在 webview 中的體驗(yàn)不俗使得 H5 開(kāi)發(fā)慢慢滲透到了 Mobile App 開(kāi)發(fā)中來(lái)。
Hybird 的現(xiàn)狀
雖然目前已經(jīng)出現(xiàn)了 RN 和 Weex 這些 JS 寫(xiě) Native 的技術(shù)，但是 Hybird 依舊沒(méi)有被淘汰。市面上絕大多說(shuō)應(yīng)用都不同程度的引用了 Web 頁(yè)面，Web 頁(yè)面中的 JS 與 Native 如何交互依然是每個(gè) iOS 猿必須掌握的技能。
JavaScriptCore
不好意思，在進(jìn)入正題之前，容我再 BB 一下。JavaScriptCore 這個(gè)庫(kù)是 Apple 在 iOS 7 之后加入的，它對(duì) iOS Native 與 JS 做交互調(diào)用產(chǎn)生了劃時(shí)代的影響。
JavaScriptCore 大體是由 4 個(gè)類(lèi)以及 1 個(gè)協(xié)議組成的：
- JSContext 是 JS 執(zhí)行上下文，你可以把它理解為 JS 運(yùn)行的環(huán)境
- JSValue 是對(duì) JavaScript 值的引用，任何 JS 中的值都可以被包裝為一個(gè) JSValue
- JSManagedValue 是對(duì) JSValue 的包裝，加入了“conditional retain”
- JSVirtualMachine 表示 JavaScript 執(zhí)行的獨(dú)立環(huán)境
還有 JSExport 協(xié)議：
實(shí)現(xiàn)將 Objective-C 類(lèi)及其實(shí)例方法，類(lèi)方法和屬性導(dǎo)出為 JavaScript 代碼的協(xié)議。
這里的 JSContext，JSValue，JSManagedValue 相對(duì)比較好理解，下面我們把 JSVirtualMachine 單拎出來(lái)說(shuō)明一下：
JSVirtualMachine 的用法和其與 JSContext 的關(guān)系
官方文檔的介紹：
JSVirtualMachine 實(shí)例表示用于 JavaScript 執(zhí)行的獨(dú)立環(huán)境。 您使用此類(lèi)有兩個(gè)主要目的：支持并發(fā) JavaScript 執(zhí)行，并管理 JavaScript 和 Objective-C 或 Swift 之間橋接的對(duì)象的內(nèi)存。
關(guān)于 JSVirtualMachine 的使用，一般情況下我們不用手動(dòng)去創(chuàng)建 JSVirtualMachine。因?yàn)楫?dāng)我們獲取 JSContext 時(shí)，獲取到的 JSContext 從屬與一個(gè) JSVirtualMachine。
每個(gè) JavaScript 上下文(JSContext 對(duì)象)都屬于一個(gè) JSVirtualMachine。 每個(gè) JSVirtualMachine 可以包含多個(gè)上下文，允許在上下文之間傳遞值(JSValue 對(duì)象)。 但是，每個(gè) JSVirtualMachine 是不同的 - 您不能將在一個(gè) JSVirtualMachine 中創(chuàng)建的值傳遞到另一個(gè) JSVirtualMachine 中的上下文。
JavaScriptCore API 是線(xiàn)程安全的 - 例如，您可以從任何線(xiàn)程創(chuàng)建 JSValue 對(duì)象或運(yùn)行 JS 腳本 - 但是，嘗試使用相同 JSVirtualMachine 的所有其他線(xiàn)程將被阻塞。 要在多個(gè)線(xiàn)程上同時(shí)運(yùn)行(并發(fā)) JavaScript 腳本，請(qǐng)為每個(gè)線(xiàn)程使用單獨(dú)的 JSVirtualMachine 實(shí)例。
JSValue 與 JavaScript 的轉(zhuǎn)換表
iOS 與 JS 交互
對(duì)于 iOS Native 與 JS 做交互我們先從調(diào)用方向上分為兩種情況來(lái)看：
- JS 調(diào)用 iOS Native
- iOS Native 調(diào)用 JS
JS 調(diào)用 iOS Native
其實(shí) JS 調(diào)用 iOS Native 也分為兩種實(shí)現(xiàn)方式：
- 假 Request 方法
- JavaScriptCore 方法
假 Request 方法
原理：其實(shí)這種方式就是利用了 webview 的代理方法，在 webview 開(kāi)始請(qǐng)求的時(shí)候截獲請(qǐng)求，判斷請(qǐng)求是否為約定好的假請(qǐng)求。如果是假請(qǐng)求則表示是 JS 想要按照約定調(diào)用我們的 Native 方法，按照約定去執(zhí)行我們的 Native 代碼就好。
UIWebView
UIWebView 代理用于截獲請(qǐng)求的代理函數(shù)，在里面做判斷就好：
- - (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
- NSURL *url = request.URL;
- // 與約定好的函數(shù)名作比較
- if ([[url scheme] isEqualToString:@"your_func_name"]) {
- // just do it
- }
- }
WKWebView
WKWebView 有兩個(gè)代理，一個(gè)是 WKNavigationDelegate，另一個(gè)是 WKUIDelegate。我們需要設(shè)置并實(shí)現(xiàn)它的 WKNavigationDelegate 方法：
- - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
- NSURL *url = navigationAction.request.URL;
- // 與約定好的函數(shù)名作比較
- if ([[url scheme] isEqualToString:@"your_func_name"]) {
- // just do it
- decisionHandler(WKNavigationActionPolicyCancel);
- return;
- }
- decisionHandler(WKNavigationActionPolicyAllow);
- }
Note: decisionHandler 當(dāng)你的應(yīng)用程序決定是允許還是取消導(dǎo)航時(shí)，要調(diào)用的塊。 該塊使用單個(gè)參數(shù)，它必須是枚舉類(lèi)型 WKNavigationActionPolicy 的常量之一。如果不調(diào)用 decisionHandler 會(huì)引起 crash。
這里補(bǔ)充一下 JS 段的代碼：
- function callNative(){
- loadURL("your_func_name://xxx");
- }
然后拿個(gè) button 標(biāo)簽用一下就好了：
- <button type="button" onclick="callNative()">Call Native!</button>
Call Native!
其實(shí)這里有個(gè)實(shí)際的栗子來(lái)的，我之前寫(xiě)過(guò)一篇文章，由于適配原因采取了假 Request 的方式也做到了解決問(wèn)題。文章鏈接貼在這里 各位想看的可以移步去看一下哈。
JavaScriptCore 方法
iOS 7 有了 JavaScriptCore 專(zhuān)門(mén)用來(lái)做 iOS Native 與 JS 的交互。我們可以在 webview 完成加載之后獲取 JSContext，然后利用 JSContext 將 JS 中的對(duì)象引用過(guò)來(lái)用 Native 代碼對(duì)其作出響應(yīng)：
- // 首先引入 JavaScriptCore 庫(kù)
- #import<JavaScriptCore/JavaScriptCore.h>
- // 然后再 UIWebView 的完成加載的代理方法中
- - (void)webViewDidFinishLoad:(UIWebView *)webView {
- // 獲取 JS 上下文
- jsContext = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
- // 做引用，將 JS 內(nèi)的元素引用過(guò)來(lái)解釋?zhuān)热绶椒梢越忉尦?nbsp;Block，對(duì)象也可以指向 OC 的 Native 對(duì)象哦
- jsContext[@"iosDelegate"] = self;
- jsContext[@"yourFuncName"] = ^(id parameter){
- // 注意這里的線(xiàn)程默認(rèn)是 web 處理的線(xiàn)程，如果涉及主線(xiàn)程操作需要手動(dòng)轉(zhuǎn)到主線(xiàn)程
- dispatch_async(dispatch_get_main_queue(), ^{
- // your code
- });
- }
- }
而 JS 這邊代碼更簡(jiǎn)單了，干脆聲明一個(gè)不解釋的函數(shù)(約定好名字的)，用于給 Native 做引用：
- var parameter = xxx;
- yourFuncName(parameter);
iOS Native 調(diào)用 JS
iOS Native 調(diào)用 JS 的實(shí)現(xiàn)方法也被 JavaScriptCore 劃分開(kāi)來(lái)：
- webview 直接注入 JS 并執(zhí)行
- JavaScriptCore 方法
webview 直接注入 JS 并執(zhí)行
- 在 iOS 平臺(tái)，webview 有注入并執(zhí)行 JS 的 API。
UIWebView
UIWebView 有直接注入 JS 的方法：
- NSString *jsStr = [NSString stringWithFormat:@"showAlert('%@')", @"alert msg"];
- [_webView stringByEvaluatingJavaScriptFromString:jsStr];
Note: 這個(gè)方法會(huì)返回運(yùn)行 JS 的結(jié)果( nullable NSString * )，它是一個(gè)同步方法，會(huì)阻塞當(dāng)前線(xiàn)程!盡管此方法不被棄用，但***做法是使用 WKWebView 類(lèi)的 evaluateJavaScript：completionHandler：method 。
官方文檔：
The stringByEvaluatingJavaScriptFromString: method waits synchronously for JavaScript evaluation to complete. If you load web content whose JavaScript code you have not vetted, invoking this method could hang your app. Best practice is to adopt the WKWebView class and use its evaluateJavaScript:completionHandler: method instead.
WKWebView
不同于 UIWebView，WKWebView 注入并執(zhí)行 JS 的方法不會(huì)阻塞當(dāng)前線(xiàn)程。因?yàn)榭紤]到 webview 加載的 web content 內(nèi) JS 代碼不一定經(jīng)過(guò)驗(yàn)證，如果阻塞線(xiàn)程可能會(huì)掛起 App。
- NSString *jsStr = [NSString stringWithFormat:@"setLocation('%@')", @"北京市東城區(qū)南鑼鼓巷納福胡同xx號(hào)"];
- [_webview evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
- NSLog(@"%@----%@", result, error);
- }];
Note: 方法不會(huì)阻塞線(xiàn)程，而且它的回調(diào)代碼塊總是在主線(xiàn)程中運(yùn)行。
官方文檔：
- Evaluates a JavaScript string.
- The method sends the result of the script evaluation (or an error) to the completion handler. The completion handler always runs on the main thread.
JavaScriptCore 方法
上面簡(jiǎn)單提到過(guò) JavaScriptCore 庫(kù)提供的 JSValue 類(lèi)，這里再提供一下官方文檔對(duì) JSValue 的介紹翻譯：
JSValue 實(shí)例是對(duì) JavaScript 值的引用。 您可以使用 JSValue 類(lèi)來(lái)轉(zhuǎn)換 JavaScript 和 Objective-C 或 Swift 之間的基本值(如數(shù)字和字符串)，以便在本機(jī)代碼和 JavaScript 代碼之間傳遞數(shù)據(jù)。
不過(guò)你也看到了我貼在上面的 OC 和 JS 數(shù)據(jù)類(lèi)型轉(zhuǎn)換表，那里面根本沒(méi)有限定為官方文檔所說(shuō)的基本值。如果你不熟悉 JS 的話(huà)，我這里解釋一下為什么 JSValue 也可以指向 JS 中的對(duì)象和函數(shù)，因?yàn)?JS 語(yǔ)言不區(qū)分基本值和對(duì)象以及函數(shù)，在 JS 中“萬(wàn)物皆為對(duì)象”。
好了下面直接 show code：
- // 首先引入 JavaScriptCore 庫(kù)
- #import<JavaScriptCore/JavaScriptCore.h>
- // 先獲取 JS 上下文
- self.jsContext = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
- // 如果涉及 UI 操作，切回主線(xiàn)程調(diào)用 JS 代碼中的 YourFuncName，通過(guò)數(shù)組@[parameter] 入?yún)?nbsp;
- dispatch_async(dispatch_get_main_queue(), ^{
- JSValue *jsValue = self.jsContext[@"YourFuncName"];
- [jsValue callWithArguments:@[parameter]];
- });
上面的代碼調(diào)用了 JS 代碼中 YourFuncName 函數(shù)，并且給函數(shù)加了 @[parameter] 作為入?yún)ⅰ榱朔奖汩喿x，這里再補(bǔ)充一下 JS 代碼：
- function YourFuncName(arguments){
- var result = arguments;
- // do what u want to do
- }
WKWebView 與 JS 交互的特有方法
關(guān)于 WKWebView 與 UIWebView 的區(qū)別就不在本文加以詳細(xì)說(shuō)明了，更多信息還請(qǐng)自行查閱。這里要講的是 WKWebView 在與 JS 的交互時(shí)的特有方法：
- WKUIDelegate 方法
- MessageHandler 方法
WKUIDelegate 方法
對(duì)于 WKWebView 上文提到過(guò)，除了 WKNavigationDelegate，它還有一個(gè) WKUIDelegate，這個(gè) WKUIDelegate 是做什么用的呢?
WKUIDelegate 協(xié)議包含一些函數(shù)是監(jiān)聽(tīng) web JS 想要顯示 alert 或 confirm 時(shí)觸發(fā)的。我們?nèi)绻?WKWebView 中加載一個(gè) web 并且想要 web JS 的 alert 或 confirm 正常彈出，就需要實(shí)現(xiàn)對(duì)應(yīng)的代理方法。
Note: 如果沒(méi)有實(shí)現(xiàn)對(duì)應(yīng)的代理方法，則 webview 將會(huì)按照默認(rèn)操作去做出行為。
- Alert: If you do not implement this method, the web view will behave as if the user selected the OK button.
- Confirm: If you do not implement this method, the web view will behave as if the user selected the Cancel button.
我們這里就拿 alert 舉例，相信各位讀者可以自己舉一反三。下面是在 WKUIDelegate 監(jiān)聽(tīng) web 要顯示 alert 的代理方法用 Native UIAlertController 替代 JS 中的 alert 顯示的栗子 ：
- - (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(void))completionHandler {
- // 用 Native 的 UIAlertController 彈窗顯示 JS 將要提示的信息
- UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"提醒" message:message preferredStyle:UIAlertControllerStyleAlert];
- [alert addAction:[UIAlertAction actionWithTitle:@"知道了" style:UIAlertActionStyleCancel handler:^(UIAlertAction * _Nonnull action) {
- // 函數(shù)內(nèi)必須調(diào)用 completionHandler
- completionHandler();
- }]];
- [self presentViewController:alert animated:YES completion:nil];
- }
MessageHandler 方法
MessageHandler 是繼 Native 截獲 JS 假請(qǐng)求后另一種 JS 調(diào)用 Native 的方法，該方法利用了 WKWebView 的新特性實(shí)現(xiàn)。對(duì)比截獲假 Request 的方法來(lái)說(shuō)，MessageHandler 傳參數(shù)更加簡(jiǎn)單方便。
MessageHandler 指什么?
WKUserContentController 類(lèi)有一個(gè)方法:
- - (void)addScriptMessageHandler:(id )scriptMessageHandler name:(NSString *)name;
該方法用來(lái)添加一個(gè)腳本處理器，可以在處理器內(nèi)對(duì) JS 腳本調(diào)用的方法做出處理，從而達(dá)到 JS 調(diào)用 Native 的目的。
那么 WKUserContentController 類(lèi)和 WKWebView 有毛關(guān)系呢?
在 WKWebView 的初始化函數(shù)中有一個(gè)入?yún)?configuration，它的類(lèi)型是 WKWebViewConfiguration。WKWebViewConfiguration 中包含一個(gè)屬性 userContentController，這個(gè) userContentController 就是 WKUserContentController 類(lèi)型的實(shí)例，我們可以用這個(gè) userContentController 來(lái)添加不同名稱(chēng)的腳本處理器。
MessageHandler 的坑
那么回到 - (void)addScriptMessageHandler:name: 方法上面，該方法添加一個(gè)腳本消息處理器(***個(gè)入?yún)? scriptMessageHandler)，并且給這個(gè)處理器起一個(gè)名字(第二個(gè)入?yún)? name)。不過(guò)這個(gè)函數(shù)在使用的時(shí)候有個(gè)坑：scriptMessageHandler 入?yún)?huì)被強(qiáng)引用，那么如果你把當(dāng)前 WKWebView 所在的 UIViewController 作為***個(gè)入?yún)ⅲ@個(gè) viewController 被他自己所持有的 webview.configuration. userContentController 所持有，就會(huì)造成循環(huán)引用。
一般我們通過(guò) - (void)removeScriptMessageHandlerForName: 方法刪掉 userContentController 對(duì) viewController 的強(qiáng)引用。所以一般情況下我們的代碼會(huì)在 viewWillAppear 和 viewWillDisappear 成對(duì)兒的添加和刪除 MessageHandler：
- - (void)viewWillAppear:(BOOL)animated {
- [super viewWillAppear:animated];
- [self.webview.configuration.userContentController addScriptMessageHandler:self name:@"YourFuncName"];
- }
- - (void)viewWillDisappear:(BOOL)animated {
- [super viewWillDisappear:animated];
- [self.webview.configuration.userContentController removeScriptMessageHandlerForName:@"YourFuncName"];
- }
WKScriptMessageHandler 協(xié)議
WKScriptMessageHandler 是腳本信息處理器協(xié)議，如果想讓一個(gè)對(duì)象具有腳本信息處理能力(比如上文中 webview 的所屬 viewController 也就是上面代碼的 self)就必須使其遵循該協(xié)議。
WKScriptMessageHandler 內(nèi)部簡(jiǎn)單的一匹，只有一個(gè)方法，我們必須要實(shí)現(xiàn)該方法(@required)：
- // WKScriptMessageHandler 協(xié)議方法，在接收到腳本信息時(shí)觸發(fā)
- - (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message {
- // message 有兩個(gè)屬性：name 和 body
- // message.name 可以用于區(qū)別要做的處理
- if ([message.name isEqualToString:@"YourFuncName"]) {
- // message.body 相當(dāng)于 JS 傳遞過(guò)來(lái)的參數(shù)
- NSLog(@"JS call native success %@", message.body);
- }
- }
老樣子，補(bǔ)充一下 JS 的代碼：
- // <name> 換 YourFuncName，<messageBody> 換你要的入?yún)⒓纯?nbsp;
- window.webkit.messageHandlers.<name>.postMessage(<messageBody>)
搞定收工!
總結(jié)
- 這篇文章簡(jiǎn)單的介紹了一下 Hybird Mobile App(其中還包括 Hybird 的發(fā)展簡(jiǎn)史)。
- 介紹了 JavaScriptCore 的組成，并且把很多文章沒(méi)有講清楚的 JSVirtualMachine 與 JSContext 和 JSValue 之間的關(guān)系用圖片的形式表述出來(lái)。(JSVirtualMachine 包含 JSContext 包含 JSValue，都是 1 對(duì) n 的關(guān)系，且由于同一個(gè) JSVirtualMachine 下的代碼會(huì)相互阻塞，所以如果想異步執(zhí)行交互需要在不同的線(xiàn)程聲明 JSVirtualMachine 并發(fā)執(zhí)行)
- 從調(diào)用方向的角度把 JS 與 iOS Native 相互調(diào)用的方式方法分別用代碼講解了一遍。
- ***補(bǔ)充了 WKWebView 與 JS 交互特有的方法：WKUIDelegate 和 MessageHandler。
如果您覺(jué)得我的文章表述錯(cuò)誤請(qǐng)您予以指正，您的指正將會(huì)讓我避免誤導(dǎo)很多人。
