WebViewJavascriptBridge 技术文档

本文档旨在帮助用户安装、使用并详细了解 WebViewJavascriptBridge 项目。以下内容将涵盖安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

使用 CocoaPods 安装

在您的 Podfile 中添加以下代码，并运行 pod install 来安装：

pod 'WebViewJavascriptBridge', '~> 6.0'

手动安装

将 WebViewJavascriptBridge 文件夹拖入您的项目中。在弹出的对话框中，取消选中 "Copy items into destination group's folder" 并选择 "Create groups for any folders"。

2. 项目使用说明

要使用 WebViewJavascriptBridge，请按照以下步骤操作：

1. 在您的代码中导入头文件并声明一个实例变量：

#import "WebViewJavascriptBridge.h"

...

@property WebViewJavascriptBridge* bridge;

2. 为 WKWebView、UIWebView (iOS) 或 WebView (OSX) 实例化 WebViewJavascriptBridge：

self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView];

3. 在 Objective-C 中注册一个处理程序，并调用一个 JavaScript 处理程序：

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

4. 将 setupWebViewJavascriptBridge 函数复制并粘贴到您的 JavaScript 代码中：

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

5. 调用 setupWebViewJavascriptBridge 函数，并使用桥接器注册处理程序和调用 Objective-C 处理程序：

setupWebViewJavascriptBridge(function(bridge) {
	
	/* 初始化您的应用程序 */

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

3. 项目 API 使用文档

Objective-C 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]

  如果需要响应 WebView 的生命周期事件，可以选择设置 WKNavigationDelegate/UIWebViewDelegate。

• [bridge disableJavscriptAlertBoxSafetyTimeout]

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

  示例：

  [self.bridge disableJavscriptAlertBoxSafetyTimeout];
  

JavaScript API

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

  注册名为 handlerName 的处理程序。Objective-C 可以通过 [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 的 Objective-C 处理程序。如果提供了 responseCallback 函数，Objective-C 处理程序可以响应。

  示例：

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

• bridge.disableJavscriptAlertBoxSafetyTimeout()

  调用此函数与在 Objective-C 中调用 [bridge disableJavscriptAlertBoxSafetyTimeout]; 效果相同。

  示例：

  bridge.disableJavscriptAlertBoxSafetyTimeout()