当前位置:   article > 正文

Android Webview 详解

android webview

一   简介

一个基于webkit引擎、展现web页面的控件

  • Android 4.4前:Android Webview在低版本 & 高版本采用了不同的webkit版本的内核
  • Android 4.4后:直接使用了Chrome内核

1.1 作用

  • 在 Android 客户端上加载h5页面
  • 在本地 与 h5页面实现交互 & 调用
  • 其他:对 url 请求、页面加载、渲染、对话框 进行额外处理。

二  具体使用

Webview的使用主要包括:Webview类 及其 工具类(WebSettings类、WebViewClient类、WebChromeClient类)

2.1 Webview常用方法 

2.1.1 WebView的状态
  1. //激活WebView为活跃状态,能正常执行网页的响应
  2. webView.onResume() ;
  3. //当页面被失去焦点被切换到后台不可见状态,需要执行onPause
  4. //通过onPause动作通知内核暂停所有的动作,比如DOM的解析、plugin的执行、JavaScript执行。
  5. webView.onPause();
  6. //当应用程序(存在webview)被切换到后台时,这个方法不仅仅针对当前的webview而是全局的全应用程序的webview
  7. //它会暂停所有webview的layout,parsing,javascripttimer。降低CPU功耗。
  8. webView.pauseTimers()
  9. //恢复pauseTimers状态
  10. webView.resumeTimers();
  11. //销毁Webview
  12. //在关闭了Activity时,如果Webview的音乐或视频,还在播放。就必须销毁Webview
  13. //但是注意:webview调用destory时,webview仍绑定在Activity上
  14. //这是由于自定义webview构建时传入了该Activity的context对象
  15. //因此需要先从父容器中移除webview,然后再销毁webview:
  16. rootLayout.removeView(webView);
  17. webView.destroy();
2.1.2 关于前进 / 后退网页
  1. //是否可以后退
  2. Webview.canGoBack()
  3. //后退网页
  4. Webview.goBack()
  5. //是否可以前进
  6. Webview.canGoForward()
  7. //前进网页
  8. Webview.goForward()
  9. //以当前的index为起始点前进或者后退到历史记录中指定的steps
  10. //如果steps为负数则为后退,正数则为前进
  11. Webview.goBackOrForward(intsteps)

常见用法:Back键控制网页后退

  • 问题:在不做任何处理前提下 ,浏览网页时点击系统的“Back”键,整个 Browser 会调用 finish()而结束自身
  • 目标:点击返回后,是网页回退而不是推出浏览器
  • 解决方案:在当前Activity中处理并消费掉该 Back 事件
  1. public boolean onKeyDown(int keyCode, KeyEvent event) {
  2. if ((keyCode == KEYCODE_BACK) && mWebView.canGoBack()) {
  3. mWebView.goBack();
  4. return true;
  5. }
  6. return super.onKeyDown(keyCode, event);
  7. }
2.1.3 清除缓存数据
  1. //清除网页访问留下的缓存
  2. //由于内核缓存是全局的因此这个方法不仅仅针对webview而是针对整个应用程序.
  3. Webview.clearCache(true);
  4. //清除当前webview访问的历史记录
  5. //只会webview访问历史记录里的所有记录除了当前访问记录
  6. Webview.clearHistory();
  7. //这个api仅仅清除自动完成填充的表单数据,并不会清除WebView存储到本地的数据
  8. Webview.clearFormData();
2.1.4 使用 WebView 加载网页 
  1. //加载网页链接
  2. webView.loadUrl("http://keithxiaoy.com");
  3. //加载本地assets目录下的网页
  4. webView.loadUrl("file:///android_asset/keithxiaoy.html");
  5. //加载手机本地的html页面
  6. webView.loadUrl("content://com.android.htmlfileprovider/sdcard/keithxiaoy.html");
  7. //加载 HTML 页面的一小段内容。参数1:需要截取展示的内容、参数2:展示内容的类型、参数3:字节码
  8. webView.loadData(String data, String mimeType, String encoding)

2.2 常用类

2.2.1 WebSettings类
  • 作用:对WebView进行配置和管理
  • 配置步骤 & 常见方法:

配置步骤1:添加访问网络权限(AndroidManifest.xml)

<uses-permission android:name="android.permission.INTERNET"/>

配置步骤2:生成一个WebView组件(有两种方式)

  1. //方式1:直接在在Activity中生成
  2. WebView webView = new WebView(this)
  3. //方法2:在Activity的layout文件里添加webview控件:
  4. WebView webview = (WebView) findViewById(R.id.webView1);

配置步骤3:进行配置-利用WebSettings子类(常见方法)

  1. //声明WebSettings子类
  2. WebSettings webSettings = webView.getSettings();
  3. //如果访问的页面中要与Javascript交互,则webview必须设置支持Javascript
  4. webSettings.setJavaScriptEnabled(true);
  5. //支持插件
  6. webSettings.setPluginsEnabled(true);
  7. //设置自适应屏幕,两者合用
  8. webSettings.setUseWideViewPort(true); //将图片调整到适合webview的大小
  9. webSettings.setLoadWithOverviewMode(true); // 缩放至屏幕的大小
  10. //缩放操作
  11. webSettings.setSupportZoom(true); //支持缩放,默认为true。是下面那个的前提。
  12. webSettings.setBuiltInZoomControls(true); //设置内置的缩放控件。若为false,则该WebView不可缩放
  13. webSettings.setDisplayZoomControls(false); //隐藏原生的缩放控件
  14. //其他细节操作
  15. webSettings.setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK); //关闭webview中缓存
  16. webSettings.setAllowFileAccess(true); //设置可以访问文件
  17. webSettings.setJavaScriptCanOpenWindowsAutomatically(true); //支持通过JS打开新窗口
  18. webSettings.setLoadsImagesAutomatically(true); //支持自动加载图片
  19. webSettings.setDefaultTextEncodingName("utf-8");//设置编码格式

常见用法:设置WebView缓存

  • 当加载 html 页面时,WebView会在/data/data/包名目录下生成 database 与 cache 两个文件夹
  • 请求的 URL记录保存在 WebViewCache.db,而 URL的内容是保存在 WebViewCache 文件夹下
  • 是否启用缓存:
  1. //优先使用缓存:
  2. WebView.getSettings().setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK);
  3. //缓存模式如下:
  4. //LOAD_CACHE_ONLY: 不使用网络,只读取本地缓存数据
  5. //LOAD_DEFAULT: (默认)根据cache-control决定是否从网络上取数据。
  6. //LOAD_NO_CACHE: 不使用缓存,只从网络获取数据.
  7. //LOAD_CACHE_ELSE_NETWORK,只要本地有,无论是否过期,或者no-cache,都使用缓存中的数据。
  8. //不使用缓存:
  9. WebView.getSettings().setCacheMode(WebSettings.LOAD_NO_CACHE);
  • 结合使用(离线加载)
  1. if (NetStatusUtil.isConnected(getApplicationContext())) {
  2. webSettings.setCacheMode(WebSettings.LOAD_DEFAULT);//根据cache-control决定是否从网络上取数据。
  3. } else {
  4. webSettings.setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK);//没网,则从本地获取,即离线加载
  5. }
  6. webSettings.setDomStorageEnabled(true); // 开启 DOM storage API 功能
  7. webSettings.setDatabaseEnabled(true); //开启 database storage API 功能
  8. webSettings.setAppCacheEnabled(true);//开启 Application Caches 功能
  9. String cacheDirPath = getFilesDir().getAbsolutePath() + APP_CACAHE_DIRNAME;
  10. webSettings.setAppCachePath(cacheDirPath); //设置 Application Caches 缓存目录

注意: 每个 Application 只调用一次 WebSettings.setAppCachePath(),WebSettings.setAppCacheMaxSize()

2.2.2 WebViewClient类
  • 作用:处理各种通知 & 请求事件
  • 常见方法

常见方法1:shouldOverrideUrlLoading()

  • 作用:打开网页时不调用系统浏览器, 而是在本WebView中显示;在网页上的所有加载都经过这个方法,这个函数我们可以做很多操作。
    1. //步骤1. 定义Webview组件
    2. Webview webview = (WebView) findViewById(R.id.webView1);
    3. //步骤2. 选择加载方式
    4. //方式1. 加载一个网页:
    5. webView.loadUrl("http://www.google.com/");
    6. //方式2:加载apk包中的html页面
    7. webView.loadUrl("file:///android_asset/test.html");
    8. //方式3:加载手机本地的html页面
    9. webView.loadUrl("content://com.android.htmlfileprovider/sdcard/test.html");
    10. //步骤3. 复写shouldOverrideUrlLoading()方法,使得打开网页时不调用系统浏览器, 而是在本WebView中显示
    11. webView.setWebViewClient(new WebViewClient(){
    12. @Override
    13. public boolean shouldOverrideUrlLoading(WebView view, String url) {
    14. view.loadUrl(url);
    15. return true;
    16. }
    17. });

    常见方法2:onPageStarted()

  • 作用:开始载入页面调用的,我们可以设定一个loading的页面,告诉用户程序在等待网络响应。
  1. webView.setWebViewClient(new WebViewClient(){
  2. @Override
  3. public void onPageStarted(WebView view, String url, Bitmap favicon) {
  4. //设定加载开始的操作
  5. }
  6. });

 常见方法3:onPageFinished()

  • 作用:在页面加载结束时调用。我们可以关闭loading 条,切换程序动作。
  1. webView.setWebViewClient(new WebViewClient(){
  2. @Override
  3. public void onPageFinished(WebView view, String url) {
  4. //设定加载结束的操作
  5. }
  6. });

常见方法4:onLoadResource()

  • 作用:在加载页面资源时会调用,每一个资源(比如图片)的加载都会调用一次。
  1. webView.setWebViewClient(new WebViewClient(){
  2. @Override
  3. public boolean onLoadResource(WebView view, String url) {
  4. //设定加载资源的操作
  5. }
  6. });

常见方法5:onReceivedError()

  • 作用:加载页面的服务器出现错误时(如404)调用。

App里面使用webview控件的时候遇到了诸如404这类的错误的时候,若也显示浏览器里面的那种错误提示页面就显得很丑陋了,那么这个时候我们的app就需要加载一个本地的错误提示页面,即webview如何加载一个本地的页面

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

常见方法6:onReceivedSslError()

  • 作用:处理https请求

webView默认是不处理https请求的,页面显示空白,需要进行如下设置:

  1. webView.setWebViewClient(new WebViewClient() {
  2. @Override
  3. public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
  4. handler.proceed(); //表示等待证书响应
  5. // handler.cancel(); //表示挂起连接,为默认方式
  6. // handler.handleMessage(null); //可做其他处理
  7. }
  8. });
2.2.3 WebChromeClient类
  • 作用:辅助 WebView 处理 Javascript 的对话框,网站图标,网站标题等等。
  • 常见使用:

常见方法1: onProgressChanged()

  • 作用:获得网页的加载进度并显示
  1. webview.setWebChromeClient(new WebChromeClient(){
  2. @Override
  3. public void onProgressChanged(WebView view, int newProgress) {
  4. if (newProgress < 100) {
  5. String progress = newProgress + "%";
  6. progress.setText(progress);
  7. } else {
  8. }
  9. });

常见方法2: onReceivedTitle()

  • 作用:获取Web页中的标题
每个网页的页面都有一个标题,比如www.baidu.com这个页面的标题即“百度一下,你就知道”,那么如何知道当前webview正在加载的页面的title并进行设置呢
  1. webview.setWebChromeClient(new WebChromeClient(){
  2. @Override
  3. public void onReceivedTitle(WebView view, String title) {
  4. titleview.setText(title);
  5. }

 2.3 实例

  • 目标:实现显示“www.baidu.com”、获取其标题、提示加载开始 & 结束和获取加载进度
  • 具体实现:

步骤1:添加访问网络权限

<uses-permission android:name="android.permission.INTERNET"/>

步骤2:主布局

activity_main.xml

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
  3. xmlns:tools="http://schemas.android.com/tools"
  4. android:layout_width="match_parent"
  5. android:layout_height="match_parent"
  6. android:paddingBottom="@dimen/activity_vertical_margin"
  7. android:paddingLeft="@dimen/activity_horizontal_margin"
  8. android:paddingRight="@dimen/activity_horizontal_margin"
  9. android:paddingTop="@dimen/activity_vertical_margin"
  10. tools:context="com.example.carson_ho.webview_demo.MainActivity">
  11. <!-- 获取网站的标题-->
  12. <TextView
  13. android:id="@+id/title"
  14. android:layout_width="wrap_content"
  15. android:layout_height="wrap_content"
  16. android:text=""/>
  17. <!--开始加载提示-->
  18. <TextView
  19. android:id="@+id/text_beginLoading"
  20. android:layout_below="@+id/title"
  21. android:layout_width="wrap_content"
  22. android:layout_height="wrap_content"
  23. android:text=""/>
  24. <!--获取加载进度-->
  25. <TextView
  26. android:layout_below="@+id/text_beginLoading"
  27. android:id="@+id/text_Loading"
  28. android:layout_width="wrap_content"
  29. android:layout_height="wrap_content"
  30. android:text=""/>
  31. <!--结束加载提示-->
  32. <TextView
  33. android:layout_below="@+id/text_Loading"
  34. android:id="@+id/text_endLoading"
  35. android:layout_width="wrap_content"
  36. android:layout_height="wrap_content"
  37. android:text=""/>
  38. <!--显示网页区域-->
  39. <WebView
  40. android:id="@+id/webView1"
  41. android:layout_below="@+id/text_endLoading"
  42. android:layout_width="fill_parent"
  43. android:layout_height="fill_parent"
  44. android:layout_marginTop="10dp" />
  45. </RelativeLayout>

步骤3:根据需要实现的功能从而使用相应的子类及其方法(注释很清楚了)

MainActivity.java

  1. package com.example.carson_ho.webview_demo;
  2. import android.graphics.Bitmap;
  3. import android.os.Bundle;
  4. import android.support.v7.app.AppCompatActivity;
  5. import android.view.KeyEvent;
  6. import android.view.ViewGroup;
  7. import android.webkit.WebChromeClient;
  8. import android.webkit.WebSettings;
  9. import android.webkit.WebView;
  10. import android.webkit.WebViewClient;
  11. import android.widget.TextView;
  12. public class MainActivity extends AppCompatActivity {
  13. WebView mWebview;
  14. WebSettings mWebSettings;
  15. TextView beginLoading,endLoading,loading,mtitle;
  16. @Override
  17. protected void onCreate(Bundle savedInstanceState) {
  18. super.onCreate(savedInstanceState);
  19. setContentView(R.layout.activity_main);
  20. mWebview = (WebView) findViewById(R.id.webView1);
  21. beginLoading = (TextView) findViewById(R.id.text_beginLoading);
  22. endLoading = (TextView) findViewById(R.id.text_endLoading);
  23. loading = (TextView) findViewById(R.id.text_Loading);
  24. mtitle = (TextView) findViewById(R.id.title);
  25. mWebSettings = mWebview.getSettings();
  26. mWebview.loadUrl("http://www.baidu.com/");
  27. //设置不用系统浏览器打开,直接显示在当前Webview
  28. mWebview.setWebViewClient(new WebViewClient() {
  29. @Override
  30. public boolean shouldOverrideUrlLoading(WebView view, String url) {
  31. view.loadUrl(url);
  32. return true;
  33. }
  34. });
  35. //设置WebChromeClient类
  36. mWebview.setWebChromeClient(new WebChromeClient() {
  37. //获取网站标题
  38. @Override
  39. public void onReceivedTitle(WebView view, String title) {
  40. System.out.println("标题在这里");
  41. mtitle.setText(title);
  42. }
  43. //获取加载进度
  44. @Override
  45. public void onProgressChanged(WebView view, int newProgress) {
  46. if (newProgress < 100) {
  47. String progress = newProgress + "%";
  48. loading.setText(progress);
  49. } else if (newProgress == 100) {
  50. String progress = newProgress + "%";
  51. loading.setText(progress);
  52. }
  53. }
  54. });
  55. //设置WebViewClient类
  56. mWebview.setWebViewClient(new WebViewClient() {
  57. //设置加载前的函数
  58. @Override
  59. public void onPageStarted(WebView view, String url, Bitmap favicon) {
  60. System.out.println("开始加载了");
  61. beginLoading.setText("开始加载了");
  62. }
  63. //设置结束加载函数
  64. @Override
  65. public void onPageFinished(WebView view, String url) {
  66. endLoading.setText("结束加载了");
  67. }
  68. });
  69. }
  70. //点击返回上一页面而不是退出浏览器
  71. @Override
  72. public boolean onKeyDown(int keyCode, KeyEvent event) {
  73. if (keyCode == KeyEvent.KEYCODE_BACK && mWebview.canGoBack()) {
  74. mWebview.goBack();
  75. return true;
  76. }
  77. return super.onKeyDown(keyCode, event);
  78. }
  79. //销毁Webview
  80. @Override
  81. protected void onDestroy() {
  82. if (mWebview != null) {
  83. mWebview.loadDataWithBaseURL(null, "", "text/html", "utf-8", null);
  84. mWebview.clearHistory();
  85. ((ViewGroup) mWebview.getParent()).removeView(mWebview);
  86. mWebview.destroy();
  87. mWebview = null;
  88. }
  89. super.onDestroy();
  90. }
  91. }

三  WebView与 JS 交互方式

3.1 交互方式总结 

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

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

二者沟通的桥梁是WebView

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

  • 通过WebView的loadUrl()
  • 通过WebView的evaluateJavascript()

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

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

3.2  具体分析

3.2.1 Android通过WebView调用 JS 代码

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

  1. 通过WebView的loadUrl()
  2. 通过WebView的evaluateJavascript()
方式1:通过WebViewloadUrl()
  • 实例介绍:点击Android按钮,即调用WebView JS(文本名为javascript)中callJS()
  • 具体使用:

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

  1. 为了方便展示,本文是采用Andorid调用本地JS代码说明;
  2. 实际情况时,Android更多的是调用远程JS代码,即将加载的JS代码路径改成url即可

需要加载JS代码:javascript.html

  1. // 文本名:javascript
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <title>Carson_Ho</title>
  7. // JS代码
  8. <script>
  9. // Android需要调用的方法
  10. function callJS(){
  11. alert("Android调用了JS的callJS方法");
  12. }
  13. </script>
  14. </head>
  15. </html>

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

Android代码:MainActivity.java

  1. public class MainActivity extends AppCompatActivity {
  2. WebView mWebView;
  3. Button button;
  4. @Override
  5. protected void onCreate(Bundle savedInstanceState) {
  6. super.onCreate(savedInstanceState);
  7. setContentView(R.layout.activity_main);
  8. mWebView =(WebView) findViewById(R.id.webview);
  9. WebSettings webSettings = mWebView.getSettings();
  10. // 设置与Js交互的权限
  11. webSettings.setJavaScriptEnabled(true);
  12. // 设置允许JS弹窗
  13. webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
  14. // 先载入JS代码
  15. // 格式规定为:file:///android_asset/文件名.html
  16. mWebView.loadUrl("file:///android_asset/javascript.html");
  17. button = (Button) findViewById(R.id.button);
  18. button.setOnClickListener(new View.OnClickListener() {
  19. @Override
  20. public void onClick(View v) {
  21. // 通过Handler发送消息
  22. mWebView.post(new Runnable() {
  23. @Override
  24. public void run() {
  25. // 注意调用的JS方法名要对应上
  26. // 调用javascript的callJS()方法
  27. mWebView.loadUrl("javascript:callJS()");
  28. }
  29. });
  30. }
  31. });
  32. // 由于设置了弹窗检验调用结果,所以需要支持js对话框
  33. // webview只是载体,内容的渲染需要使用webviewChromClient类去实现
  34. // 通过设置WebChromeClient对象处理JavaScript的对话框
  35. //设置响应js 的Alert()函数
  36. mWebView.setWebChromeClient(new WebChromeClient() {
  37. @Override
  38. public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
  39. AlertDialog.Builder b = new AlertDialog.Builder(MainActivity.this);
  40. b.setTitle("Alert");
  41. b.setMessage(message);
  42. b.setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() {
  43. @Override
  44. public void onClick(DialogInterface dialog, int which) {
  45. result.confirm();
  46. }
  47. });
  48. b.setCancelable(false);
  49. b.create().show();
  50. return true;
  51. }
  52. });
  53. }
  54. }

特别注意:JS代码调用一定要在 onPageFinished() 回调之后才能调用,否则不会调用。

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

方式2:通过WebViewevaluateJavascript()
  • 优点:该方法比第一种方法效率更高、使用更简洁。
  1. 因为该方法的执行不会使页面刷新,而第一种方法(loadUrl )的执行则会。
  2. Android 4.4 后才可使用
  • 具体使用
  1. // 只需要将第一种方法的loadUrl()换成下面该方法即可
  2. mWebView.evaluateJavascript("javascript:callJS()", new ValueCallback<String>() {
  3. @Override
  4. public void onReceiveValue(String value) {
  5. //此处为 js 返回的结果
  6. }
  7. });
  8. }
3.2.2 方法对比

3.2.2 JS通过WebView调用 Android 代码

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

  • 通过WebView的addJavascriptInterface()进行对象映射
  • 通过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url
  • 通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt()方法回调拦截JS对话框alert()、confirm()、prompt() 消息
3.2.2.1 方法分析 
方式1:通过 WebViewaddJavascriptInterface()进行对象映射

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

AndroidtoJs.java(注释已经非常清楚)

  1. // 继承自Object类
  2. public class AndroidtoJs {
  3. // 定义JS需要调用的方法
  4. // 被JS调用的方法必须加入@JavascriptInterface注解
  5. @JavascriptInterface
  6. public void hello(String msg) {
  7. System.out.println("JS调用了Android的hello方法");
  8. }
  9. }

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

需要加载JS代码:javascript.html

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Carson</title>
  6. <script>
  7. function callAndroid(){
  8. // 由于对象映射,所以调用test对象等于调用Android映射的对象
  9. test.hello("js调用了android中的hello方法");
  10. }
  11. </script>
  12. </head>
  13. <body>
  14. //点击按钮则调用callAndroid函数
  15. <button type="button" id="button1" onclick="callAndroid()"></button>
  16. </body>
  17. </html>

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

  1. public class MainActivity extends AppCompatActivity {
  2. WebView mWebView;
  3. @Override
  4. protected void onCreate(Bundle savedInstanceState) {
  5. super.onCreate(savedInstanceState);
  6. setContentView(R.layout.activity_main);
  7. mWebView = (WebView) findViewById(R.id.webview);
  8. WebSettings webSettings = mWebView.getSettings();
  9. // 设置与Js交互的权限
  10. webSettings.setJavaScriptEnabled(true);
  11. // 通过addJavascriptInterface()将Java对象映射到JS对象
  12. //参数1:Javascript对象名
  13. //参数2:Java对象名
  14. mWebView.addJavascriptInterface(new AndroidtoJs(), "test");//AndroidtoJS类对象映射到js的test对象
  15. // 加载JS代码
  16. // 格式规定为:file:///android_asset/文件名.html
  17. mWebView.loadUrl("file:///android_asset/javascript.html");

特点
  • 优点:使用简单

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

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

即JS需要调用Android的方法

  • 具体使用:
    步骤1:在JS约定所需要的Url协议
    JS代码:javascript.html

以.html格式放到src/main/assets文件夹里

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Carson_Ho</title>
  6. <script>
  7. function callAndroid(){
  8. /*约定的url协议为:js://webview?arg1=111&arg2=222*/
  9. document.location = "js://webview?arg1=111&arg2=222";
  10. }
  11. </script>
  12. </head>
  13. <!-- 点击按钮则调用callAndroid()方法 -->
  14. <body>
  15. <button type="button" id="button1" onclick="callAndroid()">点击调用Android代码</button>
  16. </body>
  17. </html>

当该JS通过Android的mWebView.loadUrl("file:///android_asset/javascript.html")加载后,就会回调shouldOverrideUrlLoading (),接下来继续看步骤2:

步骤2:在Android通过WebViewClient复写shouldOverrideUrlLoading ()

MainActivity.java

  1. public class MainActivity extends AppCompatActivity {
  2. WebView mWebView;
  3. // Button button;
  4. @Override
  5. protected void onCreate(Bundle savedInstanceState) {
  6. super.onCreate(savedInstanceState);
  7. setContentView(R.layout.activity_main);
  8. mWebView = (WebView) findViewById(R.id.webview);
  9. WebSettings webSettings = mWebView.getSettings();
  10. // 设置与Js交互的权限
  11. webSettings.setJavaScriptEnabled(true);
  12. // 设置允许JS弹窗
  13. webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
  14. // 步骤1:加载JS代码
  15. // 格式规定为:file:///android_asset/文件名.html
  16. mWebView.loadUrl("file:///android_asset/javascript.html");
  17. // 复写WebViewClient类的shouldOverrideUrlLoading方法
  18. mWebView.setWebViewClient(new WebViewClient() {
  19. @Override
  20. public boolean shouldOverrideUrlLoading(WebView view, String url) {
  21. // 步骤2:根据协议的参数,判断是否是所需要的url
  22. // 一般根据scheme(协议格式) & authority(协议名)判断(前两个参数)
  23. //假定传入进来的 url = "js://webview?arg1=111&arg2=222"(同时也是约定好的需要拦截的)
  24. Uri uri = Uri.parse(url);
  25. // 如果url的协议 = 预先约定的 js 协议
  26. // 就解析往下解析参数
  27. if (uri.getScheme().equals("js")) {
  28. // 如果 authority = 预先约定协议里的 webview,即代表都符合约定的协议
  29. // 所以拦截url,下面JS开始调用Android需要的方法
  30. if (uri.getAuthority().equals("webview")) {
  31. // 步骤3:
  32. // 执行JS所需要调用的逻辑
  33. System.out.println("js调用了Android的方法");
  34. // 可以在协议上带有参数并传递到Android上
  35. HashMap<String, String> params = new HashMap<>();
  36. Set<String> collection = uri.getQueryParameterNames();
  37. }
  38. return true;
  39. }
  40. return super.shouldOverrideUrlLoading(view, url);
  41. }
  42. });
  43. }
  44. }

特点
  • 优点:不存在方式1的漏洞;
  • 缺点:JS获取Android方法的返回值复杂。

如果JS想要得到Android方法的返回值,只能通过 WebView 的 loadUrl ()去执行 JS 方法把返回值传递回去,相关的代码如下:

  1. // Android:MainActivity.java
  2. mWebView.loadUrl("javascript:returnResult(" + result + ")");
  3. // JS:javascript.html
  4. function returnResult(result){
  5. alert("result is" + result);
  6. }
 方式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文件
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Carson_Ho</title>
  6. <script>
  7. function clickprompt(){
  8. // 调用prompt()
  9. var result=prompt("js://demo?arg1=111&arg2=222");
  10. alert("demo " + result);
  11. }
  12. </script>
  13. </head>
  14. <!-- 点击按钮则调用clickprompt() -->
  15. <body>
  16. <button type="button" id="button1" onclick="clickprompt()">点击调用Android代码</button>
  17. </body>
  18. </html>

 当使用mWebView.loadUrl("file:///android_asset/javascript.html")加载了上述JS代码后,就会触发回调onJsPrompt(),具体如下:

  1. 如果是拦截警告框(即alert()),则触发回调onJsAlert()
  2. 如果是拦截确认框(即confirm()),则触发回调onJsConfirm()

步骤2:在Android通过WebChromeClient复写onJsPrompt()

  1. public class MainActivity extends AppCompatActivity {
  2. WebView mWebView;
  3. // Button button;
  4. @Override
  5. protected void onCreate(Bundle savedInstanceState) {
  6. super.onCreate(savedInstanceState);
  7. setContentView(R.layout.activity_main);
  8. mWebView = (WebView) findViewById(R.id.webview);
  9. WebSettings webSettings = mWebView.getSettings();
  10. // 设置与Js交互的权限
  11. webSettings.setJavaScriptEnabled(true);
  12. // 设置允许JS弹窗
  13. webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
  14. // 先加载JS代码
  15. // 格式规定为:file:///android_asset/文件名.html
  16. mWebView.loadUrl("file:///android_asset/javascript.html");
  17. mWebView.setWebChromeClient(new WebChromeClient() {
  18. // 拦截输入框(原理同方式2)
  19. // 参数message:代表promt()的内容(不是url)
  20. // 参数result:代表输入框的返回值
  21. @Override
  22. public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
  23. // 根据协议的参数,判断是否是所需要的url(原理同方式2)
  24. // 一般根据scheme(协议格式) & authority(协议名)判断(前两个参数)
  25. //假定传入进来的 url = "js://webview?arg1=111&arg2=222"(同时也是约定好的需要拦截的)
  26. Uri uri = Uri.parse(message);
  27. // 如果url的协议 = 预先约定的 js 协议
  28. // 就解析往下解析参数
  29. if (uri.getScheme().equals("js")) {
  30. // 如果 authority = 预先约定协议里的 webview,即代表都符合约定的协议
  31. // 所以拦截url,下面JS开始调用Android需要的方法
  32. if (uri.getAuthority().equals("webview")) {
  33. //
  34. // 执行JS所需要调用的逻辑
  35. System.out.println("js调用了Android的方法");
  36. // 可以在协议上带有参数并传递到Android上
  37. HashMap<String, String> params = new HashMap<>();
  38. Set<String> collection = uri.getQueryParameterNames();
  39. //参数result:代表消息框的返回值(输入值)
  40. result.confirm("js调用了Android的方法成功啦");
  41. }
  42. return true;
  43. }
  44. return super.onJsPrompt(view, url, message, defaultValue, result);
  45. }
  46. // 通过alert()和confirm()拦截的原理相同,此处不作过多讲述
  47. // 拦截JS的警告框
  48. @Override
  49. public boolean onJsAlert(WebView view, String url, String message, JsResult result) {
  50. return super.onJsAlert(view, url, message, result);
  51. }
  52. // 拦截JS的确认框
  53. @Override
  54. public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {
  55. return super.onJsConfirm(view, url, message, result);
  56. }
  57. });
  58. }
  59. }

 

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

3.3  总结 

  • 本节主要对Android通过WebView与JS的交互方式进行了全面介绍
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/天景科技苑/article/detail/931803
推荐阅读
相关标签
  

闽ICP备14008679号