WebViewJavascriptBridge用法
参考文献:http://www.cnblogs.com/jiang-xiao-yan/p/5345755.html
http://blog.csdn.net/sk719887916/article/details/51569599
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代理拦截的代码:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
- (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 && [strongDelegaterespondsToSelector:@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端,嵌入步骤是:
- 第一步:将下面的代码放在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代码注意事项
如果在下面的函数体内有任何错误,都不会有打印日志,也不会有任何回调:
1
2
3
4
5
6
|
setupWebViewJavascriptBridge(function(bridge) {
/* Initialize your app here */
所有与iOS交互的JS代码放这里!
})
|
因此,如果遇到什么也没有输出,说明你写错了。另外,上面有demo中,log函数是自定义的,不是系统的,因此如果没有加入这个函数的定义,调用它也会导致不能交互。
iOS端如何使用
- 第一步:开启日志
1
2
3
4
|
// 开启日志,方便调试
[WebViewJavascriptBridge enableLogging];
|
- 第二步:给ObjC与JS建立桥梁
1
2
3
4
5
6
7
|
// 给哪个webview建立JS与OjbC的沟通桥梁
self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
// 设置代理,如果不需要实现,可以不设置
[self.bridge setWebViewDelegate:self];
|
- 第三步:注册HandleName,用于给JS端调用iOS端
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
// 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
1
2
3
4
5
|
[self.bridge callHandler:@"getUserInfos" data:@{@"name": @"标哥"} responseCallback:^(id responseData) {
NSLog(@"from js: %@", responseData);
}];
|
android与H5交互的方案
JS调用Android
//Android function setupWebViewJavascriptBridge(callback) { if (checkOS() === "ios") return ""; if (window.WebViewJavascriptBridge) { callback(WebViewJavascriptBridge) } else { document.addEventListener( 'WebViewJavascriptBridgeReady' , function () { callback(WebViewJavascriptBridge) }, false ); } }
原生调js
//在改function 中添加原生调起js方法 setupWebViewJavascriptBridge(function(bridge) { bridges = bridge; //注册原生调起方法 //参数1: buttonjs 注册flag 供原生使用,要和原生统一 //参数2: data 是原生传给js 的数据 //参数3: responseCallback 是js 的回调,可以通过该方法给原生传数据 bridge.registerHandler("buttonjs",function(data,responseCallback){ document.getElementById("show").innerHTML = "buuton js" + data; responseCallback("button js callback"); }); })