最全面总结 Android WebView与 JS 的交互方式

前言

现在很多App里都内置了Web网页（Hybrid App），比如说很多电商平台，淘宝、京东、聚划算等等，如下图

京东首页

上述功能是由Android的WebView实现的，其中涉及到Android客户端与Web网页交互的实现

今天我将全面介绍Android通过WebView与JS交互的全面方式

阅读本文前请先阅读：Android开发：最全面、最易懂的Webview详解

目录

目录

1. 交互方式总结

Android与JS通过WebView互相调用方法，实际上是：

Android去调用JS的代码

JS去调用Android的代码

二者沟通的桥梁是WebView

对于Android调用JS代码的方法有2种：

通过WebView的loadUrl（）

通过WebView的evaluateJavascript（）

对于JS调用Android代码的方法有3种：

通过WebView的addJavascriptInterface（）进行对象映射

通过WebViewClient的shouldOverrideUrlLoading ()方法回调拦截 url

通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（）消息

2. 具体分析

2.1  Android通过WebView调用 JS 代码

对于Android调用JS代码的方法有2种：

通过WebView的loadUrl（）

通过WebView的evaluateJavascript（）

方式1：通过WebView的loadUrl（）

实例介绍：点击Android按钮，即调用WebView JS（文本名为javascript）中callJS（）

具体使用：

步骤1：将需要调用的JS代码以.html格式放到src/main/assets文件夹里

为了方便展示，本文是采用Andorid调用本地JS代码说明；

实际情况时，Android更多的是调用远程JS代码，即将加载的JS代码路径改成url即可

需要加载JS代码：javascript.html

// 文本名：javascript// JS代码

步骤2：在Android里通过WebView设置调用JS代码

Android代码：MainActivity.java

注释已经非常清楚

publicclassMainActivityextendsAppCompatActivity{WebViewmWebView;Buttonbutton;@OverrideprotectedvoidonCreate(BundlesavedInstanceState){super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);mWebView=(WebView)findViewById(R.id.webview);WebSettingswebSettings=mWebView.getSettings();// 设置与Js交互的权限webSettings.setJavaScriptEnabled(true);// 设置允许JS弹窗webSettings.setJavaScriptCanOpenWindowsAutomatically(true);// 先载入JS代码// 格式规定为:file:///android_asset/文件名.htmlmWebView.loadUrl("file:///android_asset/javascript.html");button=(Button)findViewById(R.id.button);button.setOnClickListener(newView.OnClickListener(){@OverridepublicvoidonClick(Viewv){// 通过Handler发送消息mWebView.post(newRunnable(){@Overridepublicvoidrun(){// 注意调用的JS方法名要对应上// 调用javascript的callJS()方法mWebView.loadUrl("javascript:callJS()");}});}});// 由于设置了弹窗检验调用结果,所以需要支持js对话框// webview只是载体，内容的渲染需要使用webviewChromClient类去实现// 通过设置WebChromeClient对象处理JavaScript的对话框//设置响应js 的Alert()函数mWebView.setWebChromeClient(newWebChromeClient(){@OverridepublicbooleanonJsAlert(WebViewview,Stringurl,Stringmessage,finalJsResultresult){AlertDialog.Builderb=newAlertDialog.Builder(MainActivity.this);b.setTitle("Alert");b.setMessage(message);b.setPositiveButton(android.R.string.ok,newDialogInterface.OnClickListener(){@OverridepublicvoidonClick(DialogInterfacedialog,intwhich){result.confirm();}});b.setCancelable(false);b.create().show();returntrue;}});}}

效果图

特别注意：JS代码调用一定要在onPageFinished（）回调之后才能调用，否则不会调用。

onPageFinished()属于WebViewClient类的方法，主要在页面加载结束时调用

方式2：通过WebView的evaluateJavascript（）

优点：该方法比第一种方法效率更高、使用更简洁。

因为该方法的执行不会使页面刷新，而第一种方法（loadUrl ）的执行则会。

Android 4.4 后才可使用

具体使用

// 只需要将第一种方法的loadUrl()换成下面该方法即可mWebView.evaluateJavascript（"javascript:callJS()",newValueCallback() {@OverridepublicvoidonReceiveValue(String value){//此处为 js 返回的结果}});

}

2.1.2 方法对比

方式对比图

2.1.3 使用建议

两种方法混合使用，即Android 4.4以下使用方法1，Android 4.4以上方法2

// Android版本变量finalint version=Build.VERSION.SDK_INT;// 因为该方法在 Android 4.4 版本才可使用，所以使用时需进行版本判断if(version<18){mWebView.loadUrl("javascript:callJS()");}else{mWebView.evaluateJavascript（"javascript:callJS()",newValueCallback(){@OverridepublicvoidonReceiveValue(String value){//此处为 js 返回的结果}});}

2.2 JS通过WebView调用 Android 代码

对于JS调用Android代码的方法有3种：

通过WebView的addJavascriptInterface（）进行对象映射

通过WebViewClient的shouldOverrideUrlLoading ()方法回调拦截 url

通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（）消息

2.2.1 方法分析

方式1：通过WebView的addJavascriptInterface（）进行对象映射

步骤1：定义一个与JS对象映射关系的Android类：AndroidtoJs

AndroidtoJs.java（注释已经非常清楚）

// 继承自Object类publicclassAndroidtoJsextendsObject{// 定义JS需要调用的方法// 被JS调用的方法必须加入@JavascriptInterface注解@JavascriptInterfacepublicvoidhello(Stringmsg){System.out.println("JS调用了Android的hello方法");}}

步骤2：将需要调用的JS代码以.html格式放到src/main/assets文件夹里

需要加载JS代码：javascript.html

//点击按钮则调用callAndroid函数

步骤3：在Android里通过WebView设置Android类与JS代码的映射

详细请看注释

publicclassMainActivityextendsAppCompatActivity{WebViewmWebView;@OverrideprotectedvoidonCreate(BundlesavedInstanceState){super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);mWebView=(WebView)findViewById(R.id.webview);WebSettingswebSettings=mWebView.getSettings();// 设置与Js交互的权限webSettings.setJavaScriptEnabled(true);// 通过addJavascriptInterface()将Java对象映射到JS对象//参数1：Javascript对象名//参数2：Java对象名mWebView.addJavascriptInterface(newAndroidtoJs(),"test");//AndroidtoJS类对象映射到js的test对象// 加载JS代码// 格式规定为:file:///android_asset/文件名.htmlmWebView.loadUrl("file:///android_asset/javascript.html");

效果图

特点

优点：使用简单

仅将Android对象和JS对象映射即可

缺点：存在严重的漏洞问题，具体请看文章：你不知道的 Android WebView 使用漏洞

方式2：通过WebViewClient的方法shouldOverrideUrlLoading ()回调拦截 url

具体原理：

Android通过WebViewClient的回调方法shouldOverrideUrlLoading ()拦截 url

解析该 url 的协议

如果检测到是预先约定好的协议，就调用相应方法

即JS需要调用Android的方法

具体使用：

步骤1：在JS约定所需要的Url协议

JS代码：javascript.html

以.html格式放到src/main/assets文件夹里

点击调用Android代码

当该JS通过Android的mWebView.loadUrl("file:///android_asset/javascript.html")加载后，就会回调shouldOverrideUrlLoading （），接下来继续看步骤2：

步骤2：在Android通过WebViewClient复写shouldOverrideUrlLoading （）

MainActivity.java

publicclassMainActivityextendsAppCompatActivity{WebView mWebView;//    Button button;@OverrideprotectedvoidonCreate(Bundle savedInstanceState){super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);mWebView=(WebView)findViewById(R.id.webview);WebSettings webSettings=mWebView.getSettings();// 设置与Js交互的权限webSettings.setJavaScriptEnabled(true);// 设置允许JS弹窗webSettings.setJavaScriptCanOpenWindowsAutomatically(true);// 步骤1：加载JS代码// 格式规定为:file:///android_asset/文件名.htmlmWebView.loadUrl("file:///android_asset/javascript.html");// 复写WebViewClient类的shouldOverrideUrlLoading方法mWebView.setWebViewClient(newWebViewClient(){@Overridepublic booleanshouldOverrideUrlLoading(WebView view,String url){// 步骤2：根据协议的参数，判断是否是所需要的url// 一般根据scheme（协议格式） & authority（协议名）判断（前两个参数）//假定传入进来的 url = "js://webview?arg1=111&arg2=222"（同时也是约定好的需要拦截的）Uri uri=Uri.parse(url);// 如果url的协议 = 预先约定的 js 协议// 就解析往下解析参数if(uri.getScheme().equals("js")){// 如果 authority  = 预先约定协议里的 webview，即代表都符合约定的协议// 所以拦截url,下面JS开始调用Android需要的方法if(uri.getAuthority().equals("webview")){//  步骤3：// 执行JS所需要调用的逻辑System.out.println("js调用了Android的方法");// 可以在协议上带有参数并传递到Android上HashMapparams=newHashMap<>();Setcollection=uri.getQueryParameterNames();}returntrue;}returnsuper.shouldOverrideUrlLoading(view,url);}});}}

效果图

特点

优点：不存在方式1的漏洞；

缺点：JS获取Android方法的返回值复杂。

如果JS想要得到Android方法的返回值，只能通过 WebView 的loadUrl （）去执行 JS 方法把返回值传递回去，相关的代码如下：

// Android：MainActivity.javamWebView.loadUrl("javascript:returnResult("+result+")");// JS：javascript.htmlfunctionreturnResult(result){alert("result is"+result);}

方式3：通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（）消息

在JS中，有三个常用的对话框方法：

Paste_Image.png

方式3的原理：Android通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调分别拦截JS对话框

（即上述三个方法），得到他们的消息内容，然后解析即可。

下面的例子将用拦截 JS的输入框（即prompt（）方法）说明 ：

常用的拦截是：拦截 JS的输入框（即prompt（）方法）

因为只有prompt（）可以返回任意类型的值，操作最全面方便、更加灵活；而alert（）对话框没有返回值；confirm（）对话框只能返回两种状态（确定 / 取消）两个值

步骤1：加载JS代码，如下：

javascript.html

以.html格式放到src/main/assets文件夹里

点击调用Android代码

当使用mWebView.loadUrl("file:///android_asset/javascript.html")加载了上述JS代码后，就会触发回调onJsPrompt（），具体如下：

如果是拦截警告框（即alert()），则触发回调onJsAlert（）；

如果是拦截确认框（即confirm()），则触发回调onJsConfirm（）；

步骤2：在Android通过WebChromeClient复写onJsPrompt（）

publicclassMainActivityextendsAppCompatActivity{WebView mWebView;//    Button button;@OverrideprotectedvoidonCreate(Bundle savedInstanceState){super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);mWebView=(WebView)findViewById(R.id.webview);WebSettings webSettings=mWebView.getSettings();// 设置与Js交互的权限webSettings.setJavaScriptEnabled(true);// 设置允许JS弹窗webSettings.setJavaScriptCanOpenWindowsAutomatically(true);// 先加载JS代码// 格式规定为:file:///android_asset/文件名.htmlmWebView.loadUrl("file:///android_asset/javascript.html");mWebView.setWebChromeClient(newWebChromeClient(){// 拦截输入框(原理同方式2)// 参数message:代表promt（）的内容（不是url）// 参数result:代表输入框的返回值@OverridepublicbooleanonJsPrompt(WebView view,String url,String message,String defaultValue,JsPromptResult result){// 根据协议的参数，判断是否是所需要的url(原理同方式2)// 一般根据scheme（协议格式） & authority（协议名）判断（前两个参数）//假定传入进来的 url = "js://webview?arg1=111&arg2=222"（同时也是约定好的需要拦截的）Uri uri=Uri.parse(message);// 如果url的协议 = 预先约定的 js 协议// 就解析往下解析参数if(uri.getScheme().equals("js")){// 如果 authority  = 预先约定协议里的 webview，即代表都符合约定的协议// 所以拦截url,下面JS开始调用Android需要的方法if(uri.getAuthority().equals("webview")){//// 执行JS所需要调用的逻辑System.out.println("js调用了Android的方法");// 可以在协议上带有参数并传递到Android上HashMapparams=newHashMap<>();

                                                    Set collection = uri.getQueryParameterNames();

                                                    //参数result:代表消息框的返回值(输入值)

                                                    result.confirm("js调用了Android的方法成功啦");

                                                }

                                                return true;

                                            }

                                            return super.onJsPrompt(view, url, message, defaultValue, result);

                                        }

// 通过alert()和confirm()拦截的原理相同，此处不作过多讲述

                                        // 拦截JS的警告框

                                        @Override

                                        public boolean onJsAlert(WebView view, String url, String message, JsResult result) {returnsuper.onJsAlert(view,url,message,result);}                                        // 拦截JS的确认框

                                        @Override

                                        public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {returnsuper.onJsConfirm(view,url,message,result);}                                    }

        );

            }

        }

效果图

Demo地址

上述所有代码均存放在：Carson_Ho的Github地址 ： WebView Demo

2.2.2 三种方式的对比 & 使用场景

示意图

3. 总结

本文主要对Android通过WebView与JS的交互方式进行了全面介绍

示意图

关于WebView的系列文章希望会对你有所帮助：

作者：Carson_Ho

链接：https://www.jianshu.com/p/345f4d8a5cfa

来源：

著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。