Android WebView 详解
简介
Android WebView在Android平台上是一个特殊的View, 基于webkit引擎、展现web页面的控件,这个类可以被用来在你的app中仅仅显示一张在
线的网页,还可以用来开发浏览器。WebView内部实现是采用渲染引擎来展示view的内容,提供网页前进后退,网页放大,缩小,搜索。Android的Webview
在低版本和高版本采用了不同的webkit版本内核,4.4后直接使用了Chrome。
作用
- 显示和渲染Web页面
- 直接使用html文件(网络上或本地assets中)作布局
- 可和JavaScript交互调用
WebView控件功能强大,除了具有一般View的属性和设置外,还可以对url请求、页面加载、渲染、页面交互进行强大的处理。
加载Html的几种方式
mWebView.loadUrl("http://www.baidu.com");//加载一个网页, 内容里不能出现 ’#’, ‘%’, ‘\’ , ‘?’ 这四个字符,若出现了需用 %23, %25, %27, %3f 对应来替代,否则会出现异常
mWebView.loadUrl("file:///android_asset/test.html");//加载项目asset文件夹下html页面,格式规定为:file:///android_asset/文件名.html
mWebView.loadUrl("content://com.ansen.webview/sdcard/test.html");//加载手机本地的html页面
mWebView.loadDataWithBaseURL(null,"Html代码", "text/html" , "utf-8", null);//显示html代码
网页前进/后退
//是否可以后退
mWebView.canGoBack()
//后退网页
mWebView.goBack()
//是否可以前进
mWebView.canGoForward()
//前进网页
mWebView.goForward()
//以当前的index为起始点前进或者后退到历史记录中指定的steps
//如果steps为负数则为后退,正数则为前进
mWebView.goBackOrForward(intsteps)
例如:
- 点击事件
btn_finish.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
if (mWebView != null && mWebView.canGoBack()) {
mWebView.goBack();
//mWebView.goForward();
} else {
finish();
}
}
});
- 监听Back键
//在不做任何处理前提下,浏览网页时点击系统的Back键,整个WebView会调用 finish()结束自身,而不是调用goBack()后退
@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK && mWebView.canGoBack()) {
mWebView.goBack();
return true;
}
return super.onKeyDown(keyCode, event);
}
清除缓存数据
//清除网页访问留下的缓存,由于内核缓存是全局的因此这个方法不仅仅针对webview而是针对整个应用程序.
mWebView.clearCache(true);
//清除当前webview访问的历史记录,出了当前的访问记录
mWebView.clearHistory();
//仅仅清除自动完成填充的表单数据,并不会清除WebView存储到本地的数据
mWebView.clearFormData();
WebSettings类
- 作用:对WebView进行配置和管理
//获取用于控制WebView设置的WebSettings对象
WebSettings webSettings = webView.getSettings();
//若加载的html里有JS在执行动画等操作,会造成资源浪费(CPU、电量)
//在onStop和onResume里分别把 setJavaScriptEnabled() 给设置成 false 和 true 即可
webSettings.setJavaScriptEnabled(true);//如果访问的页面中要与Js交互,则webview必须设置支持Js
webSettings.setJavaScriptCanOpenWindowsAutomatically(true); // 设置允许JS弹窗
//支持插件(无效了)
webSettings.setPluginsEnabled(true);
//设置自适应屏幕,两者合用
webSettings.setUseWideViewPort(true); //将图片调整到适合webview的大小
webSettings.setLoadWithOverviewMode(true); // 缩放至屏幕的大小
//缩放操作
webSettings.setSupportZoom(true); //支持缩放,默认为true。是下面那个的前提。
webSettings.setBuiltInZoomControls(true); //内置缩放控件,ture,WebView可缩放;false不可缩放,并且下面的方法无效
webSettings.setDisplayZoomControls(false); //false隐藏,true显示原生的缩放控件
//缓存
webSettings.setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK); //关闭webview中缓存
webSettings.setCacheMode(WebSettings.LOAD_DEFAULT);//先加缓存再请求网络
//缓存模式如下:
//LOAD_CACHE_ONLY: 不使用网络,只读取本地缓存数据
//LOAD_DEFAULT: (默认)根据cache-control决定是否从网络上取数据。
//LOAD_NO_CACHE: 不使用缓存,只从网络获取数据.
//LOAD_CACHE_ELSE_NETWORK,只要本地有,无论是否过期,或者no-cache,都使用缓存中的数据
webSettings.setDomStorageEnabled(true); // 开启 DOM storage API 功能
webSettings.setDatabaseEnabled(true); //开启 database storage API 功能
webSettings.setAppCacheEnabled(true);//开启 Application Caches 功能
//String cacheDirPath = getFilesDir().getAbsolutePath() + APP_CACAHE_DIRNAME;
webSettings.setAppCachePath(cacheDirPath); //设置 Application Caches 缓存目录
webSettings.setAllowFileAccess(true);//允许WebView使用File协议
webSettings.setSavePassword(false);//不保存密码
//其他细节操作
webSettings.setAllowFileAccess(true); //设置可以访问文件
webSettings.setJavaScriptCanOpenWindowsAutomatically(true); //支持通过JS打开新窗口
webSettings.setLoadsImagesAutomatically(true); //支持自动加载图片
webSettings.setDefaultTextEncodingName("utf-8");//设置编码格式
webSettings.setLayoutAlgorithm(WebSettings.LayoutAlgorithm.SINGLE_COLUMN);//设置布局算法
webSettings.setRenderPriority(WebSettings.RenderPriority.HIGH);//设置渲染等级
mWebView.setInitialScale(30);//设置初始缩放比例
WebViewClient类
- 作用:处理各种通知 & 请求事件
mWebView.setWebViewClient(new WebViewClient() {
//打开网页时不调用系统浏览器, 而是在本WebView中显示;在网页上的所有加载都经过这个方法,这个函数我们可以做很多操作。
//复写shouldOverrideUrlLoading()方法,使得打开网页时不调用系统浏览器, 而是在本WebView中显示
//注意:该方法已被注解为弃用,推荐使用下面的方法
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
view.loadUrl(url);
return true;
}
//上面的方法已被注解为弃用,推荐使用本方法禁用系统的浏览器
@Override
public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
return super.shouldOverrideUrlLoading(view, request);
}
//开始载入页面调用的,我们可以设定一个loading的页面,告诉用户程序在等待网络响应。
@Override
public void onPageStarted(WebView view, String url, Bitmap favicon) {
super.onPageStarted(view, url, favicon);
//设定加载开始的操作
}
//在页面加载结束时调用。我们可以关闭loading条,切换程序动作。
@Override
public void onPageFinished(WebView view, String url) {
super.onPageFinished(view, url);
}
//在加载页面资源时会调用,每一个资源(比如图片)的加载都会调用一次。
@Override
public void onLoadResource(WebView view, String url) {
super.onLoadResource(view, url);
}
//加载页面的服务器出现错误时(如404)调用。
//App里面使用webview控件的时候遇到了诸如404这类的错误的时候,若也显示浏览器里面的那种错误提示页面就显得很丑陋了
//那么这个时候我们的app就需要加载一个本地的错误提示页面,即webview如何加载一个本地的页面
//步骤1:写一个html文件(error_handle.html),用于出错时展示给用户看的提示页面
//步骤2:将该html文件放置到代码根目录的assets文件夹下
//步骤3:复写WebViewClient的onRecievedError方法
//该方法传回了错误码,根据错误类型可以进行不同的错误分类处理
@Override
public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
super.onReceivedError(view, request, error);
case HttpStatus.SC_NOT_FOUND:
view.loadUrl("file:///android_assets/error_handle.html");
break;
}
}
//处理https请求,webView默认是不处理https请求的,页面显示空白,需要进行如下设置
@Override
public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
super.onReceivedSslError(view, handler, error);
handler.proceed();//表示等待证书响应
// handler.cancel();//表示挂起连接,为默认方式
// handler.handleMessage(null);//可做其他处理
// 特别注意:5.1以上默认禁止了 https 和 http混用,以下方式是开启
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
mWebView.getSettings().setMixedContentMode(WebSettings.MIXED_CONTENT_ALWAYS_ALLOW);
}
}
});
WebChromeClient类
- 辅助 WebView 处理 Javascript 的对话框,网站图标,网站标题等等。
mWebView.setWebChromeClient(new WebChromeClient() {
//获得网页的加载进度并显示
@Override
public void onProgressChanged(WebView view, int newProgress) {
super.onProgressChanged(view, newProgress);
if (newProgress < 100) {
//String progress = newProgress + "%";
//progress.setText(progress);
} else {
}
}
//获取Web页中的标题
@Override
public void onReceivedTitle(WebView view, String title) {
super.onReceivedTitle(view, title);
}
//支持javascript的警告框
@Override
public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
new AlertDialog.Builder(SevenDayGameActivity.this)
.setTitle("JsAlert")
.setMessage(message)
.setPositiveButton("OK", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
result.confirm();
}
})
.setCancelable(false)
.show();
return super.onJsAlert(view, url, message, result);
}
//支持javascript的确认框
@Override
public boolean onJsConfirm(WebView view, String url, String message, final JsResult result) {
new AlertDialog.Builder(SevenDayGameActivity.this)
.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 super.onJsConfirm(view, url, message, result);
}
//支持javascript输入框
@Override
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, final JsPromptResult result) {
final EditText et = new EditText(SevenDayGameActivity.this);
et.setText(defaultValue);
new AlertDialog.Builder(SevenDayGameActivity.this)
.setTitle(message)
.setView(et)
.setPositiveButton("OK", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
result.confirm(et.getText().toString());
}
})
.setNegativeButton("Cancel", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
result.cancel();
}
})
.setCancelable(false)
.show();
return super.onJsPrompt(view, url, message, defaultValue, result);
}
});
WebView与JavaScript的交互
Android调用JS(javascript)代码
- WebView的loadUrl()方法
mWebView.loadUrl("javascript:方法名()");
- WebView的evaluateJavascript()方法
mWebView.evaluateJavascript("javascript:方法名()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此处为 js 返回的结果
}
});
}
- 混合使用
因为loadUrl()的执行会使页面刷新,而evaluateJavascript()则不会,同时evaluateJavascript()获取返回值更方便、效率高,但因为后者Android 4.4 后才可使用,故更推荐混合使用
// 因为该方法在 Android 4.4 版本才可使用,所以使用时需进行版本判断
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.KITKAT) {
mWebView.loadUrl("javascript:方法()");
} else {
mWebView.evaluateJavascript("javascript:方法()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此处为 js 返回的结果
}
});
}
JS(javascript)调用Android代码
- 通过WebView的addJavascriptInterface()进行对象映射
- 例如,我们现在想让js调用我们分享微信的方法
- 定义一个与JS对象映射关系的Android类:AndroidtoJs
// 继承自Object类
public class AndroidtoJs extends Object {
// 定义JS需要调用的方必须加入@JavascriptInterface注解
@JavascriptInterface
public void sharedToWXFriend(String msg) {
Log.i("微信分享", msg);
}
}
- 在Android里通过WebView设置Android类与JS代码的映射
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
//AndroidtoJS类对象映射到js的share对象中
mWebView.addJavascriptInterface(new AndroidtoJs(), "share");
- 在js的相关代码中,某个方法可直接调用android的相关方法
function callAndroid(){
// 由于对象映射,所以调用share对象等于调用Android映射的对象
share.sharedToWXFriend("JS调用了Android分享到微信的方法");
}
- AndroidtoJs打印的结果:
System.out: 微信分享:JS调用了Android分享到微信的方法
-
通过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url
-
通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt()方法回调拦截JS对话框alert()、confirm()、prompt() 消息
项目中常遇到的问题
避免WebView内存泄漏
- 不要在xml中直接使用WebView,而是在需要使用WebView的Activity中用代码创建一个,并且Context使用全局的getApplicationContext()
LinearLayout.LayoutParams layoutParams = new LinearLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT);
mWebView = new WebView(getApplicationContext());
mWebView.setLayoutParams(layoutParams);
fl_layout.addView(mWebView);
- 在 Activity 销毁( WebView )的时候,先让 WebView 加载空内容,然后移除 WebView,再销毁 WebView,最后置空。
@Override
protected void onDestroy() {
if (mWebView != null) {
mWebView.loadDataWithBaseURL(null, "", "text/html", "utf-8", null);
mWebView.clearHistory();
((ViewGroup) mWebView.getParent()).removeView(mWebView);
mWebView.destroy();
mWebView = null;
}
super.onDestroy();
}
优秀框架
JsBridge https://github.com/lzyzsd/JsBridge
参考资料
https://www.jianshu.com/p/3c94ae673e2a
https://www.jianshu.com/p/345f4d8a5cfa
作者:Brainbg(白雨)
GitHub:https://github.com/Brainbg
博客:https://www.brainbg.com/
简书:https://www.jianshu.com/u/94518ede7100
优快云:https://blog.youkuaiyun.com/u014720022