基本使用
1.WebView设置
// 获取当前页面的
URLpublic String getUrl();
// 获取当前页面的原始 URL(重定向后可能当前 url 不 同)
// 就是 http headers 的 Referer 参数,loadUrl 时为 null
public String getOriginalUrl();
// 获 取当前页面的标题
public String getTitle();
// 获取当前页面的
faviconpublic Bitmap getFavicon();
// 获取当前页面的加载进度
public int getProgress();
// 通知 WebView 内核网络状态
// 用于设置 JS 属性`window.navigator.isOnline`和产生 HTML5 事件 `online/offline`
public void setNetworkAvailable(boolean networkUp)
// 设置初始缩放比例
public void setInitialScale(int scaleInPercent);
2.WebSettings设置
WebSettings settings = web.getSettings();
// 存储(storage)
// 启用 HTML5 DOM storage API,默认值 false
settings.setDomStorageEnabled(true);
// 启用 Web SQL Database API,这个设置会影响同一进程内 的所有 WebView,默认值 false
// 此 API 已不推荐使用,参考:https://www.w3.org/TR/webdatabase/
settings.setDatabaseEnabled(true);
// 启用 Application Caches API,必需设置有效的缓存路径才 能生效,默认值 false
// 此 API 已废弃,参考: https://developer.mozilla.org/zh-CN/docs/Web/HTML/Using_the_application_cache
settings.setAppCacheEnabled(true);
settings.setAppCachePath(context.getCacheDir().getAbsolutePath());
// 定位(location)
settings.setGeolocationEnabled(true);
// 是否保存表单数据
settings.setSaveFormData(true);
// 是否当webview调用requestFocus时为页面的某个元素设置焦点, 默认值 true
settings.setNeedInitialFocus(true);
// 是否支持 viewport 属性,默认值 false// 页面通过`<meta name="viewport" ... />`自适应手机屏幕
settings.setUseWideViewPort(true);
// 是否使用 overviewmode 加载页面,默认值 false// 当页面宽 度大于 WebView 宽度时,缩小使页面宽度等于 WebView 宽度
settings.setLoadWithOverviewMode(true);
// 布局算法
settings.setLayoutAlgorithm(WebSettings.LayoutAlgorithm.NORMAL);
// 是否支持 Javascript,默认值 false
settings.setJavaScriptEnabled(true);
// 是否支持多窗口,默认值 false
settings.setSupportMultipleWindows(false);
// 是否可用 Javascript(window.open)打开窗口,默认 值 false
settings.setJavaScriptCanOpenWindowsAutomatically(false);
// 资源访问
settings.setAllowContentAccess(true);
// 是否可访问 Content Provider 的资源,默认值 true
settings.setAllowFileAccess(true);
// 是否可访问本地文件,默认值 true
// 是否允许通过 file url 加载的 Javascript 读取本地文件,默认值 false
settings.setAllowFileAccessFromFileURLs(false);
// 是否允许通过 file url 加载的 Javascript 读取全部资源(包括文件,http,https),默认值 false
settings.setAllowUniversalAccessFromFileURLs(false);
// 资源加载
settings.setLoadsImagesAutomatically(true);
// 是否自动加载图片
settings.setBlockNetworkImage(false);
// 禁止加载网络图片
settings.setBlockNetworkLoads(false);
// 禁止加载所有网络资源
// 缩放(zoom)
settings.setSupportZoom(true);
// 是否支持缩放
settings.setBuiltInZoomControls(false);
// 是否使用内置缩放机制
settings.setDisplayZoomControls(true);
// 是否显示内置缩放控件
// 默认文本编码,默认值 "UTF-8"
settings.setDefaultTextEncodingName("UTF-8");
settings.setDefaultFontSize(16);
// 默认文字尺寸,默认值 16,取值范围 1-72
settings.setDefaultFixedFontSize(16);
// 默认等宽字体尺寸,默认值 16
settings.setMinimumFontSize(8);
// 最小文字尺寸,默认值 8
settings.setMinimumLogicalFontSize(8);
// 最小文字逻辑尺寸,默认值 8
settings.setTextZoom(100);
// 文字缩放百分比,默认值 100
// 字体
settings.setStandardFontFamily("sans-serif");
// 标准字体,默认值 "sans-serif"
settings.setSerifFontFamily("serif");
// 衬线字体,默认值 "serif"
settings.setSansSerifFontFamily("sans-serif");
// 无衬线字体,默认值 "sans-serif"
settings.setFixedFontFamily("monospace");
// 等宽字体,默认值 "monospace"
settings.setCursiveFontFamily("cursive");
// 手写体(草书),默认值 "cursive"
settings.setFantasyFontFamily("fantasy");
// 幻想体,默认值 "fantasy"
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
// 用户是否需要通过手势播放媒体(不会自动播放),默认值 true
settings.setMediaPlaybackRequiresUserGesture(true);
}
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
// 5.0 以上允许加载 http 和 https 混合的页面(5.0 以下默认允许,5.0+默认禁止)
settings.setMixedContentMode(WebSettings.MIXED_CONTENT_ALWAYS_ALLOW);
}
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
// 是否在离开屏幕时光栅化(会增加内存消耗),默认值 false
settings.setOffscreenPreRaster(false);
}
if (isNetworkConnected(context)) {
// 根据 cache-control 决定是否从网络上取数据
settings.setCacheMode(WebSettings.LOAD_DEFAULT);
} else {
// 没网,离线加载,优先加载缓存(即使已经过期)
settings.setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK);
}
// deprecated
settings.setRenderPriority(WebSettings.RenderPriority.HIGH);
settings.setDatabasePath(context.getDir("database", Context.MODE_PRIVATE).getPath());
settings.setGeolocationDatabasePath(context.getFilesDir().getPath());
3.WebViewClient设置
// 拦截页面加载,返回 true 表示宿主 app 拦截并处理了该 url,否则返回 false 由当前 WebView 处理
// 此 方法在 API24 被废弃,不处理 POST 请求
public boolean shouldOverrideUrlLoading(WebView view, String url) {
return false;
}
// 拦截页面加载,返回 true 表示宿主 app 拦截并处理了该 url,否则返回 false 由当前 WebView 处理
// 此 方法添加于 API24,不处理 POST 请求,可拦截处理子 frame 的非 http 请求
@TargetApi(Build.VERSION_CODES.N)
public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
return shouldOverrideUrlLoading(view, request.getUrl().toString());
}
// 此方法废弃于 API21,调用于非 UI 线程
// 拦截资源请求并返回响应数据,返回 null 时 WebView 将继续加 载资源
public WebResourceResponse shouldInterceptRequest(WebView view, String url) {
return null;
}
// 此方法添加于 API21,调用于非 UI 线程
// 拦截资源请求并返回数据,返回 null 时 WebView 将继续加载资 源
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest request) {
return shouldInterceptRequest(view, request.getUrl().toString());
}
// 页面(url)开始加载
public void onPageStarted(WebView view, String url, Bitmap favicon) {}
// 页面(url)完成加载
public void onPageFinished(WebView view, String url) {}
// 将要加载资源(url)
public void onLoadResource(WebView view, String url) {}
// 这个回调添加于 API23,仅用于主框架的导航
// 通知应用导航到之前页面时,其遗留的 WebView 内容将不 再被绘制。
// 这个回调可以用来决定哪些 WebView 可见内容能被安全地回收,以确保不显示陈旧的内容
// 它 最早被调用,以此保证 WebView.onDraw 不会绘制任何之前页面的内容,随后绘制背景色或需要加载的新内容。
// 当 HTTP 响应 body 已经开始加载并体现在 DOM 上将在随后的绘制中可见时,这个方法会被调用。
// 这个回 调发生在文档加载的早期,因此它的资源(css,和图像)可能不可用。
// 如果需要更细粒度的视图更新,查看 postVisualStateCallback(long, WebView.VisualStateCallback).
// 请注意这上边的所有条件也支持
postVisualStateCallback(long, WebView.VisualStateCallback)
public void onPageCommitVisible(WebView view, String url) {}
// 此方法废弃于 API23
// 主框架加载资源时出错
public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) {}
// 此方法添加于 API23
// 加载资源时出错,通常意味着连接不到服务器
// 由于所有资源加载错误都会调用此 方法,所以此方法应尽量逻辑简单
@TargetApi(Build.VERSION_CODES.M)
public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
if (request.isForMainFrame()) {
onReceivedError(view, error.getErrorCode(), error.getDescription().toString(), request.getUrl().toString());
}
}
// 此方法添加于 API23
// 在加载资源(iframe,image,js,css,ajax...)时收到了 HTTP 错误(状态 码>=400)
public void onReceivedHttpError(WebView view, WebResourceRequest request, WebResourceResponse errorResponse) {}
// 是否重新提交表单,默认不重发
public voidonFormResubmission(WebView view, Message dontResend, Message resend) {
dontResend.sendToTarget();
}
// 通知应用可以将当前的 url 存储在数据库中,意味着当前的访问 url 已经生效并被记录在内核当中。
// 此 方法在网页加载过程中只会被调用一次,网页前进后退并不会回调这个函数。
public void doUpdateVisitedHistory(WebView view, String url, boolean isReload) {}
// 加载资源时发生了一个 SSL 错误,应用必需响应(继续请求或取消请求)
// 处理决策可能被缓存用于后续的 请求,默认行为是取消请求
public void onReceivedSslError(WebViewview, SslErrorHandlerhandler, SslError error) {
handler.cancel();
}
// 此方法添加于 API21,在 UI 线程被调用
// 处理 SSL 客户端证书请求,必要的话可显示一个 UI 来提供 KEY。
// 有三种响应方式:proceed()/cancel()/ignore(),默认行为是取消请求
// 如果调用 proceed()或 cancel(),Webview 将在内存中保存响应结果且对相同的"host:port"不会再次调用 onReceivedClientCertRequest
// 多数情况下,可通过 KeyChain.choosePrivateKeyAlias 启动一个 Activity 供用户选择合适的私钥
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public void onReceivedClientCertRequest(WebView view, ClientCertRequest request) {
request.cancel();
}
// 处理 HTTP 认证请求,默认行为是取消请求
public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
handler.cancel();
}
// 通知应用有个已授权账号自动登陆了
public void onReceivedLoginRequest(WebView view, String realm, String account, String args) {}
// 给应用一个机会处理按键事件
// 如果返回 true,WebView 不处理该事件,否则 WebView 会一直处理,默 认返回 false
public boolean shouldOverrideKeyEvent(WebView view, KeyEvent event) {
return false;
}
// 处理未被 WebView 消费的按键事件
// WebView 总是消费按键事件,除非是系统按键或 shouldOverrideKeyEvent 返回 true
// 此方法在按键事件分派时被异步调用
public void onUnhandledKeyEvent(WebView view, KeyEvent event) {
super.onUnhandledKeyEvent(view, event);
}
// 通知应用页面缩放系数变化
public void onScaleChanged(WebView view, float oldScale, float newScale) {}
4. WebChromeClient设置
// 获得所有访问历史项目的列表,用于链接着色。
public void getVisitedHistory(ValueCallback < String[] > callback) {}
// <video /> 控件在未播放时,会展示为一张海报图,HTML 中可通过它的'poster'属性来指定。
// 如果未 指定'poster'属性,则通过此方法提供一个默认的海报图。
public Bitmap getDefaultVideoPoster() {
return null;
}
// 当全屏的视频正在缓冲时,此方法返回一个占位视图(比如旋转的菊花)。
public View getVideoLoadingProgressView() {
return null;
}
// 接收当前页面的加载进度
public void onProgressChanged(WebView view, int newProgress) {}
// 接收文档标题
public void onReceivedTitle(WebView view, String title) {}
// 接收图标(favicon)
public void onReceivedIcon(WebView view, Bitmap icon) {}
// Android 中处理 Touch Icon 的方案
// http://droidyue.com/blog/2015/01/18/deal-with-touch-icon-in-android/index.html
public void onReceivedTouchIconUrl(WebView view, String url, boolean precomposed) {}
// 通知应用当前页进入了全屏模式,此时应用必须显示一个包含网页内容的自定义 View
public void onShowCustomView(View view, CustomViewCallback callback) {}
// 通知应用当前页退出了全屏模式,此时应用必须隐藏之前显示的自定义 View
public void onHideCustomView() {}
// 显示一个 alert 对话框
public boolean onJsAlert(WebView view, String url, String message, JsResult result) {
return false;
}
// 显示一个 confirm 对话框
public boolean onJsConfirm(WebViewview, Stringurl, Stringmessage, JsResult result) {
return false;
}
// 显示一个 prompt 对话框
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
return false;
}
// 显示一个对话框让用户选择是否离开当前页面
public boolean onJsBeforeUnload(WebView view, String url, String message, JsResult result) {
return false;
}
// 指定源的网页内容在没有设置权限状态下尝试使用地理位置 API。
// 从 API24 开始,此方法只为安全的源 (https)调用,非安全的源会被自动拒绝
public void onGeolocationPermissionsShowPrompt(String origin, GeolocationPermissions.Callback callback) {}
// 当前一个调用 onGeolocationPermissionsShowPrompt() 取消时,隐藏相关的 UI。
public void onGeolocationPermissionsHidePrompt() {}
// 通知应用打开新窗口
public boolean onCreateWindow(WebView view, boolean isDialog, boolean isUserGesture, Message resultMsg) {
return false;
}
// 通知应用关闭窗口
public void onCloseWindow(WebView window) {}
// 请求获取取焦点
public void onRequestFocus(WebView view) {}
// 通知应用网页内容申请访问指定资源的权限(该权限未被授权或拒 绝)
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public void onPermissionRequest(PermissionRequest request) {
request.deny();
}
// 通知应用权限的申请被取消,隐藏相关的 UI。
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public void onPermissionRequestCanceled(PermissionRequest request) {}
// 为'<input type="file" />'显示文件选择器,返回 false 使用默认处理
@TargetApi(Build.VERSION_CODES.LOLLIPOP)
public boolean onShowFileChooser(WebView webView, ValueCallback < Uri[] > filePathCallback, FileChooserParams fileChooserParams) {
return false;
}
// 接收 JavaScript 控制台消息
public boolean onConsoleMessage(ConsoleMessage consoleMessage) {
return false;
}
Webview 加载优化
- 使用本地资源替代
可以将一些资源文件放在本地的 assets 目录, 然后重写 WebViewClient
的 shouldInterceptRequest 方法,对访问地址进行拦截,当 url 地址命中本地配置的 url 时,使用本地资源替代,否则就使用网络上的资源。
mWebview.setWebViewClient(new WebViewClient() {
// 设置不用系统浏览器打开,
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
view.loadUrl(url);
return true;
}
@Override
public WebResourceResponse shouldInterceptRequest(WebView view, String url) { // 如 果命中本地资源, 使用本地资源替代
if (mDataHelper.hasLocalResource(url)) {
WebResourceResponse response = mDataHelper.getReplacedWebResourceResponse(ge tApplicationContext(), url);
if (response != null) {
return response;
}
}
return super.shouldInterceptRequest(view, url);
}
@TargetApi(VERSION_CODES.LOLLIPOP) @Override
public WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest reques t) {
String url = request.getUrl().toString();
if (mDataHelper.hasLocalResource(url)) {
WebResourceResponse response = mDataHelper.getReplacedWebResourceResponse(getApplicatio nContext(), url);
if (response != null) {
return response;
}
}
return super.shouldInterceptRequest(view, request);
}
});
- WebView 初始化慢,可以在初始化同时先请求数据,让后端和网络不要闲着;
- 后端处理慢,可以让服务器分 trunk 输出,在后端计算的同时前端也加载网络静态资源;
- 脚本执行慢,就让脚本在最后运行,不阻塞页面解析;
- 同时,合理的预加载、预缓存可以让加载速度的瓶颈更小;
- WebView 初始化慢,就随时初始化好一个 WebView 待用;
- DNS 和链接慢,想办法复用客户端使用的域名和链接;
- 脚本执行慢,可以把框架代码拆分出来,在请求页面之前就执行好。
内存泄漏
直接 new WebView 并传入 application context 代替在 XML 里面声明以防止 activity 引用被滥用,能解决 90+%的 WebView 内存泄漏。
vWeb = new WebView(getContext().getApplicationContext());
container.addView(vWeb);
销毁 WebView
if (vWeb != null) {
vWeb.setWebViewClient(null);
vWeb.setWebChromeClient(null);
vWeb.loadDataWithBaseURL(null, "", "text/html", "utf-8", null);
vWeb.clearHistory();
((ViewGroup) vWeb.getParent()).removeView(vWeb);
vWeb.destroy();
vWeb = null;
}