iOS OC与JS的交互(WebViewJavascriptBridge实现)

在开发的过程中,我们会遇到原生app与web的交互,除了用WebView加载HTML5文件显示外,还可能需要和WebView进行交互,例如点击WebView上面的按钮调用原生OC的函数方法,上一章总结了JavaScriptCore的用法,这一章我们来学习另一种方法WebViewJavascriptBridge这个开源项目。

WebViewJavascriptBridge是一个轻量的用于OC与JS交互的第三方库。WebViewJavascriptBridge是支持到iOS6之前的版本的,用于支持Native的iOS与JavaScript交互。如果需要支持到iOS6之前的app,使用它是很不错的。本篇讲讲WebViewJavascriptBridge的基本原理及详细讲讲如何去使用,包括iOS端的使用和JS端的使用。

基本原理
WebViewJavascriptBridge的本质也是通过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;
}
}

代码解释:
通过webView代理拦截后,首先通过isBridgeLoadedURL方法判断是否是bridge即需要桥接的URL,如果是,则通过injectJavascriptFile方法注入JS;否则判断URL是否是队列消息,如果是,那么执行查询命令JS并刷新队列消息;否则URL被识别为未知的消息。
使用步骤

使用它可以用CocoaPods导入:
pod 'WebViewJavascriptBridge', '~> 5.0.5'

引入WebViewJavascriptBridge

// 开启日志
[WebViewJavascriptBridge enableLogging];
// 给webview建立JS与OjbC的沟通桥梁
self.bridge = [WebViewJavascriptBridge bridgeForWebView:self.webView];
[self.bridge setWebViewDelegate:self];

JS调用OC

本章节demo的HTML代码如下:

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title> 来自html中的jsCallOC标题</title>
<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>
 <h2>WebViewJavascriptBridge</h2>
 <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给ObjC提供公开的API,ObjC端通过注册,就可以在JS端调用此API时,得到回调。ObjC端可以在处理完成后,反馈给JS,这样写就是在载入页面完成时就先调用*/
    document.getElementById('callmeId').onclick = function (e) {
      log('JS端 call OC端: callme')
      bridge.callHandler('callme', {'blogURL': 'https://github.com/maying1992'}, function(response) {
         log('JS端 得到 response', response)
      })
    }
                                
    document.getElementById('callAlertId').onclick = function (e) {
      log('JS端 call OC端: callAlert')
      bridge.callHandler('callAlert', {'title': '来自JS的message'}, function(response) {
         log('JS端 得到 response', response)
      })
    }
        
    /*JS给ObjC提供公开的API,在ObjC端可以手动调用JS的这个API。接收ObjC传过来的参数,且可以回调ObjC*/
    bridge.registerHandler('factorial', function(data, responseCallback) {
                           
      log("Get user information from ObjC: ", data)
      //JS反馈给OC
      responseCallback({'result': factorial(data)})
    })
                                
    /*我们在这注册一个OC调用js的方法,不带参数,且不用JS反馈回调oc*/
    bridge.registerHandler('openWebviewBridge', function() {
      log("openWebviewBridge was called with by ObjC")
    })
                                        
    var factorial = function(n) { 
        if (n < 0)            
        return;               
        if (n === 0)      
        return 1;              
        return n * factorial(n - 1)
                                
    };                     
})
                             
 </script>

 <div id='buttons'></div> <div id='log'></div>
 <div>
<input type="button" value="JS调用OC传值" id="callmeId"/>
</div>
<div>
<input type="button" value="调用原生Alert" id="callAlertId">
</div>
</body>
</html>

1.JS调用原生callme方法,首先需要在OC端注册此方法。如果JS端需要返回值的话我们可以通过responseCallback将返回值传过去。

[self.bridge registerHandler:@"callme" handler:^(id data, WVJBResponseCallback responseCallback) {
    NSLog(@"执行任务了, data from js is %@", data);
    if (responseCallback) {
        //OC反馈给JS
        responseCallback(@"这是OC给JS的反馈哦~");
    }
}];

2.同时JS端调用OC方法,通过bridge.callHandler来调用:

bridge.callHandler('callme', {'blogURL': 'https://github.com/maying1992'}, function(response) {
         log('JS端 得到 response', response)
      })

这样双方建立了通道,实现了JS调用OC原生方法。
参数说明:callme是OC端注册的方法,在OC端注册后,JS可以通过这个方法名与OC交互。比如点击JS调用OC传值这个按钮时,就会执行callHandle方法,JS端将参数传给了iOS端,当iOS端收到参数时,通过responseCallback回调反馈给JS端,JS端收到返回值。

效果图如下

屏幕快照 2016-10-10 下午1.21.37.png

打印日志

屏幕快照 2016-10-10 下午1.20.03.png
屏幕快照 2016-10-10 下午1.23.50.png

打印日志

屏幕快照 2016-10-10 下午1.24.08.png

OC调用JS
1.OC调用JS端factorial函数,首先在JS端注册factorial方法

/*JS给ObjC提供公开的API,在ObjC端可以手动调用JS的这个API。接收ObjC传过来的参数,且可以回调ObjC*/
    bridge.registerHandler('factorial', function(data, responseCallback) {     
      log("Get user information from ObjC: ", data)
      //JS反馈给OC
      responseCallback({'result': factorial(data)})
    })

2.同时OC调用JS方法,通过[self.bridge callHandler:@"factorial" data:responseCallback:^(id responseData) {}]调用:

// OC调用JS方法
//OC给JS提供公开的API,JS端通过注册,就可以在OC端调用此API并传入参数时,得到回调。
NSLog(@"OC端 call JS端");
[self.bridge callHandler:@"factorial" data:[NSNumber numberWithInteger:[textField.text integerValue]] responseCallback:^(id responseData) {
    resultL.text = [NSString stringWithFormat:@"结果%@",[responseData objectForKey:@"result"]];
    NSLog(@"OC端得到回调responseData: %@",responseData);
}];

通过以上代码实现了OC调用JS。

效果图如下:

屏幕快照 2016-10-10 下午1.26.12.png

打印日志


屏幕快照 2016-10-10 下午1.26.26.png

接下来是OC调用JS方法(无参)

JS端注册

/*我们在这注册一个js调用OC的方法,不带参数,且不用ObjC端反馈结果给JS*/
bridge.registerHandler('openWebviewBridge', function() {
      log("openWebviewBridge was called with by ObjC")
    })

OC端调用

//OC给JS提供公开的API,JS端通过注册,就可以在OC端调用此API,没有参数传入和回调。
[self.bridge callHandler:@"openWebviewBridge" data:nil];
NSLog(@"OC端 call JS端: openWebviewBridge");

源码
喜欢的亲们随手给个星星

总结
在写这个demo的过程中遇到不少问题,尤其是JS端,需要注意的是JS端一定要写log,否则没有回调。总的来说相对于JavaScriptCore更复杂一点,缺点就是要固定的加入相关代码,JS端代码要在固定的函数内添加,本文只是简单的介绍了交互的基本原理和几个常用的方法,仅供交流学习,如果有理解错误的地方还请大家多多指教。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容