WebViewJavascriptBridge_LH 1.0.0

WebViewJavascriptBridge_LH 1.0.0

测试已测试
语言语言 Obj-CObjective C
许可证 MIT
发布最后发布2016年9月

Ziv_Dong 维护。



  • 作者:
  • dsn

WebViewJavascriptBridge

在 UIWebViews/WebViews 中在 Obj-C 和 JavaScript 之间发送消息的 iOS/OSX 桥接器。

谁使用了 WebViewJavascriptBridge?

WebViewJavascriptBridge 被许多公司和项目使用。以下是一个不完全的示例列表

安装 (iOS & OSX)

手动安装

WebViewJavascriptBridge 文件夹拖到你的项目中。

在出现的对话框中,取消选择“将项目添加到目标组的文件夹中”,并选择“为任何文件夹创建组”。

示例

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

要在您的项目中使用 WebViewJavascriptBridge

使用方法

1) 导入头文件并声明一个ivar属性

#import "WebViewJavascriptBridge.h"

...

@property WebViewJavascriptBridge* bridge;

2) 使用 UIWebView (iOS) 或 WebView (OSX) 实例化 WebViewJavascriptBridge

self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView];

3) 在 Obj-C 中注册一个处理程序,并调用 JS 处理程序

[self.bridge registerHandler:@"ObjC Echo" handler:^(id data, WVJBResponseCallback responseCallback) {
    NSLog(@"ObjC Echo called with: %@", data);
    responseCallback(data);
}];
[self.bridge callHandler:@"JS Echo" responseCallback:^(id responseData) {
    NSLog(@"ObjC received response: %@", responseData);
}];

4) 将 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 = 'wvjbscheme://__BRIDGE_LOADED__';
    document.documentElement.appendChild(WVJBIframe);
    setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
}

5) 最后,调用 setupWebViewJavascriptBridge 然后使用桥接器注册处理程序并调用 Obj-C 处理程序

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)
    })
})

WKWebView 支持 (iOS 8+ & OS 10.10+)

(警告:WKWebView 仍然存在错误和缺失的网络 API。它可能不是简单的替换项。

WebViewJavascriptBridge 支持 iOS 8 和 OSX Yosemite 的 WKWebView。为了使用 WKWebView,您需要实例化 WKWebViewJavascriptBridge。其余的 WKWebViewJavascriptBridge API 与 WebViewJavascriptBridge 相同。

1) 导入头文件

#import "WKWebViewJavascriptBridge.h"

2) 使用 WKWebView 对象实例化 WKWebViewJavascriptBridge

WKWebViewJavascriptBridge* bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView];

自动引用计数(ARC)

此库依赖于ARC,所以如果您的项目使用了ARC,则一切正常。但如果您的项目没有ARC支持,请确保执行以下步骤:

1) 在Xcode项目中打开项目设置 -> '构建阶段'

2) 展开编译代码标题,找到属于此库的所有 *.m 文件。注意此列表中每个源文件前的“编译器标志”

3) 为每个文件添加'-fobjc-arc'标志

现在,所有WVJB文件都将使用具有ARC支持的编译方式。

贡献者 & 分支

贡献者:[https://github.com/marcuswestin/WebViewJavascriptBridge/graphs/contributors](https://github.com/marcuswestin/WebViewJavascriptBridge/graphs/contributors)

分支:[https://github.com/marcuswestin/WebViewJavascriptBridge/network/members](https://github.com/marcuswestin/WebViewJavascriptBridge/network/members)

API参考

ObjC API

[WebViewJavascriptBridge bridgeForWebView:(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:UIWebViewDelegate*)webViewDelegate]

如果需要响应WebView的生命周期事件,可选设置一个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()