前言
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完整代码:
WebViewJavascriptBridge Demo
推荐阅读
在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’: ‘
- 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:
- 第三步:注册HandleName,用于给JS端调用iOS端
- 第二步:给ObjC与JS建立桥梁
- 第一步:开启日志