23mofang-react-native-webview-bridge 中文文档教程

Question

Please take a look at this issue first

React Native WebView Javascript Bridge

我一直在测试和阅读很多方法来安全地在 react-native 和 webview 之间建立桥梁。 我很高兴地宣布等待已经结束，从 React-Native 0.20 及更高版本 开始，该桥已完全正常运行。

Installation

为了使用此扩展，您必须执行以下步骤：

在您的 react-native 项目中，运行 npm install react-native-webview-bridge --save

iOS

1. go to xcode's Project Navigator tab

2. right click on Libraries
3. select Add Files to ... option

4. navigate to node_modules/react-native-webview-bridge/ios and add React-Native-Webview-Bridge.xcodeproj folder

5. on project Project Navigator tab, click on your project's name and select Target's name and from there click on Build Phases

6. expand Link Binary With Libraries and click + sign to add a new one.
7. select libReact-Native-Webviwe-Bridge.a and click Add button.

8. clean compile to make sure your project can compile and build.

Android

1. add the following import to MainApplication.java (MainActivity.java if RN < 0.29) of your application

import com.github.alinz.reactnativewebviewbridge.WebViewBridgePackage;

2. add the following code to add the package to MainApplication.java`` (MainActivity.java` if RN < 0.29)

protected List<ReactPackage> getPackages() {
        return Arrays.<ReactPackage>asList(
            new MainReactPackage(),
                new WebViewBridgePackage() //<- this
        );
    }

3. add the following codes to your android/setting.gradle

您可能有多个第 3 方库，请确保您没有创建多个包含。

include ':app', ':react-native-webview-bridge'
project(':react-native-webview-bridge').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-webview-bridge/android')

4. edit android/app/build.gradle and add the following line inside dependencies

compile project(':react-native-webview-bridge')

5. run react-native run-android to see if everything is compilable.

Usage

只需使用您选择的一种方式导入模块：

** CommonJS 样式 **

var WebViewBridge = require('react-native-webview-bridge');

ES6/ES2015 样式 **

import WebViewBridge from 'react-native-webview-bridge';

WebViewBridge 是 WebView 的扩展。 一旦加载，它就会将特殊脚本注入任何页面。 它还通过添加 1 个新方法和 1 个新道具扩展了 WebView 的功能。

sendToBridge(message)

消息必须是字符串。 因为这是在 native 和 webview 之间来回发送数据的唯一方法。

onBridgeMessage

这是一个需要成为功能的道具。 一旦从 webview 收到消息，它将被调用。 接收到的消息类型也是字符串。

allowFileAccessFromFileURLs (Android only)

这是一个允许通过 file:// 本地加载的页面访问其他 file:// 资源的道具。 传递到 WebView 中相应的设置。 对于 Android 4.1 及更高版本，默认值为 false。

allowUniversalAccessFromFileURLs (Android only)

这是一个允许通过 file:// 本地加载的页面访问任何来源的资源的道具。 传递到 WebView 中相应的设置。 对于 Android 4.1 及更高版本，默认值为 false。

Bridge Script

bridge 脚本是一个特殊的脚本，它注入所有的 webview。 它会自动注册一个名为 WebViewBridge 的全局变量。 它有 2 个可选的实现方法和一个向本机端发送消息的方法。

send(message)

此方法向本机端发送消息。 消息必须是字符串类型，否则将调用 onError 方法。

onMessage

这个方法需要实现。 一旦消息从本机端到达，它将被调用。 消息的类型是字符串。

onError (iOS only)

这是一种错误报告方法。 如果在发送消息过程中发生错误，它将被调用。 它收到字符串类型的错误消息。

Notes

一旦页面转到不同的 URL，就会注入一个特殊的桥接脚本。 因此，您无需管理何时需要注入。

您仍然可以传递自己的 javascript 以注入到 webview 中。 但是，将首先注入 Bridge 脚本，然后注入您的自定义脚本。

Simple Example

这个例子可以在 examples 文件夹中找到。

const injectScript = `
  (function () {
                    if (WebViewBridge) {

                      WebViewBridge.onMessage = function (message) {
                        if (message === "hello from react-native") {
                          WebViewBridge.send("got the message inside webview");
                        }
                      };

                      WebViewBridge.send("hello from webview");
                    }
                  }());
`;

var Sample2 = React.createClass({
  onBridgeMessage(message){
    const { webviewbridge } = this.refs;

    switch (message) {
      case "hello from webview":
        webviewbridge.sendToBridge("hello from react-native");
        break;
      case "got the message inside webview":
        console.log("we have got a message from webview! yeah");
        break;
    }
  },

  render() {
    return (
      <WebViewBridge
        ref="webviewbridge"
        onBridgeMessage={this.onBridgeMessage.bind(this)}
        injectedJavaScript={injectScript}
        source={{uri: "http://google.com"}}/>
    );
  }
});