WebViewJavascriptBridge應(yīng)該是當前最流行最成功的OC與Web交互實現(xiàn)了。最近看了一下他的實現(xiàn)原理
我們可以在OC中調(diào)用javascript方法副签,但是反過來不能在javascript中調(diào)用OC方法。所以WebViewJavascriptBridge的實現(xiàn)過程就是在OC環(huán)境和javascript環(huán)境各自保存一個相互調(diào)用的信息惹资。每一個調(diào)用之間都有id和callbackid來找到兩個環(huán)境對應(yīng)的處理。
WebViewJavascriptBridge_JS.m文件中是javascript環(huán)境的bridge初始化和處理肖抱,里面負責接收oc發(fā)給javascript的消息奋刽,并且把javascript環(huán)境的消息發(fā)送給oc瓦侮。
WebViewJavascriptBridge.m主要負責OC環(huán)境的消息處理,并且把OC環(huán)境的消息發(fā)送給javascript環(huán)境佣谐。
WebViewJavascriptBridgeBase.m主要實現(xiàn)了OC環(huán)境的bridge初始化和處理脏榆。
ExampleApp.html主要用于模擬生產(chǎn)環(huán)境下的web端。
初始化過程
1台谍、OC環(huán)境初始化
我們從OC環(huán)境的初始化開始须喂。
//初始化一個OC環(huán)境的橋WKWebViewJavascriptBridge并且初始化吁断。
- (instancetype)bridgeForWebView:(WKWebView)webView {
WKWebViewJavascriptBridge bridge = [[self alloc] init];
//調(diào)用下面那個方法
[bridge _setupInstance:webView];
[bridge reset];
return bridge;
}
//初始化
- (void) _setupInstance:(WKWebView*)webView {
_webView = webView;
_webView.navigationDelegate = self;
_base = [[WebViewJavascriptBridgeBase alloc] init];
_base.delegate = self;
}
//messageHandlers用于保存OC環(huán)境注冊的方法,key是方法名坞生,value是這個方法對應(yīng)的回調(diào)block
//startupMessageQueue用于保存是實話過程中需要發(fā)送給javascirpt環(huán)境的消息仔役。
//responseCallbacks用于保存OC于javascript環(huán)境相互調(diào)用的回調(diào)模塊。通過_uniqueId加上時間戳來確定每個調(diào)用的回調(diào)是己。
- (id)init {
if (self = [super init]) {
self.messageHandlers = [NSMutableDictionary dictionary];
self.startupMessageQueue = [NSMutableArray array];
self.responseCallbacks = [NSMutableDictionary dictionary];
_uniqueId = 0;
}
return self;
}
所有與javascript之間交互的信息都存儲在messageHandlers和responseCallbacks中又兵。這兩個屬性記錄了OC環(huán)境與javascript交互的信息。
2卒废、OC環(huán)境注冊方法
注冊一個OC方法OC提供方法給JS調(diào)用給javascript調(diào)用沛厨,并且把他的回調(diào)實現(xiàn)保存在messageHandlers中。
[_bridge registerHandler:@"OC提供方法給JS調(diào)用" handler:^(id data, WVJBResponseCallback responseCallback) {
//NSLog(@"testObjcCallback called: %@", data);
responseCallback(@"OC發(fā)給JS的返回值");
}];
- (void)registerHandler:(NSString *)handlerName handler:(WVJBHandler)handler {
_base.messageHandlers[handlerName] = [handler copy];
}
3摔认、Web環(huán)境初始化
加載Web環(huán)境的html,這里就是ExampleAPP.html文件,我刪除了非關(guān)鍵部分逆皮。
function setupWebViewJavascriptBridge(callback) {
//第一次調(diào)用這個方法的時候,為false
if (window.WebViewJavascriptBridge) {
var result = callback(WebViewJavascriptBridge);
return result;
}
//第一次調(diào)用的時候参袱,也是false
if (window.WVJBCallbacks) {
var result = window.WVJBCallbacks.push(callback);
return result;
}
//把callback對象賦值給對象电谣。
window.WVJBCallbacks = [callback];
//這段代碼的意思就是執(zhí)行加載WebViewJavascriptBridge_JS.js中代碼的作用
var WVJBIframe = document.createElement('iframe');
WVJBIframe.style.display = 'none';
WVJBIframe.src = 'https://bridge_loaded';
document.documentElement.appendChild(WVJBIframe);
setTimeout(function() {
document.documentElement.removeChild(WVJBIframe)
}, 0);
}
//setupWebViewJavascriptBridge執(zhí)行的時候傳入的參數(shù),這是一個方法抹蚀。
function callback(bridge) {
var uniqueId = 1
//把WEB中要注冊的方法注冊到bridge里面
bridge.registerHandler('OC調(diào)用JS提供的方法', function(data, responseCallback) {
log('OC調(diào)用JS方法成功', data)
var responseData = { 'JS給OC調(diào)用的回調(diào)':'回調(diào)值!' }
log('OC調(diào)用JS的返回值', responseData)
responseCallback(responseData)
})
};
//驅(qū)動所有hander的初始化
setupWebViewJavascriptBridge(callback);
我們調(diào)用setupWebViewJavascriptBridge函數(shù)剿牺,并且這個函數(shù)傳入的callback也是一個函數(shù)。callback函數(shù)中有我們在javascript環(huán)境中注冊的OC調(diào)用JS提供的方法方法环壤。setupWebViewJavascriptBridge的實現(xiàn)過程中我們可以發(fā)現(xiàn)晒来,如果不是第一次初始化,會通過 window.WebViewJavascriptBridge或者window.WVJBCallbacks兩個判斷返回郑现。
iframe可以理解為webview中的窗口潜索,當我們改變iframe的src屬性的時候,相當于我們?yōu)g覽器實現(xiàn)了鏈接的跳轉(zhuǎn)懂酱。比如從www.baidu.com跳轉(zhuǎn)到www.google.com竹习。下面這段代碼的目的就是實現(xiàn)一個到https://bridge_loaded的跳轉(zhuǎn)。從而達到初始化javascript環(huán)境的bridge的作用列牺。
//這段代碼的意思就是執(zhí)行加載WebViewJavascriptBridge_JS.js中代碼的作用
var WVJBIframe = document.createElement('iframe');
WVJBIframe.style.display = 'none';
WVJBIframe.src = 'https://bridge_loaded';
document.documentElement.appendChild(WVJBIframe);
setTimeout(function() {
document.documentElement.removeChild(WVJBIframe)
}, 0);
我們知道只要webview有跳轉(zhuǎn)整陌,就會調(diào)用webview的代理方法。我們重點看下面這個代理方法瞎领。
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
if (webView != _webView) { return; }
NSURL *url = navigationAction.request.URL;
NSLog(@"點開URL%@",url);
__strong typeof(_webViewDelegate) strongDelegate = _webViewDelegate;
//如果是WebViewJavascriptBridge發(fā)送或者接受的消息泌辫,則特殊處理。否則按照正常流程處理九默。
if ([_base isWebViewJavascriptBridgeURL:url]) {
//1第一次注入JS代碼
if ([_base isBridgeLoadedURL:url]) {
[_base injectJavascriptFile];
//處理WEB發(fā)過來的消息
} else if ([_base isQueueMessageURL:url]) {
[self WKFlushMessageQueue];
} else {
[_base logUnkownMessage:url];
}
decisionHandler(WKNavigationActionPolicyCancel);
}
//下面是webview的正常代理執(zhí)行流程震放,不用管。
if (strongDelegate && [strongDelegate respondsToSelector:@selector(webView:decidePolicyForNavigationAction:decisionHandler:)]) {
[_webViewDelegate webView:webView decidePolicyForNavigationAction:navigationAction decisionHandler:decisionHandler];
} else {
decisionHandler(WKNavigationActionPolicyAllow);
}
}
在這段代碼中驼修,我們首先通過[_base isWebViewJavascriptBridgeURL:url]來判斷是否是普通的跳轉(zhuǎn)還是webViewjavascriptBridege的跳轉(zhuǎn)殿遂。如果是bridge_loaded表示是初始化javascript環(huán)境的消息诈铛,如果是 wvjb_queue_message則表示是發(fā)送javascript消息。https://bridge_loaded顯然是第一種消息墨礁。OC具體具體判斷邏輯代碼如下:
define kOldProtocolScheme @"wvjbscheme"
define kNewProtocolScheme @"https"
define kQueueHasMessage @"wvjb_queue_message"
define kBridgeLoaded @"bridge_loaded"
//是否是WebViewJavascriptBridge框架相關(guān)的鏈接
- (BOOL)isWebViewJavascriptBridgeURL:(NSURL)url {
if (![self isSchemeMatch:url]) {
return NO;
}
BOOL result = [self isBridgeLoadedURL:url] || [self isQueueMessageURL:url];
return result;
}
/
是否是WebViewJavascriptBridge發(fā)送或者接受的消息
*/ - (BOOL)isSchemeMatch:(NSURL)url {
NSString scheme = url.scheme.lowercaseString;
BOOL result = [scheme isEqualToString:kNewProtocolScheme] || [scheme isEqualToString:kOldProtocolScheme];
return result;
}
//是WebViewJavascriptBridge發(fā)送的消息還是WebViewJavascriptBridge的初始化消息幢竹。 - (BOOL)isQueueMessageURL:(NSURL)url {
NSString host = url.host.lowercaseString;
return [self isSchemeMatch:url] && [host isEqualToString:kQueueHasMessage];
}
//是否是https://bridge_loaded這種初始化加載消息 - (BOOL)isBridgeLoadedURL:(NSURL)url {
NSString host = url.host.lowercaseString;
BOOL result = [self isSchemeMatch:url] && [host isEqualToString:kBridgeLoaded];
return result;
}
接下來調(diào)用[_base injectJavascriptFile]方法,這個方法的作用就是把WebViewJavascriptBridge_JS.js中的方法注入到webview中并且執(zhí)行恩静,從而達到初始化javascript環(huán)境的brige的作用焕毫。
//初始化的是否注入WebViewJavascriptBridge_JS.js
- (void)injectJavascriptFile {
NSString js;
//WebViewJavascriptBridge_JS.js文件內(nèi)容其實就是WebViewJavascriptBridge_JS.m對應(yīng)的內(nèi)容,我只是把它整理方便閱讀驶乾。
if (true) {
js = [NSString stringWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"WebViewJavascriptBridge_JS.js" ofType:nil] encoding:NSUTF8StringEncoding error:nil];
}else{
js = WebViewJavascriptBridge_js();
}
//把javascript代碼注入webview中執(zhí)行,這里執(zhí)行具體的注入操作邑飒。
[self _evaluateJavascript:js];
//如果javascript環(huán)境初始化完成以后,有startupMessageQueue消息级乐。則立即發(fā)送消息疙咸。
if (self.startupMessageQueue) {
NSArray queue = self.startupMessageQueue;
self.startupMessageQueue = nil;
for (id queuedMessage in queue) {
[self _dispatchMessage:queuedMessage];
}
}
}
//把javascript代碼寫入webview - (NSString) _evaluateJavascript:(NSString)javascriptCommand {
[_webView evaluateJavaScript:javascriptCommand completionHandler:nil];
return NULL;
}
3、WebViewJavascriptBridge_JS.js解析
上面我們講到了注入javascript方法到webview中唇牧。具體的代碼就是WebViewJavascriptBridge_JS.js這個文件中的方法罕扎。我們通過分析這個文件的代碼可以知道javascript環(huán)境的bridge是如何初始化的聚唐。
;(function() {
//如果已經(jīng)初始化了丐重,則返回。
if (window.WebViewJavascriptBridge) {
return;
}
if (!window.onerror) {
window.onerror = function(msg, url, line) {
console.log("WebViewJavascriptBridge: ERROR:" + msg + "@" + url + ":" + line);
}
}
//初始化一些屬性杆查。
var messagingIframe;
//用于存儲消息列表
var sendMessageQueue = [];
//用于存儲消息
var messageHandlers = {};
//通過下面兩個協(xié)議組合來確定是否是特定的消息扮惦,然后攔擊。
var CUSTOM_PROTOCOL_SCHEME = 'https';
var QUEUE_HAS_MESSAGE = 'wvjb_queue_message';
//oc調(diào)用js的回調(diào)
var responseCallbacks = {};
//消息對應(yīng)的id
var uniqueId = 1;
//是否設(shè)置消息超時
var dispatchMessagesWithTimeoutSafety = true;
//web端注冊一個消息方法
function registerHandler(handlerName, handler) {
messageHandlers[handlerName] = handler;
}
//web端調(diào)用一個OC注冊的消息
function callHandler(handlerName, data, responseCallback) {
if (arguments.length == 2 && typeof data == 'function') {
responseCallback = data;
data = null;
}
_doSend({ handlerName: handlerName, data: data }, responseCallback);
}
function disableJavscriptAlertBoxSafetyTimeout() {
dispatchMessagesWithTimeoutSafety = false;
}
//把消息轉(zhuǎn)換成JSON字符串返回
function _fetchQueue() {
var messageQueueString = JSON.stringify(sendMessageQueue);
sendMessageQueue = [];
return messageQueueString;
}
//OC調(diào)用JS的入口方法
function _handleMessageFromObjC(messageJSON) {
_dispatchMessageFromObjC(messageJSON);
}
//初始化橋接對象亲桦,OC可以通過WebViewJavascriptBridge來調(diào)用JS里面的各種方法崖蜜。
window.WebViewJavascriptBridge = {
registerHandler: registerHandler,
callHandler: callHandler,
disableJavscriptAlertBoxSafetyTimeout: disableJavscriptAlertBoxSafetyTimeout,
_fetchQueue: _fetchQueue,
_handleMessageFromObjC: _handleMessageFromObjC
};
//處理從OC返回的消息。
function _dispatchMessageFromObjC(messageJSON) {
if (dispatchMessagesWithTimeoutSafety) {
setTimeout(_doDispatchMessageFromObjC);
} else {
_doDispatchMessageFromObjC();
}
function _doDispatchMessageFromObjC() {
var message = JSON.parse(messageJSON);
var messageHandler;
var responseCallback;
//回調(diào)
if (message.responseId) {
responseCallback = responseCallbacks[message.responseId];
if (!responseCallback) {
return;
}
responseCallback(message.responseData);
delete responseCallbacks[message.responseId];
} else {//主動調(diào)用
if (message.callbackId) {
var callbackResponseId = message.callbackId;
responseCallback = function(responseData) {
_doSend({ handlerName: message.handlerName, responseId: callbackResponseId, responseData: responseData });
};
}
//獲取JS注冊的函數(shù)
var handler = messageHandlers[message.handlerName];
if (!handler) {
console.log("WebViewJavascriptBridge: WARNING: no handler for message from ObjC:", message);
} else {
//調(diào)用JS中的對應(yīng)函數(shù)處理
handler(message.data, responseCallback);
}
}
}
}
//把消息從JS發(fā)送到OC客峭,執(zhí)行具體的發(fā)送操作豫领。
function _doSend(message, responseCallback) {
if (responseCallback) {
var callbackId = 'cb_' + (uniqueId++) + '_' + new Date().getTime();
//存儲消息的回調(diào)ID
responseCallbacks[callbackId] = responseCallback;
//把消息對應(yīng)的回調(diào)ID和消息一起發(fā)送,以供消息返回以后使用舔琅。
message['callbackId'] = callbackId;
}
//把消息放入消息列表
sendMessageQueue.push(message);
//下面這句話會出發(fā)JS對OC的調(diào)用
//讓webview執(zhí)行跳轉(zhuǎn)操作等恐,從而可以在
//webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler 中攔截到JS發(fā)給OC的消息
messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
}
messagingIframe = document.createElement('iframe');
messagingIframe.style.display = 'none';
//messagingIframe.body.style.backgroundColor="#0000ff";
messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
document.documentElement.appendChild(messagingIframe);
//注冊_disableJavascriptAlertBoxSafetyTimeout方法,讓OC可以關(guān)閉回調(diào)超時备蚓,默認是開啟的课蔬。
registerHandler("_disableJavascriptAlertBoxSafetyTimeout", disableJavscriptAlertBoxSafetyTimeout);
//執(zhí)行_callWVJBCallbacks方法
setTimeout(_callWVJBCallbacks, 0);
//初始化WEB中注冊的方法。這個方法會把WEB中的hander注冊到bridge中郊尝。
//下面的代碼其實就是執(zhí)行WEB中的callback函數(shù)二跋。
function _callWVJBCallbacks() {
var callbacks = window.WVJBCallbacks;
delete window.WVJBCallbacks;
for (var i = 0; i < callbacks.length; i++) {
callbacks[i](WebViewJavascriptBridge);
}
}
})();
其實我們發(fā)現(xiàn)整個js文件就是一個立即執(zhí)行的javascript方法。
首先我們發(fā)現(xiàn)會初始化一個WebViewJavascriptBridge對象流昏。并且這個對象是賦值給window對象扎即,這里window對象可以理解為webview吞获。所以說我們后面在OC環(huán)境中如果要調(diào)用js方法,就可以通過window.WebViewJavascriptBridge在加上具體方法來調(diào)用铺遂。
WebViewJavascriptBridge對象中有javascript環(huán)境注入的提供給OC調(diào)用的方法registerHandler衫哥,javascript調(diào)用OC環(huán)境方法的callHandler。
_fetchQueue這個方法的作用就是把javascript環(huán)境的方法序列化成JSON字符串襟锐,然后傳入OC環(huán)境再轉(zhuǎn)換撤逢。
_handleMessageFromObjC就是處理OC發(fā)給javascript環(huán)境的方法。
在這個文件中也初始化了一個iframe實現(xiàn)webview的url跳轉(zhuǎn)功能粮坞,從而激發(fā)webview代理方法的調(diào)用蚊荣。
messagingIframe = document.createElement('iframe');
messagingIframe.style.display = 'none';
//messagingIframe.body.style.backgroundColor="#0000ff";
messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
document.documentElement.appendChild(messagingIframe);
上面的src就是https://wvjb_queue_message/。這個是javascript發(fā)送的OC的第一條消息莫杈,目的和上面OC環(huán)境的startupMessageQueue一樣互例,就是在javascript環(huán)境初始化完成以后,把javascript要發(fā)送給OC的消息立即發(fā)送出去筝闹。
然后我們看文件的最后面有如下代碼媳叨。這段代碼的作用就是立即執(zhí)行ExampleApp.html中的callback方法。callback中傳入的bridge參數(shù)就是我們這里初始化的window.WebViewJavascriptBridge對象关顷。
//執(zhí)行_callWVJBCallbacks方法
setTimeout(_callWVJBCallbacks, 0);
//初始化WEB中注冊的方法糊秆。這個方法會把WEB中的hander注冊到bridge中。
//下面的代碼其實就是執(zhí)行WEB中的callback函數(shù)议双。
function _callWVJBCallbacks() {
var callbacks = window.WVJBCallbacks;
delete window.WVJBCallbacks;
for (var i = 0; i < callbacks.length; i++) {
callbacks[i](WebViewJavascriptBridge);
}
}
直到這里痘番,OC環(huán)境和javascript環(huán)境的bridege都建立完畢。OC和javascript環(huán)境都有一個bridge對象平痰,這個對象都保存著注冊的每個方法和回調(diào)汞舱,并且維護著各自的消息隊列、回調(diào)id宗雇、requestId等一系列信息昂芜。
OC發(fā)消息給WEB
OC要調(diào)用javascript環(huán)境的方法,其實就是調(diào)用ExampleApp.html中的bridge.registerHandler注冊的方法赔蒲。
//點擊按鈕開始一個OC消息.ExampleWKWebViewController.m中一個方法開始泌神。
(void)callHandler:(id)sender {
id data = @{ @"OC調(diào)用JS方法": @"OC調(diào)用JS方法的參數(shù)" };
[_bridge callHandler:@"OC調(diào)用JS提供的方法" data:data responseCallback:^(id response) {
// NSLog(@"testJavascriptHandler responded: %@", response);
}];
}
/*
handerName:OC調(diào)用JS提供的方法
data:{@"OC調(diào)用JS方法的參數(shù)":@"OC調(diào)用JS方法"}
responseCallback:回調(diào)block
*/(void)callHandler:(NSString *)handlerName data:(id)data responseCallback:(WVJBResponseCallback)responseCallback {
[_base sendData:data responseCallback:responseCallback handlerName:handlerName];
}
把所有信息存入一個名字為message的字典中。里面拼裝好參數(shù)data嘹履、回調(diào)IDcallbackId腻扇、消息名字handlerName。具體如下:-
(void)sendData:(id)data responseCallback:(WVJBResponseCallback)responseCallback handlerName:(NSString)handlerName {
NSMutableDictionary message = [NSMutableDictionary dictionary];if (data) {
message[@"data"] = data;
}if (responseCallback) {
NSString* callbackId = [NSString stringWithFormat:@"objc_cb_%ld", ++_uniqueId];
self.responseCallbacks[callbackId] = [responseCallback copy];
message[@"callbackId"] = callbackId;
}if (handlerName) {
message[@"handlerName"] = handlerName;
}
[self _queueMessage:message];
}
把OC消息序列化砾嫉、并且轉(zhuǎn)化為javascript環(huán)境的格式幼苛。然后在主線程中調(diào)用_evaluateJavascript。
//把消息發(fā)送給WEB環(huán)境
-
(void)_dispatchMessage:(WVJBMessage*)message {
NSString *messageJSON = [self _serializeMessage:message pretty:NO];
[self _log:@"SEND" json:messageJSON];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\" withString:@"\\"];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@""" withString:@"\""];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"'" withString:@"\'"];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\n" withString:@"\n"];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\r" withString:@"\r"];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\f" withString:@"\f"];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\u2028" withString:@"\u2028"];
messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\u2029" withString:@"\u2029"];NSString* javascriptCommand = [NSString stringWithFormat:@"WebViewJavascriptBridge._handleMessageFromObjC('%@');", messageJSON];
if ([[NSThread currentThread] isMainThread]) {
[self _evaluateJavascript:javascriptCommand];} else {
dispatch_sync(dispatch_get_main_queue(), ^{
[self _evaluateJavascript:javascriptCommand];
});
}
}
具體注入的javascript字符串如下:
WebViewJavascriptBridge._handleMessageFromObjC('{"callbackId":"objc_cb_1","data":{"OC調(diào)用JS方法":"OC調(diào)用JS方法的參數(shù)"},"handlerName":"OC調(diào)用JS提供的方法"}');
其實就是通過javascript環(huán)境中的Bridge對象的_handleMessageFromObjC方法焕刮。下面我們?nèi)ebViewJavascriptBridege_JS.js中看_handleMessageFromObjC的處理過程舶沿。
//處理從OC返回的消息墙杯。
function _dispatchMessageFromObjC(messageJSON) {
if (dispatchMessagesWithTimeoutSafety) {
setTimeout(_doDispatchMessageFromObjC);
} else {
_doDispatchMessageFromObjC();
}
function _doDispatchMessageFromObjC() {
var message = JSON.parse(messageJSON);
var messageHandler;
var responseCallback;
//回調(diào)
if (message.responseId) {
responseCallback = responseCallbacks[message.responseId];
if (!responseCallback) {
return;
}
responseCallback(message.responseData);
delete responseCallbacks[message.responseId];
} else {//主動調(diào)用
if (message.callbackId) {
var callbackResponseId = message.callbackId;
responseCallback = function(responseData) {
_doSend({ handlerName: message.handlerName, responseId: callbackResponseId, responseData: responseData });
};
}
//獲取JS注冊的函數(shù)
var handler = messageHandlers[message.handlerName];
if (!handler) {
console.log("WebViewJavascriptBridge: WARNING: no handler for message from ObjC:", message);
} else {
//調(diào)用JS中的對應(yīng)函數(shù)處理
handler(message.data, responseCallback);
}
}
}
}
上面這段代碼很容易理解,其實就是如果消息中有callbackId則表示是一個回調(diào)括荡。直接調(diào)用_doSend方法把信息返回OC高镐。否則就是Web環(huán)境主動調(diào)用OC的情況。此時把callbackID畸冲、handlerName嫉髓、responseCallback封裝進一個message對象中保存起來(其實你會發(fā)現(xiàn)和OC環(huán)境的bridge處理一樣)。然后通過_doSend發(fā)消息發(fā)送到OC環(huán)境邑闲。下面我們看看_doSend的具體實現(xiàn):
//把消息從JS發(fā)送到OC算行,執(zhí)行具體的發(fā)送操作。
function doSend(message, responseCallback) {
if (responseCallback) {
var callbackId = 'cb' + (uniqueId++) + '_' + new Date().getTime();
//存儲消息的回調(diào)ID
responseCallbacks[callbackId] = responseCallback;
//把消息對應(yīng)的回調(diào)ID和消息一起發(fā)送苫耸,以供消息返回以后使用州邢。
message['callbackId'] = callbackId;
}
//把消息放入消息列表
sendMessageQueue.push(message);
//下面這句話會出發(fā)JS對OC的調(diào)用
//讓webview執(zhí)行跳轉(zhuǎn)操作,從而可以在
//webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler 中攔截到JS發(fā)給OC的消息
messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
}
其中最重要還是最后面的通過改變iframe的messagingIframe.src褪子。從而觸發(fā)webview的代理方法webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler從而在OC中處理javascript環(huán)境觸發(fā)過來的回調(diào)量淌。具體如下:
if ([_base isWebViewJavascriptBridgeURL:url]) {
//第一次注入JS代碼
if ([_base isBridgeLoadedURL:url]) {
[_base injectJavascriptFile];
//處理WEB發(fā)過來的消息
} else if ([_base isQueueMessageURL:url]) {
[self WKFlushMessageQueue];
} else {
[_base logUnkownMessage:url];
}
decisionHandler(WKNavigationActionPolicyCancel);
}
這里會走[self WKFlushMessageQueue];方法。然后通過調(diào)用WebViewJavascriptBridge._fetchQueue()來獲取javascript給OC的回調(diào)信息嫌褪。
//獲取WEB消息的JSON字符串
- (NSString *)webViewJavascriptFetchQueyCommand {
return @"WebViewJavascriptBridge._fetchQueue();";
}
////把消息或者WEB回調(diào)從OC發(fā)送到OC - (void)WKFlushMessageQueue {
NSString js = [_base webViewJavascriptFetchQueyCommand];
[_webView evaluateJavaScript:js completionHandler:^(NSString result, NSError* error) {
if (error != nil) {
NSLog(@"WebViewJavascriptBridge: WARNING: Error when trying to fetch data from WKWebView: %@", error);
}
//把消息或者WEB回調(diào)從OC發(fā)送到OC
[_base flushMessageQueue:result];
}];
}
獲取到j(luò)avascript給OC的回調(diào)消息以后呀枢,然后把javascript的bridge返回的信息加工處理成OC環(huán)境的bridge能識別的信息。從而找到具體的實現(xiàn)執(zhí)行渔扎。
//把從WEB發(fā)送的消息返回硫狞。然后在這里處理
-
(void)flushMessageQueue:(NSString *)messageQueueString{
if (messageQueueString == nil || messageQueueString.length == 0) {
NSLog(@"WebViewJavascriptBridge: WARNING: ObjC got nil while fetching the message queue JSON from webview. This can happen if the WebViewJavascriptBridge JS is not currently present in the webview, e.g if the webview just loaded a new page.");
return;
}id messages = [self _deserializeMessageJSON:messageQueueString];
for (WVJBMessage* message in messages) {
if (![message isKindOfClass:[WVJBMessage class]]) {
NSLog(@"WebViewJavascriptBridge: WARNING: Invalid %@ received: %@", [message class], message);
continue;
}
[self _log:@"RCVD" json:message];NSString* responseId = message[@"responseId"]; if (responseId) { WVJBResponseCallback responseCallback = _responseCallbacks[responseId]; responseCallback(message[@"responseData"]); [self.responseCallbacks removeObjectForKey:responseId]; } else { WVJBResponseCallback responseCallback = NULL; NSString* callbackId = message[@"callbackId"]; if (callbackId) { responseCallback = ^(id responseData) { if (responseData == nil) { responseData = [NSNull null]; } WVJBMessage* msg = @{ @"responseId":callbackId, @"responseData":responseData }; [self _queueMessage:msg]; }; } else { responseCallback = ^(id ignoreResponseData) { // Do nothing }; } WVJBHandler handler = self.messageHandlers[message[@"handlerName"]]; if (!handler) { NSLog(@"WVJBNoHandlerException, No handler for message from JS: %@", message); continue; } handler(message[@"data"], responseCallback); }
}
}
這里會調(diào)用handler方法信轿,通過javascript傳過來的responseId獲取對應(yīng)的WVJBResponseCallback晃痴。然后執(zhí)行這個block。到這里從OC發(fā)送消息到j(luò)avascript并且javascript返回消息給OC的流程走完了财忽。
WEB發(fā)消息給OC
首先通過ExampleAPP.html中的bridge.callHandler方法倘核,這里的bridge就是window.WebViewJavascriptBridge對象:
bridge.callHandler('OC提供方法給JS調(diào)用',params, function(response) {
log('JS調(diào)用OC的返回值', response)
})
接下來調(diào)用window.WebViewJavascriptBridge中的callHander方法
//web端調(diào)用一個OC注冊的消息
function callHandler(handlerName, data, responseCallback) {
if (arguments.length == 2 && typeof data == 'function') {
responseCallback = data;
data = null;
}
_doSend({ handlerName: handlerName, data: data }, responseCallback);
}
然后調(diào)用WebViewJavascriptBridge_JS.js中的方法執(zhí)行具體的操作。具體就和OC調(diào)用javascript過程一樣了即彪,就不解釋了紧唱。
//把消息從JS發(fā)送到OC,執(zhí)行具體的發(fā)送操作隶校。
function doSend(message, responseCallback) {
if (responseCallback) {
var callbackId = 'cb' + (uniqueId++) + '_' + new Date().getTime();
//存儲消息的回調(diào)ID
responseCallbacks[callbackId] = responseCallback;
//把消息對應(yīng)的回調(diào)ID和消息一起發(fā)送漏益,以供消息返回以后使用。
message['callbackId'] = callbackId;
}
//把消息放入消息列表
sendMessageQueue.push(message);
//下面這句話會出發(fā)JS對OC的調(diào)用
//讓webview執(zhí)行跳轉(zhuǎn)操作深胳,從而可以在
//webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler 中攔截到JS發(fā)給OC的消息
messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
}
總結(jié)
其實現(xiàn)在想想绰疤,原理很簡單。
分別在OC環(huán)境和javascript環(huán)境都保存一個bridge對象舞终,里面維持著requestId,callbackId,以及每個id對應(yīng)的具體實現(xiàn)轻庆。
OC通過javascript環(huán)境的window.WebViewJavascriptBridge對象來找到具體的方法癣猾,然后執(zhí)行。
javascript通過改變iframe的src來出發(fā)webview的代理方法webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler從而實現(xiàn)把javascript消息發(fā)送給OC這個功能余爆。
其實這里只是解析了webview與OC交互的橋接問題纷宇,其他比如webview中的請求攔截、添加進度條蛾方、運營商劫持像捶、如何組織交互規(guī)則等問題這里還沒有涉及。這些在我們項目中運用桩砰,具體就不抽出來了作岖。