Android native和webview通信

左手的ㄟ右手 2023-02-28 08:50 6阅读 0赞

## 一、为什么需要webview和native通信 ##

电商或者内容类APP中，H5通常都会占据一席之地,Native跟H5通信会必不可少，比如某些场景H5通知native去分享，native通知H5局部刷新等。

## 二、js调用native ##

###### 1、借助WebView.addJavascriptInterface实现H5与Native通信 ######

WebView的addJavascriptInterface方法允许Natvive向Web页面注入Java对象，之后，在js中便可以直接访问该对象，使用@JavascriptInterface注解的方法。

public class JavaMethod {
        private MainActivity mainActivity;
        private Handler uiHandler;
    
        public JavaMethod(MainActivity mainActivity) {
            this.mainActivity = mainActivity;
            uiHandler = new Handler(Looper.getMainLooper());
        }
    
        @JavascriptInterface
        public void JsToJavaInterface(final String param) {
            uiHandler.post(new Runnable() {
                @Override
                public void run() {
                    mainActivity.setTextShow("from JavaInterface: " + param);
                }
            });
        }
    }

在前端的js代码中，是可以直接通过mJsMethodApi.callNative(jsonString)通知Native的，而且通过addJavascriptInterface注入的对象在H5的任何地方都可以调用，不存在注入时机跟注入失败的问题，在H5的head里调用都没问题。

<html>
    
        <head>
            <meta http-equiv="Content-Type" charset="UTF-8"/>
    
            <script type="text/javascript">
            </script>
        </head>
    
        <body>
    
            <h3>Js Method</h3>
            <h3 id="textshow">调用结果</h3>
            
            <input type="button" value="JavascriptInterface" onclick="window.android.JsToJavaInterface('我来自Js')"/>
    
        </body>
    
    </html>

###### 2、shouldOverrideUrlLoading ######

通过WebViewClient中的shouldOverrideUrlLoading拦截url，制定一个对应协议。

<html>
    
        <head>
            <meta http-equiv="Content-Type" charset="UTF-8"/>
    
            <script type="text/javascript">
            </script>
        </head>
    
        <body>
    
            <h3>Js Method</h3>
            <h3 id="textshow">调用结果</h3>
            
            <input type="button" value="shouldOverrideUrlLoading" onclick="document.location = 'js://jstojava?arg1=1号参数&arg2=2号参数'"/>
    
        </body>
    
    </html>

JavaMethod.java

...
        public WebViewClient getWebViewClient() {
            WebViewClient webViewClient = new WebViewClient(){
                @Override
                public boolean shouldOverrideUrlLoading(WebView view, String url) {
                    Uri uri = Uri.parse(url);
                    // 一般根据scheme(协议格式) & authority(协议名)判断
                    // url = "js://jstojava?arg1=1&arg2=2"
                    if(uri.getScheme().equals("js")) {
                        if(uri.getAuthority().equals("jstojava")) {
                            final String param1 = uri.getQueryParameter("arg1");
                            final String param2 = uri.getQueryParameter("arg2");
                            uiHandler.post(new Runnable() {
                                @Override
                                public void run() {
                                    mainActivity.setTextShow("arg1="+param1+" arg2="+param2);
                                }
                            });
                        }
                        return true;
                    }
    
                    return super.shouldOverrideUrlLoading(view, url);
                }
            };
            return webViewClient;
        }
    ...

MainAacivity.java

...
        private void initView() {
            javaMethod = new JavaMethod(this);
            webView = new WebView(this);
            WebSettings settings = webView.getSettings();
            settings.setDomStorageEnabled(true);
            settings.setJavaScriptEnabled(true);
            settings.setBlockNetworkImage(false);
            webView.setWebViewClient(javaMethod.getWebViewClient());
            webView.addJavascriptInterface(javaMethod,"android");
            frameLayout.addView(webView);
            webView.loadUrl("file:///android_asset/JsMethod.html");
        }
    ...

这种方式没有版本限制和漏洞，不过没有返回值，如果Js调用后需要android返回就得使用loadUrl()或者evaluateJavascript()回传对应的接收方法了。值得一提的是，这种方式便于和IOS通用一套协议，简便Js端的代码量。

###### 3、onJsAlert()、onJsConfirm()、onJsPrompt() ######

通过 WebChromeClient 中的onJsAlert()、onJsConfirm()、onJsPrompt()拦截Js中的alert()、confirm()、prompt() 消息。而alert、confirm、prompt代表Js中三种常用提示框，第一种没有返回值，第二种返回布尔值，第三种可返回任意值。由于考虑到灵活性，所以我们可以直接实现对prompt的拦截即可。

<html>
    
        <head>
            <meta http-equiv="Content-Type" charset="UTF-8"/>
    
            <script type="text/javascript">
            function jstojavaprompt(param){
                 result = prompt(param);
                 document.getElementById("textshow").innerHTML = (result);
            }
            
            </script>
        </head>
    
        <body>
    
            <h3>Js Method</h3>
            <h3 id="textshow">调用结果</h3>
            
            <input type="button" value="onJsPrompt" onclick="jstojavaprompt('js://jstojava?arg3=3号参数&arg4=4号参数')"/>
    
        </body>
    
    </html>

JavaMethod.java

...
        public WebChromeClient getWebChromeClient() {
            WebChromeClient webChromeClient = new WebChromeClient(){
                @Override
                public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, final JsPromptResult result) {
                    Uri uri = Uri.parse(message);
                    if(uri.getScheme().equals("js")) {
                        if(uri.getAuthority().equals("jstojava")) {
                            final String param3 = uri.getQueryParameter("arg3");
                            final String param4 = uri.getQueryParameter("arg4");
                            uiHandler.post(new Runnable() {
                                @Override
                                public void run() {
                                    mainActivity.setTextShow("arg3="+param3+" arg4="+param4);
                                    result.confirm("我来自onJsPrompt");
                                }
                            });
                        }
                        return true;
                    }
    
                    return super.onJsPrompt(view, url, message, defaultValue, result);
                }
            };
            return webChromeClient;
        }
    ...

MainActivity.java

...
        private void initView() {
            javaMethod = new JavaMethod(this);
            webView = new WebView(this);
            WebSettings settings = webView.getSettings();
            settings.setDomStorageEnabled(true);
            settings.setJavaScriptEnabled(true);
            settings.setBlockNetworkImage(false);
            webView.setWebChromeClient(javaMethod.getWebChromeClient());
            webView.addJavascriptInterface(javaMethod,"android");
            frameLayout.addView(webView);
            webView.loadUrl("file:///android_asset/JsMethod.html");
        }
    ...

## 三、Android调用js ##

###### 1、loadUrl() 方式 ######

JsMethod.html

<html>
    
        <head>
            <meta http-equiv="Content-Type" charset="UTF-8"/>
    
            <script type="text/javascript">
                var s = '我来自Js方法';
                function javatojscallback(param){
                     document.getElementById("textshow").innerHTML = (param);
                     //window.android.JsToJavaInterface(s)
                }
            </script>
        </head>
    
        <body>
    
            <h3>Js Method</h3>
            <h3 id="textshow">调用结果</h3>
    
        </body>
    
    </html>

window.android.JsToJavaInterface(s)是Js调用android的方法，由于loadUrl()不能从Js返回数据，可以让Js回调android的方法回传参数。

MainActivity.java

...
        private void initView() {
            javaMethod = new JavaMethod(this);
            webView = new WebView(this);
            WebSettings settings = webView.getSettings();
            settings.setDomStorageEnabled(true);
            settings.setJavaScriptEnabled(true);
            settings.setBlockNetworkImage(false);
            frameLayout.addView(webView);
            webView.loadUrl("file:///android_asset/JsMethod.html");
        }
    ...

js调用

webView.loadUrl("javascript:javatojscallback('我来自Java')");

###### 2、evaluateJavascript() ######

<html>
    
        <head>
            <meta http-equiv="Content-Type" charset="UTF-8"/>
    
            <script type="text/javascript">
                var s = '我来自Js方法';
                function javatojswith(param){
                     document.getElementById("textshow").innerHTML = (param);
                     return s;
                }
            </script>
        </head>
    
        <body>
    
            <h3>Js Method</h3>
            <h3 id="textshow">调用结果</h3>
    
        </body>
    
    </html>

调用js

webView.evaluateJavascript("javascript:javatojswith('我来自Java')",
                new ValueCallback<String>() {
            @Override
            public void onReceiveValue(String s) {
                textShow.setText(s);
            }
        });

相信已经大家已经注意到，被调用的Js方法是有返回值的，如果是采用loadUrl()调用，返回值也会用loadUrl()载入，直接显示在WebView上，这显然是不对的，我们只想隐形的接收返回值，而evaluateJavascript()就提供了这样的隐形接收方式，不会调用到loadUrl()。