Android&Js相关

- - 前言
  - 一、Android调用Js代码
    - 1,通过WebView的loadUrl()
    - 2. 通过WebView的evaluateJavascript()
  - 二、Js调用Android代码
    - 1. 通过WebView的addJavascriptInterface()进行对象映射
    - 2. 通过WebViewClient的shouldOverrideUrlLoading()方法回调拦截 url
    - 3. 通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt()方法回调拦截JS对话框alert()、confirm()、prompt()消息

前言

Android和Js交互可以分为两种
1. Android调用Js代码
2. Js调用Android代码
两者用WebView作为交互的”桥梁”

一、Android调用Js代码

无论通过哪种方式,首先都需要调用
webSettings.setJavaScriptEnabled(true);
这样才能够加载js代码

1,通过WebView的loadUrl()

可以总结为两种类型
1. 网页中已写好JavaScript function
这种情况可以直接通过webView.loadUrl(“javascript:xxxx()”);来加载
(xxxx为function名称)
2. 网页中无JavaScript function
可以执行例如webView.loadUrl(“javascript:document.getElementByClassName(“logo”).style.display=’none’;void(0);”);

2. 通过WebView的evaluateJavascript()

    webView.evaluateJavascript（"javascript:xxxx()", new ValueCallback() {        @Override        public void onReceiveValue(String value) {            //此处为 js 返回的结果        }    });

其实基本实现代码和loadUrl差不多

需要注意的有:
1,loadUrl执行效率低,获取返回值麻烦,且会重复刷新页面,但是它向下兼容性好,4.4版本下只能使用loadUrl来执行js
2,evaluateJavascript执行效率高,获取返回值简单,且不会重复刷新页面,但是只在4.4版本以上支持
3,网页加载属于异步操作,建议在onPageFinished()回调之后再进行操作,否则可能还未加载完网页就调用js代码,这时会没有效果
4,对于target版本4.4以上(19)的版本,使用loadUrl动态加载过长的js代码可能会有问题,例如无效果,但是使用evaluateJavascript或者降低target版本则可以正常加载

二、Js调用Android代码

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

1. 通过WebView的addJavascriptInterface()进行对象映射

首先需要一个用于和js映射的类

// 继承自Object类public class AndroidtoJs extends Object {    // 定义JS可以调用的方法    // 4.2以上，被JS调用的方法必须加入@JavascriptInterface注解    // 用以规避安全漏洞    @JavascriptInterface    public void hello(String msg) {        System.out.println("JS调用了Android的hello方法");    }}

然后是在android中执行代码，将该类作为一个对象映射到js

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

最后是在js中调用该对象的对应方法

    <script>        function callAndroid(){        // 由于对象映射，所以调用test对象等于调用Android映射的对象            xxxx.hello("js调用了android中的hello方法");        }    script>

当js中的callAndroid()方法被调用后,就会调用映射到js的xxxx对象的hello方法,即js调用android代码

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

其实这个方法就是通过js让webView跳转到一个新的url,但是这个时候传入的可以是一个”标识”而并非真正的url,然后跳转的过程中会触发shouldOverrideUrlLoading()方法,android端通过重写该方法,对url进行判断(判断是否为自己需要拦截的url),执行相应的android方法,并且拦截下url,让它不进行网页跳转
具体方式如下:

    ......    <script>        function callAndroid(){            /*约定的url协议为：js://webview?arg1=111&arg2=222*/            document.location = "js://webview?arg1=111&arg2=222";        }    script>    <button type="button" id="button1" onclick="callAndroid()">点击调用Android代码button>    ......

首先可以看到,在html中,当点击了button后,会调用js的callAndroid方法,然后会给document.location进行赋值,这时开始进行网页跳转

    // 复写WebViewClient类的shouldOverrideUrlLoading方法    mWebView.setWebViewClient(new WebViewClient() {        @Override        public boolean shouldOverrideUrlLoading(WebView view, String url) {            // 根据协议的参数，判断是否是所需要的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")) {                    // 执行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);        }    });

然后在WebViewClient类的shouldOverrideUrlLoading方法中进行拦截并进行相应的处理
但是由于本身js和android并没有实质上的联系,所以如果js需要获取到android方法的返回值的话,只能是由android再次调用js方法,将值传入

3. 通过WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt()方法回调拦截JS对话框alert()、confirm()、prompt()消息

其实这种方式更像是第二种方式的变种,因为第二种方式在js端难以获取返回值,而使用这种方式会让值变得易于在js和android中传递

    ......    <script>        function clickprompt(){            // 调用prompt（）            var result=prompt("js://demo?arg1=111&arg2=222");            alert("demo " + result);        }    script>        <body>        <button type="button" id="button1" onclick="clickprompt()">点击调用Android代码button>    body>

按下按钮后调用clickprompt()方法,而他调用了prompt方法发起了弹出输入窗的请求,并且附带了一个参数message
然后在android中拦截他,判断message并做对应的操作

    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()、prompt()分别是警告框,确认框,输入框,分别是不带参,带boolean参,带任意形式参,所以一般prompt()更实用

最后以一张图片来总结

参考文献:
Android：你要的WebView与 JS 交互方式都在这里了

前言