Android WebView与JS页面相互调用之相互交互

时间  2020-12-20





1. 交互方式总结

Android与JS通过WebView互相调用方法，实际上是：

Android去调用JS的代码

JS去调用Android的代码


二者沟通的桥梁是WebView


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

通过WebView的loadUrl（）

通过WebView的evaluateJavascript（）:专门用于异步调用JavaScript方法，并且能够得到一个回调结果。


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

通过WebView的addJavascriptInterface（）进行对象映射
通过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url
通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（） 消息



2. 具体分析

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文件夹里

需要加载JS代码：javascript.html



<!DOCTYPE html>


<html>




<head>
    <meta charset="utf-8">
    <title>Carson_Ho</title>
    <script>
   function callJS(){
      alert("Android调用了JS的callJS方法");
   }


    </script>


</head>


</html>






步骤2：在Android里通过WebView设置调用JS代码


webView=findViewById(R.id.activity_webview_webview);


WebSettings webSettings = webView.getSettings();


// 设置与Js交互的权限


webSettings.setJavaScriptEnabled(true);


// 设置允许JS弹窗


webSettings.setJavaScriptCanOpenWindowsAutomatically(true);


// 先载入JS代码


webView.loadUrl("file:///android_asset/javascript.html");










/**
 * 由于设置了弹窗检验调用结果,所以需要支持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(WebViewActivity1.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;
    }


});




textView.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        loadUrlMethod();
    }
});




/**
 * Android调用Js代码 loadUrl方法
 * */




public void loadUrlMethod(){
    // 通过Handler发送消息
    webView.post(new Runnable() {
        @Override
        public void run() {
            webView.loadUrl("javascript:callJS()");
        }
    });
}

运行结果：



特别注意：JS代码调用一定要在 onPageFinished（） 回调之后才能调用，否则不会调用。onPageFinished()属于WebViewClient类的方法，主要在页面加载结束时调用



方式2：通过WebView的evaluateJavascript（）


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

1.因为该方法的执行不会使页面刷新，而第一种方法（loadUrl ）的执行则会。

2.Android 4.4 后才可使用


/**
 * Android调用Js代码 evaluateJavascript方法
 * */


@RequiresApi(api = Build.VERSION_CODES.KITKAT)
public void evaluateJavascriptMethod(){
    webView.evaluateJavascript("javascript:callJS()", new ValueCallback<String>() {
        @Override
        public void onReceiveValue(String value) {
            //此处为 js 返回的结果
            Toast.makeText(WebViewActivity1.this,value,Toast.LENGTH_SHORT).show();
        }
    });
}


运行结果：




2.1.2 方法对比



2.1.3 使用建议

两种方法混合使用，即Android 4.4以下使用方法1，Android 4.4以上方法2




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（）进行对象映射(从Android4.2开始。 只有添加 @JavascriptInterface 声明的Java方法才可以被JavaScript调用)


步骤1：定义一个与JS对象映射关系的Android类：AndroidtoJs

public class AndroidtoJs extends Object {


    private Context context;
    public AndroidtoJs(Context context){
        this.context=context;
    }


    /**
     * 定义JS需要调用的方法
     * 被JS调用的方法必须加入@JavascriptInterface注解
     * */


    @JavascriptInterface
    public void hello(String msg) {
        Toast.makeText(context,msg,Toast.LENGTH_LONG).show();

    }


}



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

需要加载JS代码：javascript.html

<!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()"></button>
</body>

</html>


步骤3：在Android里通过WebView设置Android类与JS代码的映射

webView=findViewById(R.id.activity_webview_webview);


WebSettings webSettings = webView.getSettings();


// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);


// 通过addJavascriptInterface()将Java对象映射到JS对象
//参数1：Javascript对象名
//参数2：Java对象名
webView.addJavascriptInterface(new AndroidtoJs(WebViewActivity1.this), "test");//AndroidtoJS类对象映射到js的test对象


// 加载JS代码

webView.loadUrl("file:///android_asset/javascript.html");


运行结果：





特点

优点：使用简单

仅将Android对象和JS对象映射即可

缺点：存在严重的漏洞问题




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

具体原理：

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


具体使用：
步骤1：在JS约定所需要的Url协议

JS代码：javascript.html


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

webView=findViewById(R.id.activity_webview_webview);


        WebSettings webSettings = webView.getSettings();


        // 设置与Js交互的权限
        webSettings.setJavaScriptEnabled(true);
        // 设置允许JS弹窗
        webSettings.setJavaScriptCanOpenWindowsAutomatically(true);


        // 步骤1：加载JS代码
        webView.loadUrl("file:///android_asset/javascript.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所需要调用的逻辑
                        Toast.makeText(WebViewActivity1.this,"js调用了Android的方法@@@@&&&&!!!",Toast.LENGTH_LONG).show();
                        // 可以在协议上带有参数并传递到Android上
                        Set<String> collection = uri.getQueryParameterNames();
                        Iterator<String> iterable=collection.iterator();
                        String value="";
                        while(iterable.hasNext()){
                            value=value+iterable.next()+";";
                        }
                        Toast.makeText(WebViewActivity1.this,value,Toast.LENGTH_LONG).show();
                    }
                    return true;
                }
                return super.shouldOverrideUrlLoading(view, url);
            }
        });


补充：shouldOverrideUrlLoading：所有以www.example.com开头的url调用系统浏览器打开 其他的url在当前webview打开


webView.setWebViewClient(new WebViewClient(){
            
@Override
            
public boolean shouldOverrideUrlLoading(WebView view, String url) {
                
if(url.indexOf("http://www.example.com") != -1){// 调用系统默认浏览器处理url
                    
view.stopLoading();
                    
startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url)));
                    
return true;
                
}else{//WebView自己处理
                    
view.loadUrl(url);
                    
return false;
                
}
            
}
          
});


运行结果：



特点

优点：不存在方式1的漏洞；

缺点：JS获取Android方法的返回值复杂。



方式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


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

webView=findViewById(R.id.activity_webview_webview);


        WebSettings webSettings = webView.getSettings();


        // 设置与Js交互的权限
        webSettings.setJavaScriptEnabled(true);
        // 设置允许JS弹窗
        webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
        // 先加载JS代码
        webView.loadUrl("file:///android_asset/javascript.html");


        webView.setWebChromeClient(new WebChromeClient(){
            @Override
            public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
                result.confirm("js调用了Android的方法成功啦");
                return super.onJsPrompt(view, url, message, defaultValue, result);
            }

        });


运行结果：




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



3. 总结


本文主要对Android通过WebView与JS的交互方式进行了全面介绍

联系我们 沪ICP备13005482号-10