Android WebView 详解 1 android webview使用

相关API

相关类介绍

WebResourceRequest 添加于API21，封装了一个Web资源的请求信息，包含：请求地址，请求方法，请求头，是否主框架，是否用户点击，是否重定向

WebResourceResponse 封装了一个Web资源的响应信息，包含：响应数据流，编码，MIME类型，API21后添加了响应头，状态码与状态描述

WebResourceError 添加于API23，封装了一个Web资源的错误信息，包含错误码和描述

CookieManager 管理用于WebView的cookies。。

WebViewDatabase 存储与管理以下几类浏览数据：

表单自动填充的的用户名与密码

HTTP认证的用户名与密码

曾经输入过的文本(比如自动完成)

WebStorage 用于管理WebView提供的JS存储API，比如Application Cache API，Web SQL Database API，HTML5 Web Storage API

GeolocationPermissions 用于管理WebView的JS Geolocation API

HttpAuthHandler 表示一个HTTP认证请求，提供了方法操作(proceed/cancel)请求

SslErrorHandler 表示一个处理SSL错误的请求，提供了方法操作(proceed/cancel)请求

ClientCertRequest 表示一个证书请求，提供了方法操作(proceed/cancel/ignore)请求

JsResult 用于处理底层JS发起的请求，为客户端提供一些方法指明应进行的操作，比如确认或取消。

WebView

基本

// 获取当前页面的URL

public String getUrl();

// 获取当前页面的原始URL(重定向后可能当前url不同)

// 就是http headers的Referer参数，loadUrl时为null

public String getOriginalUrl();

// 获取当前页面的标题

public String getTitle();

// 获取当前页面的favicon

public Bitmap getFavicon();

// 获取当前页面的加载进度

public int getProgress();

// 通知WebView内核网络状态

// 用于设置JS属性`window.navigator.isOnline`和产生HTML5事件`online/offline`

public void setNetworkAvailable(boolean networkUp)

// 设置初始缩放比例

public void setInitialScale(int scaleInPercent)；

加载网页

// 加载URL指定的网页

public void loadUrl(String url);

// 携带http headers加载URL指定的网页

public void loadUrl(String url, Map<String, String> additionalHttpHeaders);

// 使用POST请求加载指定的网页

public void postUrl(String url, byte[] postData);

// 重新加载当前网页

public void reload();

// 加载内容

public void loadData(String data, String mimeType, String encoding);

// 使用baseUrl加载内容

public void loadDataWithBaseURL(String baseUrl, String data, String mimeType, String encoding, String historyUrl);

Javascript

// 注入Javascript对象

public void addJavascriptInterface(Object object, String name);

// 移除已注入的Javascript对象，下次加载或刷新页面时生效

public void removeJavascriptInterface(String name);

// 对传入的JS表达式求值，通过resultCallback返回结果

// 此函数添加于API19，必须在UI线程中调用，回调也将在UI线程

public void evaluateJavascript(String script, ValueCallback<String> resultCallback)

导航(前进后退)

// 复制一份BackForwardList

public WebBackForwardList copyBackForwardList();

// 是否可后退

public boolean canGoBack();

// 是否可前进

public boolean canGoForward();

// 是否可前进/后退steps页，大于0表示前进小于0表示后退

public boolean canGoBackOrForward(int steps);

// 后退一页

public void goBack();

// 前进一页

public void goForward();

// 前进/后退steps页，大于0表示前进小于0表示后退

public void goBackOrForward(int steps);

// 清除当前webview访问的历史记录

public void clearHistory();

网页查找功能

// 设置网页查找结果回调

public void setFindListener(FindListener listener);

// 异步执行查找网页内包含的字符串并设置高亮，查找结果会回调.

public void findAllAsync (String find);

// 查找下一个匹配的字符串

public void findNext (boolean forward);

// 清除网页查找的高亮匹配字符串

public void clearMatches();

截屏/翻页/缩放

// 保存网页(.html)到指定文件

public void saveWebArchive(String filename);

// 保存网页(.html)到文件

public void saveWebArchive(String basename, boolean autoname, ValueCallback<String> callback)；

// 上翻一页，即向上滚动WebView高度的一半

public void pageUp(boolean top);

// 下翻一页，即向下滚动WebView高度的一半

public void pageDown(boolean bottom);

// 缩放

public void zoomBy(float factor);

// 放大

public boolean zoomIn();

// 缩放

public boolean zoomOut();

其它

// 清除网页缓存，由于内核缓存是全局的因此这个方法不仅仅针对webview而是针对整个应用程序

public void clearCache(boolean includeDiskFiles);

// 清除自动完成填充的表单数据

public void clearFormData();

// 清除SSL偏好

public void clearSslPreferences();

// 查询文档中是否有图片，查询结果将被发送到msg.getTarget()

// 如果包含图片，msg.arg1 为1，否则为0

public void documentHasImages(Message msg);

// 请求最近轻叩(tapped)的 锚点/图像 元素的URL，查询结果将被发送到msg.getTarget()

// msg.getData()中的url是锚点的href属性，title是锚点的文本，src是图像的src

public void requestFocusNodeHref(Message msg);

// 请求最近触摸(touched)的 图像元素的URL，查询结果将被发送到msg.getTarget()

// msg.getData()中的url是图像链接

public void requestImageRef(Message msg)

// 清除证书请求偏好，添加于API21

// 在WebView收到`android.security.STORAGE_CHANGED` Intent时会自动清除

public static void clearClientCertPreferences(Runnable onCleared)

// 开启网页内容(js,css,html...)调试模式，添加于API19

public static void setWebContentsDebuggingEnabled(boolean enabled)

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);

// 是否使用overview mode加载页面，默认值 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());

通常大部分保持默认值就好了

WebSettings settings = web.getSettings();

// 缓存(cache)

settings.setAppCacheEnabled(true); // 默认值 false

settings.setAppCachePath(context.getCacheDir().getAbsolutePath());

// 存储(storage)

settings.setDomStorageEnabled(true); // 默认值 false

settings.setDatabaseEnabled(true); // 默认值 false

// 是否支持viewport属性，默认值 false

// 页面通过`<meta name="viewport" ... />`自适应手机屏幕

settings.setUseWideViewPort(true);

// 是否使用overview mode加载页面，默认值 false

// 当页面宽度大于WebView宽度时，缩小使页面宽度等于WebView宽度

settings.setLoadWithOverviewMode(true);

// 是否支持Javascript，默认值false

settings.setJavaScriptEnabled(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 (isNetworkConnected(context)) {

// 根据cache-control决定是否从网络上取数据

settings.setCacheMode(WebSettings.LOAD_DEFAULT);

} else {

// 没网，离线加载，优先加载缓存(即使已经过期)

settings.setCacheMode(WebSettings.LOAD_CACHE_ELSE_NETWORK);

}

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 void onFormResubmission(WebView view, Message dontResend, Message resend) {

dontResend.sendToTarget();

}

// 通知应用可以将当前的url存储在数据库中，意味着当前的访问url已经生效并被记录在内核当中。

// 此方法在网页加载过程中只会被调用一次，网页前进后退并不会回调这个函数。

public void doUpdateVisitedHistory(WebView view, String url, boolean isReload) {

}

// 加载资源时发生了一个SSL错误，应用必需响应(继续请求或取消请求)

// 处理决策可能被缓存用于后续的请求，默认行为是取消请求

public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {

handler.cancel();

}

// 此方法添加于API21，在UI线程被调用

// 处理SSL客户端证书请求，必要的话可显示一个UI来提供KEY。

// 有三种响应方式：proceed()/cancel()/ignore()，默认行为是取消请求

// 如果调用proceed()或cancel()，Webview 将在内存中保存响应结果且对相同的"host:port"不会再次调用 onReceivedClientCertRequest

[待续]