【Android】Webview与JavaScript交互介绍

其他 2020-09-22 10:17:04 阅读次数: 0

一、交互方式总结

Android 与 JS 通过 WebView 互相调用方法实现，实际上是：
-Android 去调用 JS 的代码
-JS 去调用 Android 的代码
二者沟通的桥梁是 WebView

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

  1. 通过WebView的loadUrl（）
  2. 通过WebView的evaluateJavascript（）

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

二、具体分析

2.1 Android 通过 WebView 调用 JS 代码

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

1.为了方便展示，本文是采用 Andorid 调用本地 JS 代码说明；
2.实际情况时，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.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);

        // 先载入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) {
    
    
                // 通过Handler发送消息
                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;
            }

        });

    }
}

执行效果，点击按钮 弹出对话框提示“Android调用了JS的callJS方法”

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

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

方式 2：通过WebView的evaluateJavascript（）
优点：该方法比第一种方法效率更高、使用更简洁。

  1. 因为该方法的执行不会使页面刷新，而第一种方法（loadUrl ）的执行则会。
  2. Android 4.4 后才可使用

具体使用

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

使用建议
两种方法混合使用，即 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（）消息

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");

执行结果：打印出log“JS调用了Android的hello方法”

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

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

即 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);
                                      }
                                  }
        );
   }
}

执行结果：打印出log“JS调用了Android的方法”

特点
优点：不存在方式 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 中，有三个常用的对话框方法：

执行结果：打印出log“JS调用了Android的方法”

方式 3 的原理：Android 通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调分别拦截 JS 对话框 （即上述三个方法），得到他们的消息内容，然后解析即可。

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

  1. 常用的拦截是：拦截 JS 的输入框（即prompt（）方法）
  2. 因为只有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（），具体如下：

  1. 如果是拦截警告框（即alert()），则触发回调onJsAlert（）；
  2. 如果是拦截确认框（即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);
                                        }
                                    }
     }
}

执行结果：打印出log“JS调用了Android的方法”

猜你喜欢

转载自blog.csdn.net/sinat_36955332/article/details/108586893
今日推荐
《美国对全球网络空间安全与发展的威胁和破坏》报告发布
火速冲上 GitHub 热榜 —— 开源编程语言、框架哪有这么可爱？
北京人形机器人创新中心发布全球首个纯电驱拟人奔跑的全尺寸人形机器人“天工”
LFOSSA 源来如此公开课 | 掌握云原生未来：CNCF 认证全面攻略与备考秘籍
周排行
循环神经网络（rnn）讲解
Tigao教程四：单独的关节运动
金蝶K3WISE15.0-注册套打教程
如何在Mac上配置Kubernetes
Android应用结束自身进程的方法
SpringMVC学习 十三 拦截器栈
中国驻洛杉矶总领馆举行新春招待会
HttpClient get post 发送
11 - three.js 笔记 - 绘制三维字体模型
Mysql递归获取某个父节点下面的所有子节点和子节点上的所有父节点
每日归档
更多
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)
2024-04-28(0)
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)
2024-04-24(36)
2024-04-23(26)
2024-04-22(39)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022