
譯者:@coderyi9。本文整理自 Marcus Westin 開源框架 WebViewJavascriptBridge 的 README,專案網址為 https://github.com/marcuswestin/WebViewJavascriptBridge。
WebViewJavascriptBridge 是一個讓 Objective-C 與 JavaScript 能透過 UIWebView / WebView 互相傳遞訊息的 iOS / OS X 橋梁。如果你喜歡它,可能也會想看看同作者的 WebViewProxy。
Objective-C 呼叫 JavaScript 相對簡單,透過 webView 的 stringByEvaluatingJavaScriptFromString: 方法執行 JavaScript 字串即可。
反向的 JavaScript 呼叫 Objective-C,則是藉由 web view 的代理方法 shouldStartLoadWithRequest: 攔截 JavaScript 發出的網路請求,從中解析並分派,藉此完成呼叫。
不少公司與專案都在用它,這份清單並不完整,歡迎自行補充:
最快的上手方式是先打開 Example Apps 資料夾,開啟 iOS 或 OS X 的範例工程直接執行。
要放進自己的工程,步驟如下:
1) 把 WebViewJavascriptBridge 資料夾拖進工程。在跳出來的對話框中,取消勾選「Copy items into destination group's folder」(若你已自行複製過檔案),並選擇「Create groups for any folders」。
2) 引入標頭檔並宣告屬性:
#import "WebViewJavascriptBridge.h" ... @property WebViewJavascriptBridge* bridge;
3) 以一個 UIWebView(iOS)或 WebView(OS X)實例化:
self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView handler:^(id data, WVJBResponseCallback responseCallback) {
NSLog(@"Received message from javascript: %@", data);
responseCallback(@"Right back atcha");
}];
4) 從 Objective-C 主動送訊息給 JavaScript:
[self.bridge send:@"Well hello there"];
[self.bridge send:[NSDictionary dictionaryWithObject:@"Foo" forKey:@"Bar"]];
[self.bridge send:@"Give me a response, will you?" responseCallback:^(id responseData) {
NSLog(@"ObjC got its response! %@", responseData);
}];
5) JavaScript 這邊則這樣接:
function connectWebViewJavascriptBridge(callback) {
if (window.WebViewJavascriptBridge) {
callback(WebViewJavascriptBridge)
} else {
document.addEventListener('WebViewJavascriptBridgeReady', function() {
callback(WebViewJavascriptBridge)
}, false)
}
}
connectWebViewJavascriptBridge(function(bridge) {
/* 在這裡初始化你的 app */
bridge.init(function(message, responseCallback) {
alert('Received message: ' + message)
if (responseCallback) {
responseCallback("Right back atcha")
}
})
bridge.send('Hello from the javascript')
bridge.send('Please respond to this', function responseCallback(responseData) {
console.log("Javascript got its response", responseData)
})
})
[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webview handler:(WVJBHandler)handler] [WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webview webViewDelegate:(UIWebViewDelegate*)webViewDelegate handler:(WVJBHandler)handler]
為 web view 建立一座 JavaScript 橋梁。若 JavaScript 需要回傳結果,WVJBResponseCallback 不可為 nil。透過 webViewDelegate: 參數,你也能取得 web view 的生命週期事件。
[bridge send:(id)data] [bridge send:(id)data responseCallback:(WVJBResponseCallback)responseCallback]
送一個訊息給 JavaScript,並可在成功後透過 responseCallback block 做反應。
[bridge registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler]
註冊名為 handlerName 的 handler,JavaScript 可用 WebViewJavascriptBridge.callHandler("handlerName") 呼叫它。
[self.bridge registerHandler:@"getScreenHeight" handler:^(id data, WVJBResponseCallback responseCallback) {
responseCallback([NSNumber numberWithInt:[UIScreen mainScreen].bounds.size.height]);
}];
[bridge callHandler:(NSString*)handlerName data:(id)data] [bridge callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)callback]
[self.bridge callHandler:@"showAlert" data:@"Hi from ObjC to JS!"];
[self.bridge callHandler:@"getCurrentPageUrl" data:nil responseCallback:^(id responseData) {
NSLog(@"Current UIWebView page URL is: %@", responseData);
}];
WebViewJavascriptBridge 需要把 WebViewJavascriptBridge.js.txt 注入 web view,才能在 JavaScript 端建立橋梁。標準做法是用 mainBundle 尋找該檔案;若你建立的是靜態函式庫並把檔案放在別處,可用帶 resourceBundle: 的版本:
[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webView
webViewDelegate:(UIWebViewDelegate*)webViewDelegate
handler:(WVJBHandler)handler
resourceBundle:(NSBundle*)bundle
[WebViewJavascriptBridge bridgeForWebView:_webView
webViewDelegate:self
handler:^(id data, WVJBResponseCallback responseCallback) {
NSLog(@"Received message from javascript: %@", data);
} resourceBundle:[NSBundle bundleWithURL:[[NSBundle mainBundle] URLForResource:@"ResourcesBundle" withExtension:@"bundle"]]];
document.addEventListener('WebViewJavascriptBridgeReady', function onBridgeReady(event) {
...
}, false)
document.addEventListener('WebViewJavascriptBridgeReady', function(event) {
var bridge = event.bridge
// 開始使用 bridge
}, false)
bridge.init(function messageHandler(data, response) { ... })
初始化這座橋,並觸發 WebViewJavascriptBridgeReady 事件的處理器。messageHandler 會接收所有由 Objective-C 透過 send: 與 send:responseCallback: 送來的消息;若對方帶了回呼,就能用 response 回覆。
bridge.send("Hi there!")
bridge.send({ Foo: "Bar" })
bridge.send(data, function responseCallback(responseData) { ... })
bridge.registerHandler("handlerName", function(responseData) { ... })
Objective-C 端可用 [bridge callHandler:@"handlerName" data:@"Foo"] 或帶 responseCallback: 的版本來呼叫。
整體設計相當克制:以 handler 名稱作為雙向的函式註冊表,再用回呼 block 完成非同步回傳,就能在原生與網頁之間搭出一條乾淨的通道。