WJwebviewjavascriptbridge 0.1.8

WJwebviewjavascriptbridge 0.1.8

×

测试已测试✗
语言语言 Obj-CObjective C
许可证 MIT
发布最后发布2017年5月

由 wujiegoodluck 维护。

WJwebviewjavascriptbridge 0.1.8

  • 作者
  • wujiegoodluck

一个用于在 WKWebViews、UIWebViews 和 WebViews 之间发送消息的 iOS/OSX 桥接器。

谁使用了 WebViewJavascriptBridge？

WebViewJavascriptBridge 被各种公司和项目使用。以下是一个不完整的小样本列表

安装（iOS & OSX）

手动安装

将 WebViewJavascriptBridge 文件夹拖入您的项目中。

在出现的对话框中，取消选择 "将项目复制到目标组文件夹" 并选择 "为任何文件夹创建组"。

示例

请查看 Example Apps/ 文件夹。打开 iOS 或 OSX 项目并运行，以查看其实际效果。

要在您的项目中使用 WebViewJavascriptBridge

用法

  1. 导入头文件并声明一个 ivar 属性
#import "WebViewJavascriptBridge.h"

...

@property WebViewJavascriptBridge* bridge;
  1. 使用 WKWebView、UIWebView（iOS）或 WebView（OSX）实例化 WebViewJavascriptBridge
self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
  1. 在 ObjC 中注册一个处理程序，并调用 JS 处理程序
[self.bridge registerHandler:@"ObjC Echo" handler:^(id data, WVJBResponseCallback responseCallback) {
NSLog(@"ObjC Echo called with: %@", data);
responseCallback(data);
}];
[self.bridge callHandler:@"JS Echo" data:nil responseCallback:^(id responseData) {
NSLog(@"ObjC received response: %@", responseData);
}];
  1. 将 setupWebViewJavascriptBridge 复制并粘贴到您的 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 = 'https://__bridge_loaded__';
document.documentElement.appendChild(WVJBIframe);
setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
}
  1. 最终，调用 setupWebViewJavascriptBridge 并然后使用桥接器注册处理程序并调用 ObjC 处理程序
setupWebViewJavascriptBridge(function(bridge) {

/* Initialize your app here */

bridge.registerHandler('JS Echo', function(data, responseCallback) {
console.log("JS Echo called with:", data)
responseCallback(data)
})
bridge.callHandler('ObjC Echo', {'key':'value'}, function responseCallback(responseData) {
console.log("JS received response:", responseData)
})
})

ObjC API

[WebViewJavascriptBridge bridgeForWebView:(WKWebVIew/UIWebView/WebView*)webview

为指定的 webview 创建一个 JavaScript 桥接器。

示例

[WebViewJavascriptBridge bridgeForWebView:webView];
[bridge registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler]

注册一个名为 handlerName 的处理程序。然后 JavaScript 可以通过 WebViewJavascriptBridge.callHandler("handlerName") 调用此处理程序。

示例

[self.bridge registerHandler:@"getScreenHeight" handler:^(id data, WVJBResponseCallback responseCallback) {
responseCallback([NSNumber numberWithInt:[UIScreen mainScreen].bounds.size.height]);
}];
[self.bridge registerHandler:@"log" handler:^(id data, WVJBResponseCallback responseCallback) {
NSLog(@"Log: %@", data);
}];
[bridge callHandler:(NSString*)handlerName data:(id)data]
[bridge callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)callback]

调用名为 handlerName 的 JavaScript 处理器。如果提供了 responseCallback 块，JavaScript 处理器可以响应。

示例

[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);
}];

[bridge setWebViewDelegate:(id)webViewDelegate]

可选地，设置一个 WKNavigationDelegate/UIWebViewDelegate，如果您需要响应网页视图的生命周期事件。

[bridge disableJavscriptAlertBoxSafetyTimeout]

不安全。通过禁用 setTimeout 安全检查来加速桥接消息传递。只有在您不调用任何 JavaScript 弹出框函数（alert、confirm 和 prompt）时才安全地禁用此安全检查。如果您从桥接 JavaScript 代码中调用这些函数中的任何一个，应用程序将卡住。

示例

[self.bridge disableJavscriptAlertBoxSafetyTimeout];

JavaScript API

bridge.registerHandler("handlerName", function(responseData) { ... })

注册一个名为 handlerName 的处理器。ObjC 可以然后通过 [bridge callHandler:"handlerName" data:@"Foo"] 调用此处理器，或通过 [bridge callHandler:"handlerName" data:@"Foo" responseCallback:^(id responseData) { ... }]。

示例

bridge.registerHandler("showAlert", function(data) { alert(data) })
bridge.registerHandler("getCurrentPageUrl", function(data, responseCallback) {
responseCallback(document.location.toString())
})
bridge.callHandler("handlerName", data)
bridge.callHandler("handlerName", data, function responseCallback(responseData) { ... })

调用名为 handlerName 的 ObjC 处理器。如果提供了 responseCallback 函数，ObjC 处理器可以响应。

示例

bridge.callHandler("Log", "Foo")
bridge.callHandler("getScreenHeight", null, function(response) {
alert('Screen height:' + response)
})
bridge.disableJavscriptAlertBoxSafetyTimeout()

调用 bridge.disableJavscriptAlertBoxSafetyTimeout() 与在 ObjC 中调用 [bridge disableJavscriptAlertBoxSafetyTimeout]; 具有相同的效果。

示例

bridge.disableJavscriptAlertBoxSafetyTimeout()

示例

要运行示例项目，首先克隆存储库，然后从示例目录中运行 pod install。

要求

安装

WJwebviewjavascriptbridge 通过 CocoaPods 提供。要安装它，只需将以下行添加到您的 Podfile 中

pod "WJwebviewjavascriptbridge"

作者

wujiegoodluck, [email protected]

许可

WJwebviewjavascriptbridge 在 MIT 许可下可用。有关更多信息，请参阅 LICENSE 文件。