相关文章阅读:
Github下载地址:Android WebView与JS互调
# 一、交互方式总结 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.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文件夹里
1、为了方便展示,本文是采用Andorid调用本地JS代码说明;
2、实际情况时,Android更多的是调用远程JS代码,即将加载的JS代码路径改成url即可
需要加载JS代码:androidcalljs.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Java调用JS方法</title>
<!-- JS代码 -->
<script>
<!-- Android需要调用的方法 -->
function callJS(){
alert("Android调用了JS的callJS方法");
}
</script>
</head>
</html>
步骤2:在Android里通过WebView设置调用JS代码
Android代码:AndroidCallJS1.java
package com.davis.webviewjs.demo;
import android.content.DialogInterface;
import android.os.Bundle;
import android.support.v7.app.AlertDialog;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.webkit.JsResult;
import android.webkit.WebChromeClient;
import android.webkit.WebSettings;
import android.webkit.WebView;
import android.widget.Button;
public class AndroidCallJS1 extends AppCompatActivity {
private Button btn;
private WebView webview;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_webview);
init();
}
private void init(){
btn = (Button)findViewById(R.id.btn);
webview = (WebView)findViewById(R.id.webview);
WebSettings webSettings = webview.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先载入JS代码
// 格式规定为:file:///android_asset/文件名.html
webview.loadUrl("file:///android_asset/androidcalljs.html");
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
webview.post(new Runnable() {
@Override
public void run() {
// 注意调用的JS方法名要对应上
// 调用javascript的callJS()方法
webview.loadUrl("javascript:callJS()");
}
});
}
});
// 由于设置了弹窗检验调用结果,所以需要支持js对话框
// webview只是载体,内容的渲染需要使用webviewChromClient类去实现
// 通过设置WebChromeClient对象处理JavaScript的对话框
//设置响应js 的Alert()函数
webview.setWebChromeClient(new WebChromeClient() {
@Override
public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
AlertDialog.Builder b = new AlertDialog.Builder(AndroidCallJS1.this);
b.setTitle("Alert");
b.setMessage(message);
b.setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
result.confirm();
}
});
b.setCancelable(false);
b.create().show();
return true;
}
});
}
}
特别注意:JS代码调用一定要在 onPageFinished()
回调之后才能调用,否则不会调用。
onPageFinished()
属于WebViewClient
类的方法,主要在页面加载结束时调用
方式2:通过WebView的evaluateJavascript()
- 优点:
该方法比第一种方法效率更高、使用更简洁
。
1、因为该方法的执行不会使页面刷新,而第一种方法(loadUrl )的执行则会。
2、Android 4.4 后才可使用
- 具体使用
// 只需要将第一种方法的loadUrl()换成下面该方法即可
webview.evaluateJavascript("javascript:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此处为 js 返回的结果
Log.i("WEBVIEW_JS", "value : " + value);
}
});
方法对比
调用方式 | 优点 | 缺点 | 使用场景 |
---|---|---|---|
使用loadUrl() | 方便简洁 | 效率低; 获取返回值麻烦; | 不需要获取返回值,对性能要求较低时 |
使用evaluateJavascript() | 效率高 | 向下兼容性差(仅Android 4.4以上可用) | Android 4.4以上 |
使用建议
两种方法混合使用,即Android 4.4以下使用方法1,Android 4.4以上方法2
// Android版本变量
final int version = Build.VERSION.SDK_INT;
// 因为该方法在 Android 4.4 版本才可使用,所以使用时需进行版本判断
if (version < 18) {
webview.loadUrl("javascript:callJS()");
} else {
webview.evaluateJavascript("javascript:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(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类
public class AndroidtoJs extends Object {
// 定义JS需要调用的方法
// 被JS调用的方法必须加入@JavascriptInterface注解
@JavascriptInterface
public void hello(String msg) {
System.out.println("JS调用了Android的hello方法");
}
}
步骤2:将需要调用的JS代码以.html格式放到src/main/assets文件夹里
需要加载JS代码:jscallandroid.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>JS调用Java方法</title>
<script>
function callAndroid(){
<!-- 由于对象映射,所以调用test对象等于调用Android映射的对象 -->
test.hello("js调用了android中的hello方法");
}
</script>
</head>
<body>
<!-- 点击按钮则调用callAndroid函数 -->
<button type="button" id="button1" onclick="callAndroid()"></button>
</body>
</html>
步骤3:在Android里通过WebView设置Android类与JS代码的映射
package com.davis.webviewjs.demo;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.webkit.WebSettings;
import android.webkit.WebView;
import android.widget.Button;
public class JSCallAndroid1 extends AppCompatActivity {
private Button btn;
private WebView webview;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_webview);
init();
}
private void init() {
btn = (Button)findViewById(R.id.btn);
btn.setVisibility(View.GONE);
webview = (WebView)findViewById(R.id.webview);
WebSettings webSettings = webview.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 通过addJavascriptInterface()将Java对象映射到JS对象
//参数1:Javascript对象名
//参数2:Java对象名
webview.addJavascriptInterface(new AndroidtoJs(), "test");//AndroidtoJS类对象映射到js的test对象
// 先载入JS代码
// 格式规定为:file:///android_asset/文件名.html
webview.loadUrl("file:///android_asset/jscallandroid.html");
}
}
特点
- 优点:使用简单
仅将Android对象和JS对象映射即可
- 缺点:存在严重的漏洞问题
方式2:通过 WebViewClient 的方法shouldOverrideUrlLoading ()回调拦截 url
具体原理:
-
Android通过 WebViewClient 的回调方法shouldOverrideUrlLoading ()拦截 url
-
解析该 url 的协议
-
如果检测到是预先约定好的协议,就调用相应方法
即JS需要调用Android的方法
具体使用:
步骤1:在JS约定所需要的Url协议
JS代码:jscallandroid2.html
以.html格式放到src/main/assets文件夹里
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Java调用JS方法</title>
<!-- JS代码 -->
<script>
function callAndroid(){
<!-- 约定的url协议为:js://webview?arg1=111&arg2=222 -->
document.location = "js://webview?arg1=111&arg2=222";
}
</script>
</head>
<body>
<!-- 点击按钮则调用callAndroid函数 -->
<button type="button" id="button1" onclick="callAndroid()">JS调用Android方法</button>
</body>
</html>
当该JS通过Android的webview.loadUrl("file:///android_asset/jscallandroid2.html")
加载后,就会回调shouldOverrideUrlLoading()
,接下来继续看步骤2:
步骤2:在Android通过WebViewClient复写shouldOverrideUrlLoading()
JSCallAndroid2.java
package com.davis.webviewjs.demo;
import android.net.Uri;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.View;
import android.webkit.WebResourceRequest;
import android.webkit.WebSettings;
import android.webkit.WebView;
import android.webkit.WebViewClient;
import android.widget.Button;
import java.util.HashMap;
import java.util.Set;
public class JSCallAndroid2 extends AppCompatActivity {
private Button btn;
private WebView webview;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_webview);
init();
}
private void init() {
btn = (Button)findViewById(R.id.btn);
btn.setVisibility(View.GONE);
webview = (WebView)findViewById(R.id.webview);
WebSettings webSettings = webview.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先载入JS代码
// 格式规定为:file:///android_asset/文件名.html
webview.loadUrl("file:///android_asset/jscallandroid2.html");
webview.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 (uri.getAuthority().equals("webview")) {
// 步骤3:
// 执行JS所需要调用的逻辑
Log.i("WEBVIEW_JS","js调用了Android的方法");
// 可以在协议上带有参数并传递到Android上
HashMap<String, String> params = new HashMap<>();
Set<String> collection = uri.getQueryParameterNames();
Log.i("WEBVIEW_JS", "URI : " + uri);
}
return true;
}
return super.shouldOverrideUrlLoading(view, url);
}
});
}
}
特点
-
优点:不存在方式1的漏洞;
-
缺点:JS获取Android方法的返回值复杂。
如果JS想要得到Android方法的返回值,只能通过 WebView 的 loadUrl ()去执行 JS 方法把返回值传递回去,相关的代码如下:
// Android:MainActivity.java
webview.loadUrl("javascript:returnResult(" + result + ")");
// JS:javascript.html
function returnResult(result){
alert("result is" + result);
}
方式3:通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt()方法回调拦截JS对话框alert()、confirm()、prompt() 消息
在JS中,有三个常用的对话框方法:
方法 | 作用 | 返回值 | 备注 |
---|---|---|---|
alert() | 弹出警告框 | 没有 | 在文本加入\n可换行 |
confirm() | 弹出确认框 | 两个返回值 | - 返回布尔值; - 通过该值可判断点击时确认还是取消:true表示确认,false表示取消。 |
prompt() | 弹出输入框 | 任意设置返回值 | - 点击【确认】,返回输入框的的值; - 点击【取消】,返回null。 |
方式3的原理:Android通过 WebChromeClient
的onJsAlert()
、onJsConfirm()
、onJsPrompt()
方法回调分别拦截JS对话框
(即上述三个方法),得到他们的消息内容,然后解析即可。
下面的例子将用 拦截JS的输入框(即prompt()方法) 说明 :
1、常用的拦截是:拦截 JS的输入框(即prompt()方法)
2、因为只有prompt()可以返回任意类型的值,操作最全面方便、更加灵活;而alert()对话框没有返回值;confirm()对话框只能返回两种状态(确定 / 取消)两个值;
步骤1:加载JS代码,如下:
jscallandroid3.html
以.html格式放到src/main/assets文件夹里
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Java调用JS方法</title>
<!-- JS代码 -->
<script>
<!-- Android需要调用的方法 -->
function callJS(){
var result = prompt("js://webview?arg1=111&arg2=222");
alert("result : " + result);
}
</script>
</head>
<body>
<!-- 点击按钮则调用callAndroid函数 -->
<button type="button" id="button1" onclick="callJS()">JS调用Android方法</button>
</body>
</html>
当使用webview.loadUrl("file:///android_asset/jscallandroid3.html")
加载了上述JS代码后,就会触发回调onJsPrompt()
,具体如下:
1、如果是拦截警告框(即alert()),则触发回调onJsAlert();
2、如果是拦截确认框(即confirm()),则触发回调onJsConfirm();
步骤2:在Android通过WebChromeClient
复写onJsPrompt()
package com.davis.webviewjs.demo;
import android.net.Uri;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.View;
import android.view.ViewGroup;
import android.webkit.JsPromptResult;
import android.webkit.JsResult;
import android.webkit.WebChromeClient;
import android.webkit.WebSettings;
import android.webkit.WebView;
import android.widget.Button;
import android.widget.LinearLayout;
public class JSCallAndroid3 extends AppCompatActivity {
private Button btn;
private WebView webview;
private LinearLayout layout;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_webview);
init();
}
private void init() {
btn = (Button)findViewById(R.id.btn);
btn.setVisibility(View.GONE);
webview = (WebView)findViewById(R.id.webview);
WebSettings webSettings = webview.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先载入JS代码
// 格式规定为:file:///android_asset/文件名.html
webview.loadUrl("file:///android_asset/jscallandroid3.html");
webview.setWebChromeClient(new WebChromeClient(){
@Override
public boolean onJsAlert(WebView view, String url, String message, JsResult result) {
// 根据协议的参数,判断是否是所需要的url(原理同方式2)
// 一般根据scheme(协议格式) & authority(协议名)判断(前两个参数)
//假定传入进来的 url = "js://webview?arg1=111&arg2=222"(同时也是约定好的需要拦截的)
Log.i("WEBVIEW_JS", "message : " + message);
Uri uri = Uri.parse(message);
// 如果url的协议 = 预先约定的 js 协议
// 就解析往下解析参数
if ( uri.getScheme().equals("js")) {
// 如果 authority = 预先约定协议里的 webview,即代表都符合约定的协议
// 所以拦截url,下面JS开始调用Android需要的方法
if (uri.getAuthority().equals("webview")) {
//
Log.i("WEBVIEW_JS", "js调用了Android的方法");
// 拦截alert()之后必须调用result.confirm()方法,否则会出现白屏
result.confirm();
return true;
}
}
return super.onJsAlert(view, url, message, 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"(同时也是约定好的需要拦截的)
Log.i("WEBVIEW_JS", "message : " + message);
Uri uri = Uri.parse(message);
// 如果url的协议 = 预先约定的 js 协议
// 就解析往下解析参数
if ( uri.getScheme().equals("js")) {
// 如果 authority = 预先约定协议里的 webview,即代表都符合约定的协议
// 所以拦截url,下面JS开始调用Android需要的方法
if (uri.getAuthority().equals("webview")) {
//
Log.i("WEBVIEW_JS", "js调用了Android的方法");
// 拦截alert()之后必须调用result.confirm()方法,否则会出现白屏
result.confirm("js调用了Android的方法");
return true;
}
}
return super.onJsPrompt(view, url, message, defaultValue, result);
}
@Override
public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {
return super.onJsConfirm(view, url, message, result);
}
});
}
@Override
protected void onDestroy() {
if (webview != null) {
webview.loadDataWithBaseURL(null, "", "text/html", "utf-8", null);
webview.clearHistory();
((ViewGroup) webview.getParent()).removeView(webview);
webview.destroy();
webview = null;
}
super.onDestroy();
}
}
三种方式的对比 & 使用场景
调用方式 | 优点 | 缺点 | 使用场景 |
---|---|---|---|
通过addJavascriptInterface()进行添加对象映射 | 方便简洁 | Android 4.2以下存在漏洞问题 | Android 4.2以上相对简单的互调场景 |
通过WebVeiw的方法shouldOverrideUrlLoading()回调拦截url | 不存在漏洞问题 | - 使用复杂:需要进行协议的约束; - 从Native层往Web层传递值比较繁琐 | 不需要返回值情况下的互调场景 |
通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt()方法回调拦截JS对话框消息 | 不存在漏洞问题 | 使用复杂:需要进行协议的约束; | 能满足大多数情况下的互调场景 |