Android：WebView与 JS 交互方式 都在这里了

前言

现在很多应用程序都内置了网页(Hybrid App)，比如很多电子商务平台、淘宝、京东、集散费用等。下图

这些功能由Android Webview实现，其中包括Android客户端与网页交互的实现。今天，在全面介绍Android通过WebView与JS交互的全面方法之前，我先读一下。Android开发：最全面、最易于理解的Webview详细信息

目录

1.交互摘要

Android和JS实际上通过WebView互相调用方法。

Android是通过调用JS的代码JS调用Android的代码。这两条代码的腿是WebView。

对Android调用JS代码的方法有两种。

1.通过WebView加载的URL()

2.通过WebView的evaluateJavascript()

对JS调用Android代码的方法有三种。

1.通过WebView的addJavascriptInterface()映射对象

2.通过WebViewClient的shouldOverrideUrlLoading()方法回调阻止URL

3.通过WebChromeClient的onJsalert()、onJsconfirm()、onJsPrompt()方法回调阻止JS对话框alert()、confirm()和Prompt

2.具体分析

2.1 Android通过WebView调用JS代码

对Android调用JS代码的方法有两种。

1.通过WebView加载的URL()

2.通过WebView的evaluateJavascript()

方法1:通过WebView的loadUrl()

示例说明：当按下Android按钮时，用于从WebView文本名称JavaScript(JS)调用callJS()。步骤1:将需要调用的JS代码发送到src/main/assets。以html格式放置

为了便于展示，本文档使用Andorid调用本地JS代码说明。实际上，Android更多的是调用远程JS代码。也就是说，如果将正在加载的JS代码路径更改为URL，则必须加载JS代码Java。

//文字名称：JavaScript

！DOCTYPE html

Html

头(电影)

meta charset=' utf-8 '

TitleCarson_Ho/title

//JS代码

脚本(脚本)

//要调用Android的方法

Function callJS(){

Alert('Android调用JS的callJS方法')；

}

/脚本

/head

/html

1234567891011213141516171819步骤2:通过Android上的WebView设置调用JS代码

Android代码：主AC

主席已经很明确了

public class main activity extends appcompatactivity {

WebView mWebView

布顿布顿；

@Override

Protected void oncreate(捆绑包savedinstancestate) {

(savedInstanceState)；

SetContentView)；

MWebView=(WebView)findViewById)；

web settings web settings=mweb view . get settings()；

设置与//Js交互的权限

韦伯斯特(true)；

//设置允许JS弹匣

韦伯斯特(true)；

//首先加载JS代码

//格式为：文件：///Android _ asset/文件名。定义为html

mweb view . loadurl(' file :///Android _ asset/Java ')；

Button=(Button)findViewById)；

Bu(新视图)。OnClickListener() {

@Override

Public void onClick(View v) {

通过//Handler发送消息

MWebView.post(new Runnable() {

@Override

Public void run() {

//调用的JS方法名称必须对应。

//调用JavaScript的callJS()方法

mweb view . loadurl(' JavaScript : call js()')；

}

})；

}

})；

//弹出式检查调用结果已设置，因此必须支持js对话框

//webview只是载体，内容渲染必须使用webviewChromClient类执行

//设置WebChromeClient对象以处理JavaScript的对话框

//为响应js设置Alert()函数

mweb view . setwebchromeclient(new webchromeclient(){

@Override

Public boolean onjsalert (webview、string URL、string message、final js result result) {

Aler b=new Aler)；

b . settitle(' Alert ')；

b . set message(message)；

B.setpositivebutton、new dialogin () {

@Override

public void onclick(dialog interface dialog，intwhich) {

re()；

}

})；

b . set cancelable(false)；

B.create()。show()；

Return true

}

})；

}

}

12345678910112131415161718192022324252627282930313233343536373839404142434444546474849505152535556575859606162636465666766

特别是，JS代码调用只能在onPageFinished()回调后调用。否则，将不会调用。

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

方式2：通过WebView的evaluateJavascript（）

• 优点：该方法比第一种方法效率更高、使用更简洁。
• 因为该方法的执行不会使页面刷新，而第一种方法（loadUrl ）的执行则会。
• Android 4.4 后才可使用
• 具体使用

// 只需要将第一种方法的loadUrl()换成下面该方法即可

mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() {

@Override

public void onReceiveValue(String value) {

//此处为 js 返回的结果

}

});

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

2.1.2 方法对比

2.1.3 使用建议

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

// Android版本变量

final int version = Build.VERSION.SDK_INT;

// 因为该方法在 Android 4.4 版本才可使用，所以使用时需进行版本判断

if (version < 18) {

mWebView.loadUrl("javascript:callJS()");

} else {

mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() {

@Override

public void onReceiveValue(String value) {

//此处为 js 返回的结果

}

});

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13

2.2 JS通过WebView调用 Android 代码

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

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

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

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

2.2.1 方法分析

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

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

Android（注释已经非常清楚）

// 继承自Object类

public class AndroidtoJs extends Object {

// 定义JS需要调用的方法

// 被JS调用的方法必须加入@JavascriptInterface注解

@JavascriptInterface

public void hello(String msg) {

Sy("JS调用了Android的hello方法");

}

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

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

需要加载JS代码：java

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<title>Carson</title>

<script>

function callAndroid(){

// 由于对象映射，所以调用test对象等于调用Android映射的对象

("js调用了android中的hello方法");

}

</script>

</head>

<body>

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

<button type="button" id="button1" onclick="callAndroid()"></button>

</body>

</html>

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19

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

详细请看注释

public class MainActivity extends AppCompatActivity {

WebView mWebView;

@Override

protected void onCreate(Bundle savedInstanceState) {

(savedInstanceState);

setContentView);

mWebView = (WebView) findViewById);

WebSettings webSettings = mWebView.getSettings();

// 设置与Js交互的权限

webSe(true);

// 通过addJavascriptInterface()将Java对象映射到JS对象

//参数1：Javascript对象名

//参数2：Java对象名

mWebView.addJavascriptInterface(new AndroidtoJs(), "test");//AndroidtoJS类对象映射到js的test对象

// 加载JS代码

// 格式规定为:file:///android_asset/文件名.html

mWebView.loadUrl("file:///android_asset/java");

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24

特点

• 优点：使用简单

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

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

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

• 具体原理：

1. Android通过 WebViewClient 的回调方法shouldOverrideUrlLoading ()拦截 url
2. 解析该 url 的协议
3. 如果检测到是预先约定好的协议，就调用相应方法

即JS需要调用Android的方法

• 具体使用：
• 步骤1：在JS约定所需要的Url协议
• JS代码：java

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

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<title>Carson_Ho</title>

<script>

function callAndroid(){

/*约定的url协议为：js://webview?arg1=111&arg2=222*/

document.location = "js://webview?arg1=111&arg2=222";

}

</script>

</head>

<!-- 点击按钮则调用callAndroid（）方法 -->

<body>

<button type="button" id="button1" onclick="callAndroid()">点击调用Android代码</button>

</body>

</html>

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20

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

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

MainAc

public class MainActivity extends AppCompatActivity {

WebView mWebView;

// Button button;

@Override

protected void onCreate(Bundle savedInstanceState) {

(savedInstanceState);

setContentView);

mWebView = (WebView) findViewById);

WebSettings webSettings = mWebView.getSettings();

// 设置与Js交互的权限

webSe(true);

// 设置允许JS弹窗

webSe(true);

// 步骤1：加载JS代码

// 格式规定为:file:///android_asset/文件名.html

mWebView.loadUrl("file:///android_asset/java");

// 复写WebViewClient类的shouldOverrideUrlLoading方法

mWebView.setWebViewClient(new WebViewClient() {

@Override

public boolean shouldOverrideUrlLoading(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 ().equals("webview")) {

// 步骤3：

// 执行JS所需要调用的逻辑

Sy("js调用了Android的方法");

// 可以在协议上带有参数并传递到Android上

HashMap<String, String> params = new HashMap<>();

Set<String> collection = uri.getQueryParameterNames();

}

return true;

}

return (view, url);

}

}

);

}

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51
• 52
• 53
• 54
• 55
• 56
• 57
• 58
• 59
• 60

特点

• 优点：不存在方式1的漏洞；
• 缺点：JS获取Android方法的返回值复杂。

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

// Android：MainAc

mWebView.loadUrl("javascript:returnResult(" + result + ")");

// JS：java

function returnResult(result){

alert("result is" + result);

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7

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

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

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

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

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

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

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

java

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

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<title>Carson_Ho</title>

<script>

function clickprompt(){

// 调用prompt（）

var result=prompt("js://demo?arg1=111&arg2=222");

alert("demo " + result);

}

</script>

</head>

<!-- 点击按钮则调用clickprompt() -->

<body>

<button type="button" id="button1" onclick="clickprompt()">点击调用Android代码</button>

</body>

</html>

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22

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

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

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

public class MainActivity extends AppCompatActivity {

WebView mWebView;

// Button button;

@Override

protected void onCreate(Bundle savedInstanceState) {

(savedInstanceState);

setContentView);

mWebView = (WebView) findViewById);

WebSettings webSettings = mWebView.getSettings();

// 设置与Js交互的权限

webSe(true);

// 设置允许JS弹窗

webSe(true);

// 先加载JS代码

// 格式规定为:file:///android_asset/文件名.html

mWebView.loadUrl("file:///android_asset/java");

mWebView.setWebChromeClient(new WebChromeClient() {

// 拦截输入框(原理同方式2)

// 参数message:代表promt（）的内容（不是url）

// 参数result:代表输入框的返回值

@Override

public boolean onJsPrompt(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 ().equals("webview")) {

//

// 执行JS所需要调用的逻辑

Sy("js调用了Android的方法");

// 可以在协议上带有参数并传递到Android上

HashMap<String, String> params = new HashMap<>();

Set<String> collection = uri.getQueryParameterNames();

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

re("js调用了Android的方法成功啦");

}

return true;

}

return (view, url, message, defaultValue, result);

}

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

// 拦截JS的警告框

@Override

public boolean onJsAlert(WebView view, String url, String message, JsResult result) {

return (view, url, message, result);

}

// 拦截JS的确认框

@Override

public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {

return (view, url, message, result);

}

}

);

}

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51
• 52
• 53
• 54
• 55
• 56
• 57
• 58
• 59
• 60
• 61
• 62
• 63
• 64
• 65
• 66
• 67
• 68
• 69
• 70
• 71
• 72
• 73
• 74
• 75
• 76
• 77
• 78

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

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

---

3. 总结

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

• 关于WebView的系列文章对你有所帮助
• Android开发：最全面、最易懂的Webview详解
• Android：你不知道的 WebView 使用漏洞
• 手把手教你构建 Android WebView 的缓存机制 & 资源预加载方案
• 接下来我会继续讲解其他安卓开发的知识，有兴趣可以继续关注Carson_Ho的安卓开发笔记！！！！

---

请评论点赞！因为你们的赞同/鼓励是我写作的最大动力！