Android WebView与 JS 的交互方式

2020-01-08 本文已影响0人 as_pixar

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

Android去调用JS的代码
JS去调用Android的代码

二者沟通的桥梁是WebView ，Android的Webview在低版本和高版本采用了不同的webkit版本内核，4.4后直接使用了Chrome。

JS调用Android

通过 WebView的addJavascriptInterface（）进行对象映射

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

import android.util.Log;
import android.webkit.JavascriptInterface;

public class HelloJs {

    // 定义JS需要调用的方法
    // 被JS调用的方法必须加入@JavascriptInterface注解
    // Google 在Android 4.2 版本中规定
    // 对被调用的函数以 @JavascriptInterface进行注解从而避免漏洞攻击
    @JavascriptInterface
    public void thank(String str) {
        Log.d("tag", "JS调用Android=" + str);
    }

}

2 将需要调用的hello.html放到src/main/assets文件夹里

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Carson</title>
    <script>
         function jsCallAndroid(){
            <!-- 由于对象映射，所以调用hello对象等于调用Android映射的对象 -->
            hello.thank("10");
         }
    </script>
</head>
<body>
<button type="button" onclick="jsCallAndroid()" >JS调用Android</button>
</body>
</html>

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

public class TestActivity extends BaseActivity {

    WebView mWebView;

    @Override
    protected int getLayoutId() {
        return R.layout.activity_test;
    }

    @Override
    protected void initData() {
        super.initData();
        mWebView = findViewById(R.id.webView);

        WebSettings webSettings = mWebView.getSettings();

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

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

        // 加载JS代码
        // 格式规定为:file:///android_asset/文件名.html
        mWebView.loadUrl("file:///android_asset/hello.html");

    }
}

运行结果  JS调用Android=10

Android 4.2版本之后

Google 在Android 4.2 版本中规定对被调用的函数以 @JavascriptInterface进行注解从而避免漏洞攻击，小于4.2版本的手机非常少了，我们忽略掉。

Android通过WebView调用 JS 代码

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

通过WebView的loadUrl（）
通过WebView的evaluateJavascript（）

一通过WebView的loadUrl（）

1 将需要调用的my.html放到src/main/assets文件夹里

<!-- 文本名：javascript -->
<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8">
    <title>JavaCallJS</title>

    <!-- JS代码 -->
    <script>
        <!-- Android需要调用的方法 -->
        function callJS(){
          alert("Android调用了JS方法");
        }
    </script>

</head>

<textarea>JAVA调用JS</textarea>

</html>

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

public class TestActivity extends BaseActivity {

    WebView mWebView;
    private Button btnJavaCallJS;

    @Override
    protected int getLayoutId() {
        return R.layout.activity_test;
    }

    @Override
    protected void initData() {
        super.initData();
        mWebView = findViewById(R.id.webView);
        btnJavaCallJS = findViewById(R.id.btnJavaCallJS);
        WebSettings webSettings = mWebView.getSettings();

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

        webSettings.setJavaScriptCanOpenWindowsAutomatically(false);

        // 格式规定为:file:///android_asset/文件名.html
        mWebView.loadUrl("file:///android_asset/my.html");

        btnJavaCallJS.setOnClickListener(v -> {
            // 注意调用的JS方法名要对应上
            // 调用javascript的callJS()方法
            mWebView.loadUrl("javascript:callJS()");
        });

        // 由于设置了弹窗检验调用结果,所以需要支持js对话框
        // WebView只是载体，内容的渲染需要使用WebChromeClient类去实现
        // 通过设置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(TestActivity.this);
                b.setTitle("Alert");
                b.setMessage(message);
                b.setPositiveButton(android.R.string.ok, (dialog, which) -> result.confirm());
                b.setCancelable(false);
                b.create().show();
                return true;
            }
        });
    }

}

image.png

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

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

三 Webview类常用方法

1 加载url


  //方式1. 加载一个网页：
  webView.loadUrl("http://www.google.com/");

  //方式2：加载apk包中的html页面
  webView.loadUrl("file:///android_asset/test.html");

  //方式3：加载手机本地的html页面
   webView.loadUrl("content://com.android.htmlfileprovider/sdcard/test.html");

   // 方式4： 加载 HTML 页面的一小段内容
  WebView.loadData(String data, String mimeType, String encoding)
// 参数说明：
// 参数1：需要截取展示的内容
// 内容里不能出现 ’#’, ‘%’, ‘\’ , ‘?’ 这四个字符，若出现了需用 %23, %25, %27, %3f 对应来替代，否则会出现异常
// 参数2：展示内容的类型
// 参数3：编码

2 WebView的状态

//激活WebView为活跃状态，能正常执行网页的响应
webView.onResume() ；

//当页面被失去焦点被切换到后台不可见状态，需要执行onPause
//通过onPause动作通知内核暂停所有的动作，比如DOM的解析、plugin的执行、JavaScript执行。
webView.onPause()；

//当应用程序(存在webview)被切换到后台时，这个方法不仅仅针对当前的webview而是全局的全应用程序的webview
//它会暂停所有webview的layout，parsing，javascripttimer。降低CPU功耗。
webView.pauseTimers()
//恢复pauseTimers状态
webView.resumeTimers()；

//销毁Webview
//在关闭了Activity时，如果Webview的音乐或视频，还在播放。就必须销毁Webview
//但是注意：webview调用destory时,webview仍绑定在Activity上
//这是由于自定义webview构建时传入了该Activity的context对象
//因此需要先从父容器中移除webview,然后再销毁webview:
rootLayout.removeView(webView); 
webView.destroy();

3 关于前进 / 后退网页

//是否可以后退
Webview.canGoBack() 
//后退网页
Webview.goBack()

//是否可以前进                     
Webview.canGoForward()
//前进网页
Webview.goForward()

//以当前的index为起始点前进或者后退到历史记录中指定的steps
//如果steps为负数则为后退，正数则为前进
Webview.goBackOrForward(intsteps)

4 Back键控制网页后退

public boolean onKeyDown(int keyCode, KeyEvent event) {
    if ((keyCode == KEYCODE_BACK) && mWebView.canGoBack()) { 
        mWebView.goBack();
        return true;
    }
    return super.onKeyDown(keyCode, event);
}

5 清除缓存数据

//清除网页访问留下的缓存
//由于内核缓存是全局的因此这个方法不仅仅针对webview而是针对整个应用程序.
Webview.clearCache(true);

//清除当前webview访问的历史记录
//只会webview访问历史记录里的所有记录除了当前访问记录
Webview.clearHistory()；

//这个api仅仅清除自动完成填充的表单数据，并不会清除WebView存储到本地的数据
Webview.clearFormData()；

四 WebSettings类

//声明WebSettings子类
WebSettings webSettings = webView.getSettings();

//如果访问的页面中要与Javascript交互，则webview必须设置支持Javascript
webSettings.setJavaScriptEnabled(true);  
// 若加载的 html 里有JS 在执行动画等操作，会造成资源浪费（CPU、电量）
// 在 onStop 和 onResume 里分别调用 webView.onResume()   webView.onPause() 

//支持插件
webSettings.setPluginsEnabled(true); 

//设置自适应屏幕，两者合用
webSettings.setUseWideViewPort(true); //将图片调整到适合webview的大小 
webSettings.setLoadWithOverviewMode(true); // 缩放至屏幕的大小

//缩放操作
webSettings.setSupportZoom(true); //支持缩放，默认为true。是下面那个的前提。
webSettings.setBuiltInZoomControls(true); //设置内置的缩放控件。若为false，则该WebView不可缩放
webSettings.setDisplayZoomControls(false); //隐藏原生的缩放控件

//其他细节操作
webSettings.setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK); //关闭webview中缓存 
webSettings.setAllowFileAccess(true); //设置可以访问文件 
webSettings.setJavaScriptCanOpenWindowsAutomatically(true); //支持通过JS打开新窗口 
webSettings.setLoadsImagesAutomatically(true); //支持自动加载图片
webSettings.setDefaultTextEncodingName("utf-8");//设置编码格式

2 设置WebView缓存

//优先使用缓存:
webView.getSettings().setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK);
 //缓存模式如下：
 //LOAD_CACHE_ONLY: 不使用网络，只读取本地缓存数据
//LOAD_DEFAULT: （默认）根据cache-control决定是否从网络上取数据。
//LOAD_NO_CACHE: 不使用缓存，只从网络获取数据.
//LOAD_CACHE_ELSE_NETWORK，只要本地有，无论是否过期，或者no-cache，都使用缓存中的数据。

 //不使用缓存:
webView.getSettings().setCacheMode(WebSettings.LOAD_NO_CACHE);

String cacheDirPath = getFilesDir().getAbsolutePath() + "cache";
webView.getSettings().setAppCachePath(cacheDirPath); //设置  Application Caches 缓存目录

每个 Application 只调用一次 WebSettings.setAppCachePath()

五 WebViewClient类处理各种通知 & 请求事件

webView.setWebViewClient(new WebViewClient() {

            //使得打开网页时不调用系统浏览器，而是在本WebView中显示
            @Override
            public boolean shouldOverrideUrlLoading(WebView view, String url) {
                view.loadUrl(url);
                return true;
            }

            @Override
            public void onPageStarted(WebView view, String url, Bitmap favicon) {
                //设定加载开始的操作
            }

            //在加载页面资源时会调用，每一个资源（比如图片）的加载都会调用一次
            @Override
            public void onLoadResource(WebView view, String url) {
                super.onLoadResource(view, url);
                //设定加载资源的操作
            }

            //步骤1：写一个html文件（error_handle.html），用于出错时展示给用户看的提示页面
            //步骤2：将该html文件放置到代码根目录的assets文件夹下
            //步骤3：复写WebViewClient的onRecievedError方法
            //该方法传回了错误码，根据错误类型可以进行不同的错误分类处理
            @Override
            public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) {
                switch (errorCode) {
                    case 404:
                        view.loadUrl("file:///android_assets/error_handle.html");
                        break;
                }
            }

            //webView默认是不处理https请求的，页面显示空白，需要进行如下设置：
            @Override
            public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
                handler.proceed();    //表示等待证书响应
                // handler.cancel();      //表示挂起连接，为默认方式
                // handler.handleMessage(null);    //可做其他处理
            }

        });

// 特别注意：5.1以上默认禁止了https和http混用，以下方式是开启
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
            webView.getSettings().setMixedContentMode(WebSettings.MIXED_CONTENT_ALWAYS_ALLOW);
        }

六辅助 WebView 处理 Javascript 的对话框,网站图标,网站标题等等。

webView.setWebChromeClient(new WebChromeClient() {

            //获得网页的加载进度并显示
            @Override
            public void onProgressChanged(WebView view, int newProgress) {
                if (newProgress < 100) {
                    String progress = newProgress + "%";
                }
            }

            //获取Web页中的标题
            @Override
            public void onReceivedTitle(WebView view, String title) {
                titleview.setText(title);
            }

            //支持javascript的警告框
            @Override
            public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
                new AlertDialog.Builder(mContext)
                        .setTitle("JsAlert")
                        .setMessage(message)
                        .setPositiveButton("OK", new DialogInterface.OnClickListener() {
                            @Override
                            public void onClick(DialogInterface dialog, int which) {
                                result.confirm();
                            }
                        })
                        .setCancelable(false)
                        .show();
                return true;
            }

            //支持javascript的确认框
            @Override
            public boolean onJsConfirm(WebView view, String url, String message, final JsResult result) {
                new AlertDialog.Builder(mContext)
                        .setTitle("JsConfirm")
                        .setMessage(message)
                        .setPositiveButton("OK", new DialogInterface.OnClickListener() {
                            @Override
                            public void onClick(DialogInterface dialog, int which) {
                                result.confirm();
                            }
                        })
                        .setNegativeButton("Cancel", new DialogInterface.OnClickListener() {
                            @Override
                            public void onClick(DialogInterface dialog, int which) {
                                result.cancel();
                            }
                        })
                        .setCancelable(false)
                        .show();
                // 返回布尔值：判断点击时确认还是取消
                // true表示点击了确认；false表示点击了取消；
                return true;
            }

        });

七如何避免WebView内存泄露？

1 不在xml中定义 WebView ，而是在需要的时候在Activity中创建，并且Context使用 getApplicationgContext()

LinearLayout.LayoutParams params = new LinearLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT);
mWebView = new WebView(getApplicationContext());
mWebView.setLayoutParams(params);
mLayout.addView(mWebView);

2 在 Activity 销毁（ WebView ）的时候，先让 WebView 加载null内容，然后移除 WebView，再销毁 WebView，最后置空。

    @Override
    protected void onDestroy() {
        if (mWebView != null) {
            mWebView.loadDataWithBaseURL(null, "", "text/html", "utf-8", null);

            ((ViewGroup) mWebView.getParent()).removeView(mWebView);
            mWebView.destroy();
            mWebView = null;
        }
        super.onDestroy();
    }

944365-6e249d5a3cc7d343.png

这一篇我们到这里收队

Android WebView与 JS 的交互方式

JS调用Android

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

2 将需要调用的hello.html放到src/main/assets文件夹里

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

Android 4.2版本之后

Android通过WebView调用 JS 代码

一通过WebView的loadUrl（）

1 将需要调用的my.html放到src/main/assets文件夹里

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

二通过WebView的evaluateJavascript（）

三 Webview类常用方法

1 加载url

2 WebView的状态

3 关于前进 / 后退网页

4 Back键控制网页后退

5 清除缓存数据

四 WebSettings类

2 设置WebView缓存

五 WebViewClient类处理各种通知 & 请求事件

六辅助 WebView 处理 Javascript 的对话框,网站图标,网站标题等等。

七如何避免WebView内存泄露？

猜你喜欢

热点阅读

Android WebView与 JS 的交互方式

JS调用Android

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

2 将需要调用的hello.html放到src/main/assets文件夹里

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

Android 4.2版本之后

Android通过WebView调用 JS 代码

一 通过WebView的loadUrl（）

1 将需要调用的my.html放到src/main/assets文件夹里

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

二 通过WebView的evaluateJavascript（）

三 Webview类常用方法

1 加载url

2 WebView的状态

3 关于前进 / 后退网页

4 Back键控制网页后退

5 清除缓存数据

四 WebSettings类

2 设置WebView缓存

五 WebViewClient类处理各种通知 & 请求事件

六 辅助 WebView 处理 Javascript 的对话框,网站图标,网站标题等等。

七 如何避免WebView内存泄露？

猜你喜欢

热点阅读

一通过WebView的loadUrl（）

二通过WebView的evaluateJavascript（）

六辅助 WebView 处理 Javascript 的对话框,网站图标,网站标题等等。

七如何避免WebView内存泄露？