安卓与JS的交互

时间 2019-12-17

标签交互栏目 Android 繁體版

原文原文链接

对于android调用JS代码的方法有2种：
1. 经过WebView的loadUrl（）
2. 经过WebView的evaluateJavascript（）javascript

对于JS调用Android代码的方法有3种：
1. 经过WebView的addJavascriptInterface（）进行对象映射
2. 经过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url
3. 经过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（）消息html

具体分析

2.1 Android经过WebView调用 JS 代码java

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

经过WebView的loadUrl（）
经过WebView的evaluateJavascript（）
方式1：经过WebView的loadUrl（）web

实例介绍：点击Android按钮，即调用WebView JS（文本名为javascript）中callJS（）
具体使用：
步骤1：将须要调用的JS代码以.html格式放到src/main/assets文件夹里ide

为了方便展现，本文是采用Andorid调用本地JS代码说明；
实际状况时，Android更多的是调用远程JS代码，即将加载的JS代码路径改为url便可
须要加载JS代码：JavaScript.html函数

// 文本名：javascript
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Carson_Ho</title> // JS代码 <script> // Android须要调用的方法 function callJS(){ alert("Android调用了JS的callJS方法"); } </script> </head> </html>

步骤2：在Android里经过WebView设置调用JS代码
Android代码：MainActivity.Javapost

注释已经很是清楚
 public class MainActivity extends AppCompatActivity { WebView mWebView; Button button; @Override protected void onCreate(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/文件名.html mWebView.loadUrl("file:///android_asset/javascript.html"); button = (Button) findViewById(R.id.button); button.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { // 必须另开线程进行JS方法调用(不然没法调用) mWebView.post(new Runnable() { @Override public void run() { // 注意调用的JS方法名要对应上 // 调用javascript的callJS()方法 mWebView.loadUrl("javascript:callJS()"); } }); } }); // 因为设置了弹窗检验调用结果,因此须要支持js对话框 // webview只是载体，内容的渲染须要使用webviewChromClient类去实现 // 经过设置WebChromeClient对象处理JavaScript的对话框 //设置响应js 的Alert()函数 mWebView.setWebChromeClient(new WebChromeClient() { @Override public boolean onJsAlert(WebView view, String url, String message, final JsResult result) { AlertDialog.Builder b = new AlertDialog.Builder(MainActivity.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（）回调以后才能调用，不然不会调用。ui

onPageFinished()属于WebViewClient类的方法，主要在页面加载结束时调用
方式2：经过WebView的evaluateJavascript（）this

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

由于该方法的执行不会使页面刷新，而第一种方法（loadUrl ）的执行则会。
Android 4.4 后才可以使用
具体使用

// 只须要将第一种方法的loadUrl()换成下面该方法便可 mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() { @Override public void onReceiveValue(String value) { //此处为 js 返回的结果 } }); }

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 返回的结果 } }); }

2.2 JS经过WebView调用 Android 代码
对于JS调用Android代码的方法有3种：
1. 经过WebView的addJavascriptInterface（）进行对象映射
2. 经过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url
3. 经过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（）消息
4. 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代码：javascript.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Carson</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代码的映射

详细请看注释
public class MainActivity extends AppCompatActivity { WebView mWebView; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); mWebView = (WebView) findViewById(R.id.webview); WebSettings webSettings = mWebView.getSettings(); // 设置与Js交互的权限 webSettings.setJavaScriptEnabled(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/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文件夹里

<!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>

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

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

MainActivity.java

 public class MainActivity extends AppCompatActivity { WebView mWebView; // Button button; @Override protected void onCreate(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/文件名.html mWebView.loadUrl("file:///android_asset/javascript.html"); // 复写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 (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, url); } } ); } }

特色

优势：不存在方式1的漏洞；
缺点：JS获取Android方法的返回值复杂。
若是JS想要获得Android方法的返回值，只能经过 WebView 的 loadUrl （）去执行 JS 方法把返回值传递回去，相关的代码以下：

// Android：MainActivity.java mWebView.loadUrl("javascript:returnResult(" + result + ")"); // JS：javascript.html function returnResult(result){ alert("result is" + result); }

方式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代码，以下：
javascript.html

以.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>

当使用mWebView.loadUrl(“file:///android_asset/javascript.html”)加载了上述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) { 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/文件名.html mWebView.loadUrl("file:///android_asset/javascript.html"); 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 (uri.getAuthority().equals("webview")) { // // 执行JS所须要调用的逻辑 System.out.println("js调用了Android的方法"); // 能够在协议上带有参数并传递到Android上 HashMap<String, String> params = new HashMap<>(); Set<String> 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) { 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.2.2 三种方式的对比 & 使用场景