本篇为大家介绍一个优秀的国人开发开源小项目:WebViewJavascriptBridge。
==WebViewJavascriptBridge的介绍==
#下载:https://github.com/marcuswestin/WebViewJavascriptBridge
#关于WebViewJavascriptBridge的介绍:http://blog.csdn.net/yanghua_kobe/article/details/8209751
==WebViewJavascriptBridge(在与现有的业务代码结合使用中)的小问题==
*demo部分( ExampleApp.html界面中第50行):
bridge.callHandler('testObjcCallback', {'foo':'bar'}, function(response) {
由于底层回传是两个参数responseCallback(message.error,message.responseData),因此reponse对应的是message.error,此demo中得到的是undefinded;
*源码实现部分(webview加载回调事件webViewDidFinishLoad):
- (void)webViewDidFinishLoad:(UIWebView *)webView{
if (webView != _webView) {return; }
if (![[_webViewstringByEvaluatingJavaScriptFromString:@"typeofWebViewJavascriptBridge == 'object'"] isEqualToString:@"true"]){
NSString *filePath = [[NSBundle mainBundle]pathForResource:@"WebViewJavascriptBridge.js"ofType:@"txt"];
NSString *js = [NSStringstringWithContentsOfFile:filePath encoding:NSUTF8StringEncodingerror:nil];
[_webViewstringByEvaluatingJavaScriptFromString:js];
}
if (self.startupMessageQueue){
for (id queuedMessage inself.startupMessageQueue) {
[self_dispatchMessage:queuedMessage];
}
self.startupMessageQueue = nil;
}
if (self.webViewDelegate&& [self.webViewDelegaterespondsToSelector:@selector(webViewDidFinishLoad:)]){
[self.webViewDelegatewebViewDidFinishLoad:webView];
}
}
WebViewJavascriptBridge的使用流程中要将webview的delegate首先设置为自身,这是必须条件,
如果现有的业务代码中需要使用webview的回调事件,则需要在初始化WebViewJavascriptBridge时制定业务代码自身为后续的delegate;
在设定后续delegate之后,会出现问题;
以上代码会造成webViewDidFinishLoad被调用两次:业务代码中设置webview的回调事件,而以上代码中引入.js.txt资源,资源里有对dom的直接修改,也会触发webViewDidFinishLoad回调函数;
由此造成业务代码中的webViewDidFinishLoad会被执行两次,形成错误或者不必要的多次调用;
处理:在js.txt资源引入之前不执行后续的代码处理,即阻止第一次的viewdidload的后续调用,修改后如下:
- (void)webViewDidFinishLoad:(UIWebView *)webView{
if (webView != _webView) {return; }
if (![[_webViewstringByEvaluatingJavaScriptFromString:@"typeofWebViewJavascriptBridge == 'object'"] isEqualToString:@"true"]){
NSString *filePath = [[NSBundle mainBundle]pathForResource:@"WebViewJavascriptBridge.js"ofType:@"txt"];
NSString *js = [NSStringstringWithContentsOfFile:filePath encoding:NSUTF8StringEncodingerror:nil];
[_webViewstringByEvaluatingJavaScriptFromString:js];
}
//2012-12-3对于源码的变动,在js.txt加载之前,对于业务后续调用,不处理;
else{
if (self.startupMessageQueue) {
for (idqueuedMessage in self.startupMessageQueue) {
[self_dispatchMessage:queuedMessage];
}
self.startupMessageQueue = nil;
}
if (self.webViewDelegate &&[self.webViewDelegaterespondsToSelector:@selector(webViewDidFinishLoad:)]){
[self.webViewDelegatewebViewDidFinishLoad:webView];
}
}
}
*源码部分(初始化函数):nil不能作为NSdictionary的value;
错误:
- (void)callHandler:(NSString *)handlerName {
[self callHandler:handlerNamedata:nil responseCallback:nil];
}
正确:
- (void)callHandler:(NSString *)handlerName {
[self callHandler:handlerNamedata:[NSNull null] responseCallback:nil];
}
==WebViewJavascriptBridge的使用==
===js和ios交互的直接代码实现===
*jos对于js的调用:
[self.paperQuestionsShowWebviewstringByEvaluatingJavaScriptFromString:[NSStringstringWithFormat:@"setQuestionContent('%@')",qTitle]];
*js对于ios的调用:
在html js代码中改变当前window的href;
window.location.href="selfEvaluate/"+value;
以上事件触发webview的shouldStartLoadWithRequest的回调事件;
- (BOOL)webView:(UIWebView *)webViewshouldStartLoadWithRequest:(NSURLRequest *)requestnavigationType:(UIWebViewNavigationType)navigationType{
NSString *relativePath =request.mainDocumentURL.relativePath;
if ([relativePathhasSuffix:@".html"]) {
return YES;
}
else{
NSRange doingRange = [relativePathrangeOfString:@"/doing/"];
if (doingRange.length>0) {
//获取用户选择的选项
NSString*userNewChoice = [relativePathsubstringFromIndex:doingRange.location+doingRange.length];
//更新选项内容到服务器端
//判断当前选项跟已经提交到服务器端的时候一致,如果不一致,则提交到服务器端
if(![userNewChoice isEqualToString:self.currentQuestionAnswer]){
[self.delegateupdateQuestionUserChoiceWithPid:self.paperIdquestionSequence:self.currentQuestionSequencechoice:userNewChoice
remainTime:self.reimainTimesender:self];
//NSLog(@"update");
}
}
else{
.....
}
return NO;
}
}
===js和ios交互的(WebViewJavascriptBridge)代码实现===
*ios端的实现:
引入头文件:
#import"WebViewJavascriptBridge.h";
指定WebViewJavascriptBridge 属性:
@property (strong, nonatomic)WebViewJavascriptBridge *javascriptBridge;
初始化 WebViewJavascriptBridge;
_javascriptBridge =[WebViewJavascriptBridgebridgeForWebView:_paperQuestionsShowWebview webViewDelegate:selfhandler:nil];
注册函数;
[_javascriptBridgeregisterHandler:@"setSubjectiveQuestionScore" handler:^(id data,WVJBResponse *response){
//获取用户选择的选项
NSInteger userScoreChoice = [(NSString *)dataintegerValue];
//更新选项内容到服务器端
//判断当前选项跟已经提交到服务器端的时候一致,如果不一致,则提交到服务器端
//如果选择新的分数,则同步到服务器端
if(userScoreChoice!=self.currentQuestionScore) {
[self.delegateupdateQuestionUserChooseScoreWithPid:self.paperIdquestionSequence:self.currentQuestionSequence score:userScoreChoicesender:self];
}
}];
调用js代码;
[_javascriptBridgecallHandler:@"setRightAnswer" data:qAnswer ];
*js的实现:
必要的事件注册和初始化:
document.addEventListener('WebViewJavascriptBridgeReady',onBridgeReady, false);
function onBridgeReady(event){
var bridge =event.bridge;
//调用初始化函数,取消队列,使消息能够得到直接处理;
bridge.init(function(message){
alert(message);
});
}
注册函数:
function onBridgeReady(event){
......
bridge.registerHandler('setQuestionContent',function(content){
var e_content =document.getElementByIdx_x('qcontent');
e_content.innerHTML= content;
});
}
实现js对ios的调用:
newChoiceElement.onclick = function(){
bridge.callHandler('choose',this.value);
}
===js和ios交互的(WebViewJavascriptBridge)代码实现中需要注意的问题===
#ios端必须保障框架中ios的实现作为webview的delegate,而业务代码作为后续的delegate处理在初始化中加入;不然消息得不到传递(会加入一个队列,但是不会触发消息传递);
#js端必须实现init函数,不然消息得不到传递(会加入一个队列,但是不会触发消息传递);
#关于参数(ios端):单个的对象可以直接传递(int等基础类型需要转换成对应的对象);多值传递需要组成NSDictionary进行传递;
#关于参数(js端):单个对象直接传递;多值组成json格式字符串{'aa':'ss','sdd':'rrr'};
#js语法以及编辑器对于错误的指示不明显,造成一些字符或标点错误,以及语法不完成的错误很难被发现,是消耗时间比较长的地方,需要通过寻找更加完善的js编辑器解决;
===代码引入WebViewJavascriptBridge实现ios和js交互的好处===
#协议:自己实现,在通讯的部分需要自己构建传递协议,多人实现造成构建的传递协议不同,比较容易混乱,采用统一的底层框架,可以减少这个问题;
#传递对象的字符转义:框架对这块又处理,不用自己再对一些字符进行转移;
#框架封装了js和ios的多次交互,在实现比较复杂的交互时比较有用,这块如果开发人员自己实现,则代码质量难控制,而且有一定的工作量;
document:属性
document.title //设置文档标题等价于HTML的
document.bgColor //设置页面背景色
document.fgColor //设置前景色(文本颜色)
document.linkColor //未点击过的链接颜色
document.alinkColor //激活链接(焦点在此链接上)的颜色
document.vlinkColor //已点击过的链接颜色
document.URL //设置URL属性从而在同一窗口打开另一网页
document.fileCreatedDate //文件建立日期,只读属性
document.fileModifiedDate //文件修改日期,只读属性
document.fileSize //文件大小,只读属性
document.cookie //设置和读出cookie
document.charset //设置字符集 简体中文:gb2312
document:方法
document.write() //动态向页面写入内容
document_createElement_x_x_x(Tag) //创建一个html标签对象
document.getElementByIdx_xx_x_x(ID) //获得指定ID值的对象
document.getElementsByName(Name) //获得指定Name值的对象
document.body.a(oTag)
body:子对象
document.body //指定文档主体的开始和结束等价于
location:子对象
document.location.hash // #号后的部分
document.location.host // 域名+端口号
document.location.hostname // 域名
document.location.href // 完整URL
document.location.pathname // 目录部分
document.location.port // 端口号
document.location.protocol // 网络协议(http:)
document.location.search // ?号后的部分
常用对象事件:
documeny.location.reload() //刷新网页
document.location.reload(URL) //打开新的网页
document.location.assign(URL) //打开新的网页
document.location.replace(URL) //打开新的网页
selection-选区子对象
document.selection
下载WebViewJavascriptBridge地址
它优雅地实现了在使用UIWebView时JS与ios 的Objective-C nativecode之间的互调,支持消息发送、接收、消息处理器的注册与调用以及设置消息处理的回调。
就像项目的名称一样,它是连接UIWebView和Javascript的bridge。在加入这个项目之后,他们之间的交互处理方式变得很友好。
在native code中跟UIWebView中的js交互的时候,像下面这样:
//发送一条消息给UI端并定义回调处理逻辑
[_bridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id error, id responseData) {
if (error) { NSLog(@"Uh oh - I got an error: %@", error); }
NSLog(@"objc got response! %@ %@", error, responseData);
}];
而在UIWebView中的js跟native code交互的时候也变得很简洁,比如在调用处理器的时候,就可以定义回调处理逻辑:
//调用名为testObjcCallback的native端处理器,并传递参数,同时设置回调处理逻辑
bridge.callHandler('testObjcCallback', {'foo': 'bar'}, function(response) {
log('Got response from testObjcCallback', response)
})
一起来看看它的实现吧,它总共就包含了三个文件:
WebViewJavascriptBridge.h
WebViewJavascriptBridge.m
WebViewJavascriptBridge.js.txt
它们是以如下的模式进行交互的:
很明显:WebViewJavascriptBridge.js.txt主要用于衔接UIWebView中的web page,而WebViewJavascriptBridge.h/m则主要用于与ObjC的nativecode打交道。他们作为一个整体,其实起到了一个“桥梁”的作用,这三个文件封装了他们具体的交互处理方式,只开放出一些对外的涉及到业务处理的API,因此你在需要UIWebView与Nativecode交互的时候,引入该库,则无需考虑太多的交互上的问题。整个的Bridge对你来说都是透明的,你感觉编程的时候,就像是web编程的前端和后端一样清晰。
简单地罗列一下它可以实现哪些功能吧:
出于表达上的需要,对于UIWebView相关的我就称之为UI端,而objc那端的处理代码称之为Native端。
【1】UI端
(1)UI端在初始化时支持设置消息的默认处理器(这里的消息指的是从Native端接收到的消息)
(2)从UI端向Native端发送消息,并支持对于Native端响应后的回调处理的定义
(3)UI端调用Native定义的处理器,并支持Native端响应后的回调处理定义
(4)UI端注册处理器(供Native端调用),并支持给Native端响应处理逻辑的定义
【2】Native端
(1)Native端在初始化时支持设置消息的默认处理器(这里的消息指的是从UI端发送过来的消息)
(2)从Native端向UI端发送消息,并支持对于UI端响应后的回调处理逻辑的定义
(3)Native端调用UI端定义的处理器,并支持UI端给出响应后在Native端的回调处理逻辑的定义
(4)Native端注册处理器(供UI端调用),并支持给UI端响应处理逻辑的定义UI端以及Native端完全是对等的两端,实现也是对等的。一段是消息的发送端,另一段就是接收端。这里为引起混淆,需要解释一下我这里使用的“响应”、“回调”在这个上下文中的定义:
(1)响应:接收端给予发送端的应答
(2)回调:发送端收到接收端的应答之后在接收端调用的处理逻辑
下面来分析一下源码:
WebViewJavascriptBridge.js.txt:
主要完成了如下工作:
(1)创建了一个用于发送消息的iFrame(通过创建一个隐藏的ifrmae,并设置它的URL来发出一个请求,从而触发UIWebView的shouldStartLoadWithRequest回调协议)
(2)创建了一个核心对象WebViewJavascriptBridge,并给它定义了几个方法,这些方法大部分是公开的API方法
(3)创建了一个事件:WebViewJavascriptBridgeReady,并dispatch(触发)了它。
代码解读
UI端实现
对于(1),相应的代码如下:
/*
*创建一个iFrame,设置隐藏并加入到DOM中
*/
function _createQueueReadyIframe(doc) {
messagingIframe = doc.createElement('iframe')
messagingIframe.style.display = 'none'
doc.documentElement.appendChild(messagingIframe)
}
对于(2)中的WebViewJavascriptBridge,其对象拥有如下方法:
window.WebViewJavascriptBridge = {
init: init,
send: send,
registerHandler: registerHandler,
callHandler: callHandler,
_fetchQueue: _fetchQueue,
_handleMessageFromObjC: _handleMessageFromObjC
}
方法的实现:
/*
*初始化方法,注入默认的消息处理器
*默认的消息处理器用于在处理来自objc的消息时,如果该消息没有设置处理器,则采用默认处理器处理
*/
function init(messageHandler) {
if (WebViewJavascriptBridge._messageHandler) { throw new Error('WebViewJavascriptBridge.init called twice') }
WebViewJavascriptBridge._messageHandler = messageHandler
var receivedMessages = receiveMessageQueue
receiveMessageQueue = null
//如果接收队列有消息,则处理
for (var i=0; i _dispatchMessageFromObjC(receivedMessages[i]) } } /* *发送消息并设置回调 */ function send(data, responseCallback) { _doSend({ data:data }, responseCallback) } /* *注册消息处理器 */ function registerHandler(handlerName, handler) { messageHandlers[handlerName] = handler } /* *调用处理器并设置回调 */ function callHandler(handlerName, data, responseCallback) { _doSend({ data:data, handlerName:handlerName }, responseCallback) } 涉及到的两个内部方法: /* *内部方法:消息的发送 */ function _doSend(message, responseCallback) { //如果定义了回调 if (responseCallback) { //为回调对象产生唯一标识 var callbackId = 'js_cb_'+(uniqueId++) //并存储到一个集合对象里 responseCallbacks[callbackId] = responseCallback //新增一个key-value对- 'callbackId':callbackId message['callbackId'] = callbackId } sendMessageQueue.push(JSON.stringify(message)) messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE } /* *内部方法:处理来自objc的消息 */ function _dispatchMessageFromObjC(messageJSON) { setTimeout(function _timeoutDispatchMessageFromObjC() { var message = JSON.parse(messageJSON) var messageHandler if (message.responseId) { //取出回调函数对象并执行 var responseCallback = responseCallbacks[message.responseId] responseCallback(message.error, message.responseData) delete responseCallbacks[message.responseId] } else { var response if (message.callbackId) { var callbackResponseId = message.callbackId response = { respondWith: function(responseData) { _doSend({ responseId:callbackResponseId, responseData:responseData }) }, respondWithError: function(error) { _doSend({ responseId:callbackResponseId, error:error }) } } } var handler = WebViewJavascriptBridge._messageHandler //如果消息中已包含消息处理器,则使用该处理器;否则使用默认处理器 if (message.handlerName) { handler = messageHandlers[message.handlerName] } try { handler(message.data, response) } catch(exception) { console.log("WebViewJavascriptBridge: WARNING: javascript handler threw.", message, exception) } } }) } 还有两个js方法是供native端直接调用的方法(它们本身也是为native端服务的): /* *获得队列,将队列中的每个元素用分隔符分隔之后连成一个字符串【native端调用】 */ function _fetchQueue() { var messageQueueString = sendMessageQueue.join(MESSAGE_SEPARATOR) sendMessageQueue = [] return messageQueueString } /* *处理来自ObjC的消息【native端调用】 */ function _handleMessageFromObjC(messageJSON) { //如果接收队列对象存在则入队该消息,否则直接处理 if (receiveMessageQueue) { receiveMessageQueue.push(messageJSON) } else { _dispatchMessageFromObjC(messageJSON) } } 最后还有一段代码就是,定义一个事件并触发,同时设置设置上面定义的WebViewJavascriptBridge对象为事件的一个属性: var doc = document _createQueueReadyIframe(doc) //创建并实例化一个事件对象 var readyEvent = doc.createEvent('Events') readyEvent.initEvent('WebViewJavascriptBridgeReady') readyEvent.bridge = WebViewJavascriptBridge //触发事件 doc.dispatchEvent(readyEvent) Native端实现 其实大致跟上面的类似,只是因为语法不同(所以我上面才说两端是对等的):WebViewJavascriptBridge.h/.m 它其实可以看作UIWebView的Controller,实现了UIWebViewDelegate协议: @interface WebViewJavascriptBridge : NSObject + (id)bridgeForWebView:(UIWebView*)webView handler:(WVJBHandler)handler; + (id)bridgeForWebView:(UIWebView*)webView webViewDelegate:(id + (void)enableLogging; - (void)send:(id)message; - (void)send:(id)message responseCallback:(WVJBResponseCallback)responseCallback; - (void)registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler; - (void)callHandler:(NSString*)handlerName; - (void)callHandler:(NSString*)handlerName data:(id)data; - (void)callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)responseCallback; @end 方法的实现其实是跟前面类似的,这里我们只看一下UIWebView的一个协议方法:shouldStartLoadWithRequest: - (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType { if (webView != _webView) { return YES; } NSURL *url = [request URL]; if ([[url scheme] isEqualToString:CUSTOM_PROTOCOL_SCHEME]) { //队列中有数据 if ([[url host] isEqualToString:QUEUE_HAS_MESSAGE]) { //刷出队列中数据 [self _flushMessageQueue]; } else { NSLog(@"WebViewJavascriptBridge: WARNING: Received unknown WebViewJavascriptBridge command %@://%@", CUSTOM_PROTOCOL_SCHEME, [url path]); } return NO; } else if (self.webViewDelegate) { return [self.webViewDelegate webView:webView shouldStartLoadWithRequest:request navigationType:navigationType]; } else { return YES; } } 使用示例 UI端 //给WebViewJavascriptBridgeReady事件注册一个Listener document.addEventListener('WebViewJavascriptBridgeReady', onBridgeReady, false) //事件的响应处理 function onBridgeReady(event) { var bridge = event.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 + (data ? ': ' + JSON.stringify(data) : '') if (log.children.length) { log.insertBefore(el, log.children[0]) } else { log.appendChild(el) } } //初始化操作,并定义默认的消息处理逻辑 bridge.init(function(message) { log('JS got a message', message) }) //注册一个名为testJavascriptHandler的处理器,并定义用于响应的处理逻辑 bridge.registerHandler('testJavascriptHandler', function(data, response) { log('JS handler testJavascriptHandler was called', data) response.respondWith({ 'Javascript Says':'Right back atcha!' }) }) //创建一个发送消息给native端的按钮 var button = document.getElementById('buttons').appendChild(document.createElement('button')) button.innerHTML = 'Send message to ObjC' button.ontouchstart = function(e) { e.preventDefault() //发送消息 bridge.send('Hello from JS button') } document.body.appendChild(document.createElement('br')) //创建一个用于调用native端处理器的按钮 var callbackButton = document.getElementById('buttons').appendChild(document.createElement('button')) callbackButton.innerHTML = 'Fire testObjcCallback' callbackButton.ontouchstart = function(e) { e.preventDefault() log("Calling handler testObjcCallback") //调用名为testObjcCallback的native端处理器,并传递参数,同时设置回调处理逻辑 bridge.callHandler('testObjcCallback', {'foo': 'bar'}, function(response) { log('Got response from testObjcCallback', response) }) } } Native端 //实例化一个webview并加入到window中去 UIWebView* webView = [[UIWebView alloc] initWithFrame:self.window.bounds]; [self.window addSubview:webView]; //启用日志记录 [WebViewJavascriptBridge enableLogging]; //实例化WebViewJavascriptBridge并定义native端的默认消息处理器 _bridge = [WebViewJavascriptBridge bridgeForWebView:webView handler:^(id data, WVJBResponse *response) { NSLog(@"ObjC received message from JS: %@", data); UIAlertView *alert = [[UIAlertView alloc] initWithTitle:@"ObjC got message from Javascript:" message:data delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil]; [alert show]; }]; //注册一个供UI端调用的名为testObjcCallback的处理器,并定义用于响应的处理逻辑 [_bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponse *response) { NSLog(@"testObjcCallback called: %@", data); [response respondWith:@"Response from testObjcCallback"]; }]; //发送一条消息给UI端并定义回调处理逻辑 [_bridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id error, id responseData) { if (error) { NSLog(@"Uh oh - I got an error: %@", error); } NSLog(@"objc got response! %@ %@", error, responseData); }]; //调用一个在UI端定义的名为testJavascriptHandler的处理器,没有定义回调 [_bridge callHandler:@"testJavascriptHandler" data:[NSDictionary dictionaryWithObject:@"before ready" forKey:@"foo"]]; [self renderButtons:webView]; [self loadExamplePage:webView]; //单纯发送一条消息给UI端 [_bridge send:@"A string sent from ObjC after Webview has loaded."]; 参考:http://blog.sina.com.cn/s/blog_a7c44c880101dmvj.html http://www.lanrenios.com/tutorials/network/2012/1130/547.html