
譯者:@coderyi9。本文翻譯自 Marcus Westin 的開源框架 WebViewJavascriptBridge 的 README,英文原文:https://github.com/marcuswestin/WebViewJavascriptBridge
WebViewJavascriptBridge 是一個讓 Objective-C 與 JavaScript 透過 UIWebView/WebView 雙向溝通的 iOS/OSX 橋梁。如果你喜歡 WebViewJavascriptBridge,可能也會想看看 WebViewProxy。
先說原理:Objective-C 呼叫 JavaScript 很簡單,透過 webView 的 stringByEvaluatingJavaScriptFromString: 方法執行 JavaScript 程式碼即可;JavaScript 呼叫 Objective-C,則是透過 web view 的代理方法 shouldStartLoadWithRequest: 攔截 JavaScript 發出的網路請求來實現。
有不少公司與專案在使用 WebViewJavascriptBridge。這份清單並不完整,你可以隨意補充:
先打開 Example Apps 資料夾,開啟 iOS 或 OSX 的專案並執行看看。
要在自己的專案中使用:
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(OSX)來建立實例:
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) {
/* Init your app here */
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)
})
})Objective-C API
[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 的生命週期事件。
[WebViewJavascriptBridge bridgeForWebView:webView handler:^(id data, WVJBResponseCallback responseCallback) {
NSLog(@"Received message from javascript: %@", data);
if (responseCallback) {
responseCallback(@"Right back atcha");
}
}]
[WebViewJavascriptBridge bridgeForWebView:webView webViewDelegate:self handler:^(id data, WVJBResponseCallback responseCallback) { /* ... */ }];[bridge send:(id)data] [bridge send:(id)data responseCallback:(WVJBResponseCallback)responseCallback]
送一個訊息給 JavaScript,並可在成功後透過 responseCallback block 做出反應。
[self.bridge send:@"Hi"];
[self.bridge send:[NSDictionary dictionaryWithObject:@"Foo" forKey:@"Bar"]];
[self.bridge send:@"I expect a response!" responseCallback:^(id responseData) {
NSLog(@"Got response! %@", responseData);
}];[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]
呼叫 JavaScript 中名為 handlerName 的 handler,並可在成功後透過 responseCallback block 做出反應。
[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,才能在 JS 端建立橋梁。標準實作用 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)等待 WebViewJavascriptBridgeReady 這個 DOM 事件。
document.addEventListener('WebViewJavascriptBridgeReady', function(event) {
var bridge = event.bridge
// Start using the bridge
}, false)bridge.init(function messageHandler(data, response) { ... })初始化這個橋,並觸發 WebViewJavascriptBridgeReady 的事件處理器。messageHandler 函數會接收所有透過 Objective-C 的 [bridge send:(id)data] 與 [bridge send:(id)data responseCallback:] 送來的訊息。若 Objective-C 送訊息時帶了 WVJBResponseCallback block,就可以透過 response 物件回覆。
bridge.init(function(data, responseCallback) {
alert("Got data " + JSON.stringify(data))
if (responseCallback) {
responseCallback("Right back atcha!")
}
})bridge.send("Hi there!")
bridge.send({ Foo: "Bar" })
bridge.send(data, function responseCallback(responseData) { ... })送訊息給 Objective-C,並可在成功後透過 responseCallback 函數做出反應。
bridge.send("Hi there!")
bridge.send("Hi there!", function(responseData) {
alert("I got a response! " + JSON.stringify(responseData))
})bridge.registerHandler("handlerName", function(responseData) { ... })註冊一個名為 handlerName 的 handler,Objective-C 可透過 [bridge callHandler:"handlerName" data:@"Foo"] 或帶 responseCallback 的版本呼叫它。
bridge.registerHandler("showAlert", function(data) {
alert(data)
})
bridge.registerHandler("getCurrentPageUrl", function(data, responseCallback) {
responseCallback(document.location.toString())
})Contributors:https://github.com/marcuswestin/WebViewJavascriptBridge/graphs/contributors
Forks:https://github.com/marcuswestin/WebViewJavascriptBridge/network/members
注:iOS 4 支援尚未在 V2+ 版本中測試過。WebViewJavascriptBridge 預設使用 NSJSONSerialization;如果你需要 iOS 4 支援,可以改用 JSONKit,並在專案中加上 USE_JSONKIT 的預處理巨集。