`
ch_kexin
  • 浏览: 899034 次
  • 性别: Icon_minigender_2
  • 来自: 青岛
社区版块
存档分类
最新评论

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

 
阅读更多

前言

  • 现在很多App里都内置了Web网页（Hyprid App），比如说很多电商平台，淘宝、京东、聚划算等等，如下图

京东首页

  • 上述功能是由Android的WebView实现的，其中涉及到Android客户端与Web网页交互的实现
  • 今天我将全面介绍Android通过WebView与JS交互的全面方式

 

阅读本文前请先阅读：http://ch-kexin.iteye.com/admin/blogs/2396873

目录

目录

1. 交互方式总结

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. 具体分析

2.1 Android通过WebView调用 JS 代码

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

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

方式1：通过WebView的loadUrl（）

  • 实例介绍：点击Android按钮，即调用WebView JS（文本名为javascript）中callJS（）
  • 具体使用：

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

为了方便展示，本文是采用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.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) {
                // 必须另开线程进行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（） 回调之后才能调用，否则不会调用。

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

方式2：通过WebView的evaluateJavascript（）

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

因为该方法的执行不会使页面刷新，而第一种方法（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（） 消息

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

 效果图

 

 

特点

方式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);
                                      }
                                  }
        );
   }
        }

 效果图

特点

  • 优点：不存在方式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（）方法）说明 ：

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


            }

        }

 效果图

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

方式的对比 & 使用场景

3. 总结

分享到：
| Android：最全面的 Webview 详解
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    android webview与js交互简单demo

    通过以上知识点的介绍，你应该对Android WebView与JavaScript交互有了基本的理解。在实际开发中，你可以根据需求扩展这些功能，实现更复杂的交互逻辑，比如上传文件、接收推送消息等。记住，安全性和性能优化始终是...

    android中webview与js交互

    这个例子将深入探讨如何在Android应用中实现WebView与JS的交互，以便于创建更加丰富的用户体验。 首先，让我们了解WebView的基本用法。在Android布局文件（如activity_main.xml）中，我们可以添加一个WebView组件：...

    android不使用webview与js交互

    不使用Webview与JavaScript交互时，我们需要权衡性能、复杂性和功能需求。在选择方案时，应根据实际项目的需求，如执行效率、数据安全性、网络依赖等因素进行评估。对于某些简单场景，如计算或轻量级的数据转换，...

    webview与js交互demo

    在Android开发中，WebView是一个非常重要的组件，它允许开发者在应用程序中嵌入网页内容，并且可以实现JavaScript与原生代码的交互。这个“webview与js交互demo”就是专门为了展示这种交互机制的一个实例。在该示例...

    Android-x5webview和js交互的三方库

    在许多App中，我们常常需要在原生Android代码和网页内容之间进行交互，这时候就需要利用到X5Webview与JS的交互能力。 X5Bridge是腾讯专门为X5Webview设计的一个三方库，它提供了一种高效、便捷的方式来实现Android ...

    Android WebView与JavaScript交互实现Web App

    在Android开发中，WebView是一个非常重要的组件，它允许我们在应用程序中内嵌网页内容，并与网页进行交互。这个组件使得开发者可以结合原生Android应用的功能和Web应用的灵活性，实现混合式应用开发。在这个主题中，...

    Android笔记webview与js交互

    在Android开发中，WebView是一个非常...通过以上这些方法，Android开发者可以实现WebView与JavaScript的深度交互，从而构建功能丰富的混合式应用。在实际项目中，根据需求可以选择不同的交互方式，灵活运用这些技术。

    android中Webview与javascript的交互（互相调用）

    总之，Android中的WebView与JavaScript的交互是通过暴露Java对象和调用JavaScript函数实现的，这种方式极大地丰富了Android应用的功能。在实际开发中，我们需要合理利用这一特性，同时注意安全性和性能优化。

    Android webview与js交互

    本节我们将深入探讨Android WebView与JavaScript之间的交互机制，以及如何实现两者之间的通信。 一、WebView基本使用 在Android中，首先需要在布局文件中添加WebView组件，并在Java代码中初始化和加载网页： ```...

    Android高级应用源码-Android webView和js交互的Demo.rar

    当我们将WebView与JavaScript结合起来，就能实现Android应用与网页之间的交互，从而创造出更强大的功能。这份"Android高级应用源码-Android webView和js交互的Demo"就为我们展示了如何实现这种交互。 首先，我们...

    android4.4 WebView与js交互

    在Android开发中，WebView是一个非常重要的组件，它允许我们在应用程序中内嵌网页内容，并实现与JavaScript的交互。在Android 4.4（KitKat）版本中，WebView提供了更加强大的功能，使得Java与JavaScript之间的通信...

    Android中WebView与js交互简单Demo

    当需要在Android应用中嵌入复杂的网页功能或者实现Android与网页内容的交互时，我们就需要用到WebView与js的交互。本文将详细介绍如何在Android的WebView中实现js与原生代码的相互调用。 首先，我们来看`Android中...

    Android中webview使用js与java交互

    在Android开发中，WebView是一个非常重要的组件，它允许我们在应用程序中内嵌网页内容，并且能够实现JavaScript与Java代码之间的交互，极大地丰富了应用的功能。本文将深入探讨如何在Android的WebView中利用...

    WebView与Js交互Demo

    总的来说，Android的WebView与JavaScript交互是通过`WebView.loadUrl()`、`addJavascriptInterface()`、`setWebChromeClient()`等方法实现的。这种交互方式使得开发者能够充分利用JavaScript的便利性同时结合Android...

    Android 和 javascript 交互 Android混合开发之WebView与Javascript交互

    要实现Android与javascript的交互，首先需要创建一个`JavaScriptInterface`。这个接口允许你在Java代码中定义方法，并在网页中的JavaScript调用。例如： ```java @JavascriptInterface public class ...

    Android app 与网页交互 WebView 与JS交互

    Android app 与网页交互 WebView 与JS交互 demo把人脸检测中人眼坐标传递到网页上显示出来,第一个想到的事webview, 但书上支持说用GET POST,并不能实现这种效果,请教罗享同志后百度webview与JS交互就有了.

    android webview js交互， 响应webview中的图片点击事件

    而JavaScript交互则是WebView功能的一部分，使得我们能够实现Android应用与网页之间的通信，从而增强用户体验。本篇文章将深入探讨如何实现“android webview js交互，响应webview中的图片点击事件”，特别是点击...

    Andorid webview和js的交互

    在Android应用开发中，WebView是一个强大的组件，它允许开发者在应用程序内部嵌入网页内容，同时提供了与JavaScript交互的能力。这使得我们能够利用HTML、CSS和JavaScript的灵活性来构建部分或全部用户界面，同时还...

    Android WebView与JavaScript交互

    本文将深入探讨Android WebView与JavaScript的交互机制，以及如何在实际开发中有效地运用这一特性。 首先，我们需要理解WebView的基本用法。在Android布局XML文件中，可以通过添加`&lt;WebView&gt;`标签创建一个WebView...

    androidWebView-Javascript与android交互框架

    因为开发中经常用到android和WebView混合交互开发来降低开发时间。 所以加了一点类java反射机制工具小框架来方便交互 反射这个类lxz.utils.android.webview.plugins.ToastScript 地址：...

Magicbox
Global site tag (gtag.js) - Google Analytics