碼上快樂

相關內容    簡體    繁體

WebViewJavascriptBridge詳細使用

本文轉載自   查看原文   2018-12-01 16:42   1520    花開手記

前言

https://www.jianshu.com/p/e37ccf32cb5b

WebViewJavascriptBridge是支持到iOS6之前的版本的，用於支持native的iOS與javascript交互。如果需要支持到iOS6之前的app，使用它是很不錯的。本篇講講WebViewJavascriptBridge的基本原理及詳細講講如何去使用，包括iOS端的使用和JS端的使用。

經過多番百度、Google，發現WebViewJavascriptBridge的資源講解不是翻譯官方文檔就是直接說官方提供的demo。但是筆者在寫這個demo時也遇到了不少問題，也想看看大家是怎么使用的，特別是JS端，弄了好久都沒有回調，原來是因為log。

寫下本篇文章，希望大家少走彎路吧！

iOS與H5交互的方案

縱觀所有iOS與H5交互的方案，有以下幾種：

  • 第一種：有很多的app直接使用在webview的代理中通過攔截的方式與native進行交互，通常是通過攔截url scheme判斷是否是我們需要攔截處理的url及其所對應的要處理的功能是什么。任意版本都支持。
  • 第二種：iOS7之后出了JavaScriptCore.framework用於與JS交互，但是不支持iOS6，對於還需要支持iOS6的app，就不能考慮這個了。若需要了解，看最后的推薦閱讀。
  • 第三種：WebViewJavascriptBridge開源庫使用，本質上，它也是通過webview的代理攔截scheme，然后注入相應的JS。
  • 第四種：react-native，這個沒玩過（與前三種不同）。

本篇文章專講講WebViewJavascriptBridge。

WebViewJavascriptBridge的基本原理

我們看看WebViewJavascriptBridge.m中Webview代理攔截的代碼：

- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
    if (webView != _webView) { return YES; }
    NSURL *url = [request URL];
    __strong WVJB_WEBVIEW_DELEGATE_TYPE* strongDelegate = _webViewDelegate;
    if ([_base isCorrectProcotocolScheme:url]) {
        if ([_base isBridgeLoadedURL:url]) {
            [_base injectJavascriptFile];
        } else if ([_base isQueueMessageURL:url]) {
            NSString *messageQueueString = [self _evaluateJavascript:[_base webViewJavascriptFetchQueyCommand]];
            [_base flushMessageQueue:messageQueueString];
        } else {
            [_base logUnkownMessage:url];
        }
        return NO;
    } else if (strongDelegate && [strongDelegate respondsToSelector:@selector(webView:shouldStartLoadWithRequest:navigationType:)]) {
        return [strongDelegate webView:webView shouldStartLoadWithRequest:request navigationType:navigationType];
    } else {
        return YES;
    }
}

在攔截后，通過先通過-isBridgeLoadedURL:方法判斷URL是否是需要bridge的URL，若是，則通過injectJavascriptFile方法注入JS；否則判斷URL是否是隊列消息，若是，則執行查詢命令JS並刷新消息隊列；最后，URL被識別為未知的消息。

JS端如何使用

下面是本demo的HTML完整代碼：

<!doctype html>
<html>
  <head>
  <meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=1.0, maximum-scale=1.0">
    <style type='text/css'>
      html { font-family:Helvetica; color:#222; }
      h1 { color:steelblue; font-size:24px; margin-top:24px; }
      button { margin:0 3px 10px; font-size:12px; }
      .logLine { border-bottom:1px solid #ccc; padding:4px 2px; font-family:courier; font-size:11px; }
    </style>
  </head>
  
  <body>
    <h1>WebViewJavascriptBridge Demo</h1>
    
    <script>
      window.onerror = function(err) {
        log('window.onerror: ' + err)
      }
    
      /*這段代碼是固定的，必須要放到js中*/
      function setupWebViewJavascriptBridge(callback) {
        if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
        if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
        window.WVJBCallbacks = [callback];
        var WVJBIframe = document.createElement('iframe');
        WVJBIframe.style.display = 'none';
        WVJBIframe.src = 'wvjbscheme://__BRIDGE_LOADED__';
        document.documentElement.appendChild(WVJBIframe);
        setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
      }
    
      /*與OC交互的所有JS方法都要放在此處注冊，才能調用通過JS調用OC或者讓OC調用這里的JS*/
      setupWebViewJavascriptBridge(function(bridge) {
       var uniqueId = 1
       function log(message, data) {
         var log = document.getElementById('log')
         var el = document.createElement('div')
         el.className = 'logLine'
         el.innerHTML = uniqueId++ + '. ' + message + ':<br/>' + JSON.stringify(data)
         if (log.children.length) {
            log.insertBefore(el, log.children[0])
         } else {
           log.appendChild(el)
         }
       }
       /* Initialize your app here */
      
       /*我們在這注冊一個js調用OC的方法，不帶參數，且不用ObjC端反饋結果給JS：打開本demo對應的博文*/
       bridge.registerHandler('openWebviewBridgeArticle', function() {
          log("openWebviewBridgeArticle was called with by ObjC")
       })
       /*JS給ObjC提供公開的API，在ObjC端可以手動調用JS的這個API。接收ObjC傳過來的參數，且可以回調ObjC*/
       bridge.registerHandler('getUserInfos', function(data, responseCallback) {
         log("Get user information from ObjC: ", data)
         responseCallback({'userId': '123456', 'blog': '標哥的技術博客'})
       })
                                  
       /*JS給ObjC提供公開的API，ObjC端通過注冊，就可以在JS端調用此API時，得到回調。ObjC端可以在處理完成后，反饋給JS，這樣寫就是在載入頁面完成時就先調用*/
       bridge.callHandler('getUserIdFromObjC', function(responseData) {
         log("JS call ObjC's getUserIdFromObjC function, and js received response:", responseData)
       })
 
       document.getElementById('blogId').onclick = function (e) {
         log('js call objc: getBlogNameFromObjC')
         bridge.callHandler('getBlogNameFromObjC', {'blogURL': 'http://www.henishuo.com'}, function(response) {
                          log('JS got response', response)
                          })
       }
     })
      
    </script>
    
    <div id='buttons'></div> <div id='log'></div>
    
    <div>
       <input type="button" value="getBlogNameFromObjC" id="blogId"/>
    </div>
  </body>
</html>

推薦閱讀

 

 

在JS端，嵌入步驟是：

  • 第一步：將下面的代碼放在JS中：
  • /*這段代碼是固定的，必須要放到js中*/
function setupWebViewJavascriptBridge(callback) {
    if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
    if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
    window.WVJBCallbacks = [callback];
    var WVJBIframe = document.createElement('iframe');
    WVJBIframe.style.display = 'none';
    WVJBIframe.src = 'wvjbscheme://__BRIDGE_LOADED__';
    document.documentElement.appendChild(WVJBIframe);
    setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
}

    這段代碼是固定的，必須要放到js中。

  • 第二步：在下面的方法體里寫相關JS代碼：
  • setupWebViewJavascriptBridge(function(bridge) {
    /* Initialize your app here */
    所有與iOS交互的JS代碼放這里！
})

    JS如何調用iOS代碼

    通過bridge.callHandler來調用：

    bridge.callHandler('getBlogNameFromObjC',
                 {'blogURL': 'http://www.henishuo.com'},
                 function callback(response) {
                   log('JS got response', response)
                 }
})

    其中，各參數說明如下：

    • getBlogNameFromObjC：是iOS端register的handleName，在iOS端注冊后，JS就可以直接通過這個handleName與iOS交互。比如，當點擊某個按鈕時，就執行上面這一段代碼，結果就是js端將參數傳給了iOS端，iOS端收到參數，然后通過回調給js，js會收到response，然后打印出來
    • {‘blogURL’: ‘http://www.henishuo.com’}：這是JSON字符串，傳到iOS端會被WebViewJavascriptBridge自動轉換成id對象，然后在回調處看到的就是字典對象了。
    • callback：這是個js函數名，在iOS端收到回調后，拿到了參數，然后通過閉包回調反饋給js端，這個反饋就是通過callback函數來傳值給js。

    • JS端加入WebViewJavascriptBridge代碼注意事項

      如果在下面的函數體內有任何錯誤，都不會有打印日志，也不會有任何回調：

      setupWebViewJavascriptBridge(function(bridge) {
    /* Initialize your app here */
    所有與iOS交互的JS代碼放這里！
})

      因此，如果遇到什么也沒有輸出，說明你寫錯了。另外，上面有demo中，log函數是自定義的，不是系統的，因此如果沒有加入這個函數的定義，調用它也會導致不能交互。

    • iOS端如何使用

      • 第一步：開啟日志 
        // 開啟日志，方便調試
[WebViewJavascriptBridge enableLogging];
        • 第二步：給ObjC與JS建立橋梁 
          // 給哪個webview建立JS與OjbC的溝通橋梁
self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
 
// 設置代理，如果不需要實現，可以不設置
[self.bridge setWebViewDelegate:self];
          • 第三步：注冊HandleName，用於給JS端調用iOS端 
            // JS主動調用OjbC的方法
// 這是JS會調用getUserIdFromObjC方法，這是OC注冊給JS調用的
// JS需要回調，當然JS也可以傳參數過來。data就是JS所傳的參數，不一定需要傳
// OC端通過responseCallback回調JS端，JS就可以得到所需要的數據
[self.bridge registerHandler:@"getUserIdFromObjC" handler:^(id data, WVJBResponseCallback responseCallback) {
    NSLog(@"js call getUserIdFromObjC, data from js is %@", data);
    if (responseCallback) {
      // 反饋給JS
      responseCallback(@{@"userId": @"123456"});
    }
}];
  
[self.bridge registerHandler:@"getBlogNameFromObjC" handler:^(id data, WVJBResponseCallback responseCallback) {
    NSLog(@"js call getBlogNameFromObjC, data from js is %@", data);
    if (responseCallback) {
      // 反饋給JS
      responseCallback(@{@"blogName": @"標哥的技術博客"});
    }
}];
            • 第四步：直接調用JS端注冊的HandleName
            • [self.bridge callHandler:@"getUserInfos" data:@{@"name": @"標哥"} responseCallback:^(id responseData) {
    NSLog(@"from js: %@", responseData);
}];

              源代碼

              大家可以到GITHUB下載源代碼，喜歡就隨手給個Star：WebViewJavascriptBridgeDemo


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 WebViewJavascriptBridge詳細使用 vue項目使用WebViewJavascriptBridge iOS WebViewJavascriptBridge初步嘗試與圖文詳細講解 IOS-WebViewJavascriptBridge使用說明 WKWebview 和 WebViewJavascriptBridge WebViewJavascriptBridge淺析 iOS開發之Objective-C(Swift)與JavaScript交互·WebViewJavascriptBridge使用篇 WebViewJavascriptBridge 原理分析 MobaXterm詳細使用教程--1 SmartGit的使用教程(詳細)
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM