WebView与JS交互方式
1 Android
调用JS
方法
Android
调用JS
代码的方式有2
种:
- 通过
WebView
的loadUrl
方法 - 通过
WebView
的evaluateJavascript
方法
1.1 通过WebView
的loadUrl
方法
将需要调用的JS
代码以.html
格式放到src/main/assets
文件夹里,以下是javascript.html
的代码:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
<script>
function callJS(){
alert("Android调用了JS的callJS方法");
}
</script>
</head>
</html>
在Android
代码中通过WebView
设置调用JS
代码:
public class MainActivity extends AppCompatActivity {
private WebView webView;
private Button button;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
webView = findViewById(R.id.webView);
button = findViewById(R.id.button);
WebSettings webSettings = webView.getSettings();
// 设置与JS交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
webView.loadUrl("file:///android_asset/javascript.html");
button.setOnClickListener(v -> {
webView.post(() -> {
// 调用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, JsResult result) {
AlertDialog.Builder builder = new AlertDialog.Builder(MainActivity.this);
builder.setTitle("Alert");
builder.setMessage(message);
builder.setPositiveButton(android.R.string.ok, (dialog, which) -> result.confirm());
builder.setCancelable(false);
builder.create().show();
return true;
}
});
}
}
运行程序,点击按钮,如下所示:
需要注意的是,JS
代码调用一定要在 onPageFinished
方法回调之后才能调用,否则不会调用。onPageFinished()
属于WebViewClient
类的方法,主要在页面加载结束时调用。
1.2 通过WebView
的evaluateJavascript
方法
只需要将第一种方法的loadUrl
方法替换成evaluateJavascript
:
button.setOnClickListener(v -> {
webView.post(() -> {
// 调用javascript的callJS()方法
webView.evaluateJavascript("javascript:callJS()", value -> Log.e("CAH", value));
});
});
1.3 比较
两种方法可以混合使用,即Android 4.4
以下使用laodUrl
方法,Android 4.4
以上使用evaluateJavascript
方法:
button.setOnClickListener(v -> {
webView.post(() -> {
// 调用javascript的callJS()方法
final int version = Build.VERSION.SDK_INT;
if (version < 18) {
webView.loadUrl("javascript:callJS()");
} else {
webView.evaluateJavascript("javascript:callJS()", value -> Log.e("CAH", value));
}
});
});
2 JS
调用Android
方法
- 通过
WebView
的addJavascriptInterface
进行对象映射 - 通过
WebViewClient
的shouldOverrideUrlLoading
方法回调拦截url
- 通过
WebChromeClient
的onJsAlert()
、onJsConfirm()
、onJsPrompt()
方法回调拦截JS
对话框alert()
、confirm()
、prompt()
消息
2.1 通过WebView
的addJavascriptInterface
进行对象映射
步骤1
:定义一个与JS
对象映射关系的Android
类:AndroidtoJS
public class AndroidJS extends Object {
@JavascriptInterface
public void hello(String msg) {
System.out.println("JS调用了Android的hello方法");
}
}
步骤2
:将需要调用的JS
代码以.html
格式放到src/main/assets
文件夹里:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson</title>
<script>
function callAndroid(){
test.hello("js调用了android中的hello方法");
}
</script>
</head>
<body>
<button type="button" id="button1" onclick="callAndroid()">点击调用Android代码</button>
</body>
</html>
步骤3
:在Android
里通过WebView
设置Android
类与JS
代码的映射:
public class MainActivity extends AppCompatActivity {
private WebView webView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
webView = findViewById(R.id.webView);
WebSettings webSettings = webView.getSettings();
webSettings.setJavaScriptEnabled(true); // 设置与JS交互的权限
// 通过addJavascriptInterface()将Java对象映射到JS对象
// 参数1:Javascript对象名 参数2:Java对象名
// AndroidJS类对象映射到js的test对象
webView.addJavascriptInterface(new AndroidJS(), "test");
webView.loadUrl("file:///android_asset/javascript.html");
}
}
2.2 通过WebViewClient
的shouldOverrideUrlLoading
方法回调拦截url
具体原理:
-
Android
通过WebViewClient
的回调方法shouldOverrideUrlLoading ()
拦截 url - 解析该
url
的协议 - 如果检测到是预先约定好的协议,就调用相应方法
即JS
需要调用Android
的方法
步骤1
:在JS
约定所需要的url
协议:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
<script>
function callAndroid(){
document.location = "js://webview?arg1=111&arg2=222";
}
</script>
</head>
<body>
<button type="button" id="button" onclick="callAndroid()">点击调用Android代码</button>
</body>
</html>
当该JS
通过Android
的webView.loadUrl("file:///android_asset/javascript.html")
加载后,就会回调shouldOverrideUrlLoading()
。
步骤2
:在Android
通过WebViewClient
复写shouldOverrideUrlLoading()
public class MainActivity extends AppCompatActivity {
private WebView webView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
webView = findViewById(R.id.webView);
WebSettings webSettings = webView.getSettings();
webSettings.setJavaScriptEnabled(true); // 设置与JS交互的权限
webSettings.setJavaScriptCanOpenWindowsAutomatically(true); // 设置允许JS弹窗
// 步骤1:加载JS代码
webView.loadUrl("file:///android_asset/javascript.html");
webView.setWebViewClient(new WebViewClient() {
@Override
public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
// 步骤2:根据协议的参数,判断是否是所需的url
// 一般根据scheme(协议格式)和authority(协议名)判断前两个参数
// 假定传进来的 url="js://webview?arg1=111&arg2=222"
Uri uri = Uri.parse(request.getUrl().toString());
// 如果authority=预先约定协议里的webview,即代表符合约定的协议
// 所以拦截url,下面JS开始调用Android需要的方法
if (uri.getScheme().equals("js")) {
if (uri.getAuthority().equals("webview")) {
// 步骤3:执行JS所需要的逻辑
System.out.println("js调用了Android的方法");
// 可以在协议上带有参数并传递到Android上
HashMap<String, String> params = new HashMap<>();
Set<String> collection = uri.getQueryParameterNames();
}
return true;
}
return super.shouldOverrideUrlLoading(view, request);
}
});
}
}
如果JS
想要得到Android
方法的返回值,只能通WebView
的loadUrl
去执行JS
方法把返回值传递回去, 相关的代码如下:
// MainActivity.java
mWebView.loadUrl("javascript:returnResult(" + result + ")");
// javascript.html
function returnResult(result){
alert("result is" + result);
}
2.3 通过WebChromeClient
的onJsAlert()
、onJsConfirm()
、onJsPrompt()
方法回调拦截JS
对话框alert()
、confirm()
、prompt()
消息
在JS
中,有三个常用的对话框方法:
原理:Android
通过WebChromeClient
的onJsAlert()
、onJsConfirm()
、onJsPrompt()
方法回调分别拦截JS
对话框
(即上述三个方法),得到它们的消息内容,然后解析即可。
经常用的拦截是:拦截JS
的输入框(即prompt()
方法)。因为只有prompt()
可以返回任意类型的值,操作最全面方便、更加灵活;而alert()
对话框没有返回值;confirm()
对话框只能返回两种状态(确定 / 取消)两个值。
步骤1
:加载JS
代码,如下:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
<script>
function callAndroid(){
var result=prompt("org://professor?arg1=111&arg2=222");
alert("demo " + result);
}
</script>
</head>
<body>
<button type="button" id="button1" onclick="callAndroid()">CallAndroid</button>
</body>
</html>
当使用mWebView.loadUrl("file:///android_asset/javascript.html")
加载了上述JS
代码后,就会触发回调onJsPrompt()
,具体如下:
- 如果是拦截警告框(即
alert()
),则触发回调onJsAlert()
; - 如果是拦截确认框(即
confirm()
),则触发回调onJsConfirm()
;
步骤2
:在Android
通过WebChromeClient
复写onJsPrompt()
:
public class MainActivity extends AppCompatActivity {
private WebView webView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
webView = findViewById(R.id.webView);
WebSettings webSettings = webView.getSettings();
webSettings.setJavaScriptEnabled(true); // 设置与JS交互的权限
webSettings.setJavaScriptCanOpenWindowsAutomatically(true); // 设置允许JS弹窗
// 步骤1:加载JS代码
webView.loadUrl("file:///android_asset/javascript.html");
webView.setWebChromeClient(new WebChromeClient() {
// 拦截输入框
// 参数 message:代表promt()的内容(不是url)result:代表输入框的返回值
@Override
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
//通常根据scheme(协议格式) & authority(协议名)判断(前两个参数)
Uri uri = Uri.parse(url);
if (uri.getScheme().equals("org")) {
if (uri.getAuthority().equals("professor")) {
//参数result:表明消息框的返回值(输入值)
result.confirm("js调用了Android的方法成功啦");
}
return true;
}
return super.onJsPrompt(view, url, message, defaultValue, result);
}
// 拦截JS的警告框
@Override
public boolean onJsAlert(WebView view, String url, String message, JsResult result) {
return super.onJsAlert(view, url, message, result);
}
// 拦截JS的确认框
@Override
public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {
return super.onJsConfirm(view, url, message, result);
}
});
}
}
2.4 三种方式的对比以及使用场景
3 总结