Android 中使用WebViewJavaScriptBridge进行H5和原生的交互

3,350 阅读3分钟

1. 概述

当我们采用H5与Native原生结合开发,使用H5去开发一些功能的时候,肯定会涉及到Android与Js互相调用的问题,通常有两种实现方式,

第一种 使用原生的addJavascriptInterface()来解决

第二种 使用第三方框架WebViewJavascriptBridge 这也是我今天要分享的部分

2.为什么要使用WebViewJavascriptBridge

对于安卓开发有一段时间的人来说,知道安卓4.4以前谷歌的webview存在安全漏洞,网站可以通过js注入就可以随便拿到客户端的重要信息,甚至轻而易举的调用本地代码进行流氓行为,谷歌后来发现有此漏洞后,增加了防御措施,如果要是js调用本地代码,开发者必须在代码中申明JavascriptInterface

列如在4.0之前我们要使得webView加载js只需如下代码:

mWebView.addJavascriptInterface(new JsToJava(), "myjsfunction");  

4.4之后调用需要在调用方法加入加入@JavascriptInterface注解,如果代码无此申明,那么也就无法使得js生效,也就是说这样就可以避免恶意网页利用js对安卓客户端的窃取和攻击。

但是即使这样,我们很多时候需要在js记载本地代码的时候,要做一些判断和限制,或者有可能也会做些过滤和对用户友好提示,因此JavascriptInterface也就无法满足我们的需求了,特此有大神就写出了WebViewJavascriptBridge框架。

3.开始使用

第一步.Android Studio 导包
repositories {
    // ...
    maven { url "https://jitpack.io" }
}

dependencies {
    compile 'com.github.lzyzsd:jsbridge:1.0.4'
}
第二步.在布局文件中添加
<com.github.lzyzsd.jsbridge.BridgeWebView
    android:id="@+id/wv_web_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />
第三步.代码中添加交互方法

H5调android方法

//android端代码
mWebView.registerHandler("test", new BridgeHandler() {
            @Override
            public void handler(String data, CallBackFunction function) {
           function.onCallBack("指定Handler收到Web发来的数据,回传数据给你");
}

//H5端代码
function test() {
           //调用本地java方法
           //第一个参数是 调用java的函数名字 第二个参数是要传递的数据 第三个参数js在被回调后具体执行方法,responseData为java层回传数据
           var data='发送消息给java代码指定接收';
           window.WebViewJavascriptBridge.callHandler(
               'test'
               ,data
               , function(responseData) {
                   bridgeLog('来自Java的回传数据: ' + responseData);
               }
           );
       }

或者

//android端代码 
mWebView.setDefaultHandler(new BridgeHandler() {
            @Override
            public void handler(String data, CallBackFunction function) {
                function.onCallBack("指定Handler收到Web发来的数据,回传数据给你");
            }
        });

//H5端代码
function test() {
           //发送消息给java代码
           var data = '发送消息给java代码全局接收';

           window.WebViewJavascriptBridge.send(
               data
               , function(responseData) {
                  bridgeLog('来自Java的回传数据: ' +responseData);
               }
           );
       }

以上两种方式 一个是指定调具体协定好的方法,一个是全局调用

android调H5

//android端代码 
mWebView.send("发送数据给web默认接收",new CallBackFunction(){
                    @Override
                    public void onCallBack(String data) {
                        Log.e(TAG, "来自web的回传数据:" + data);
                    }
                });

//H5端代码 
//注册回调函数,第一次连接时调用 初始化函数
connectWebViewJavascriptBridge(function(bridge) {
           bridge.init(function(message, responseCallback) {
               bridgeLog('默认接收收到来自Java数据: ' + message);
               var responseData = '默认接收收到来自Java的数据,回传数据给你';
               responseCallback(responseData);
           });

          
       })

或者

//android端代码 
mWebView.callHandler("test","发送数据给web指定接收",new CallBackFunction(){
                    @Override
                    public void onCallBack(String data) {
                        Log.e(TAG, "来自web的回传数据:" + data);
                    }
                });
//H5端代码 
   connectWebViewJavascriptBridge(function(bridge) {
          bridge.registerHandler("test", function(data, responseCallback) {
               bridgeLog('指定接收收到来自Java数据: ' + data);
               var responseData = '指定接收收到来自Java的数据,回传数据给你';
               responseCallback(responseData);
           });
       })

同样 两种方式一个是不指定方法,另一个是指定具体方法 到此为止还无法交互,还需要配置setWebViewClient

mWebView.setWebViewClient(new BridgeWebViewClient(mWebView));

这步非常关键,如果不配置 测试点击压根就不响应,如果你需要自定义WebViewClient,必须实现对应构造方法,而且重写的方法必须调用父类方法,如下:

private class MyWebViewClient extends BridgeWebViewClient {
	//必须
    public MyWebViewClient(BridgeWebView webView) {
        super(webView);
    }


    @Override
    public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
        super.onReceivedError(view, request, error);//这个不能省略
        // 避免出现默认的错误界面
        view.loadUrl("about:blank");
    }

到此为止,配置完毕,H5和Android就可以互相调用了

框架链接

GitHub