使用 Jetpack Webkit 简化 WebView 实现

本指南介绍了 Jetpack Webkit 库的优势、工作原理以及如何在项目中实现该库。

概览

WebView 是 Android 开发的重要组成部分，但由于不同 Android OS 版本之间的功能不一致，有时很难管理。每个 Android 操作系统版本都提供一组固定的 WebView API。由于 Android 的发布节奏比 WebView 慢，因此 Android API 可能无法涵盖所有可用的 WebView 功能。这会导致功能推出速度变慢，并增加测试费用。

Jetpack Webkit 通过充当兼容性层并利用用户设备上最新的 WebView APK 来解决这些问题。它还包含仅在此库中提供的新型现代 API。

为何使用 Jetpack Webkit？

除了提供跨版本兼容性之外，Jetpack Webkit 还提供新的现代 API，可简化开发并改进应用的功能：

了解组件

如需有效使用 Jetpack Webkit，您必须了解以下组件之间的关系：

  • Android System WebView：这是基于 Chromium 的渲染引擎，Google 会通过 Google Play 商店定期更新它，更新频率与 Chrome 相同。它包含最新的功能，并为所有 WebView API 提供底层实现代码。

  • 框架 API (android.webkit)：这些 API 固定到特定的 Android OS 版本。例如，Android 10 上的应用只能访问该版本发布时可用的 API。因此，它无法使用最近更新中添加到 WebView APK 的新功能。例如，如需通过 WebView#getWebViewRenderProcess() 获取无响应渲染器的句柄，您只能在 Android 10 及更高版本上调用此方法。

  • Jetpack Webkit 库 (androidx.webkit)：这是捆绑在应用中的一个小库。此库充当调用 WebView APK 的桥梁，而不是调用 Android 平台中定义的 API，而 Android 平台的操作系统版本是固定的。这样一来，即使应用安装在搭载旧版操作系统（例如 Android 10）的设备上，也可以使用最新的 WebView 功能。例如，WebViewCompat.getWebViewRenderProcess() 的工作方式与框架 API 类似，但它也可以在 Android 10 之前的所有操作系统版本上调用。

如果某个 API 同时在框架和 Jetpack Webkit 中提供，我们建议您选择 Jetpack Webkit 版本。这有助于确保应用在最大范围的设备上保持一致的行为和兼容性。

Jetpack Webkit 和 APK 交互

Jetpack Webkit 中的 API 分为两部分实现：

  • 静态 Jetpack Webkit：静态 Jetpack Webkit 库包含负责实现 API 的少量代码。

  • WebView APK：WebView APK 包含大部分代码。

您的应用调用 Jetpack Webkit API，然后该 API 调用 WebView APK。

虽然您可以控制应用中的 Jetpack Webkit 版本，但无法控制用户设备上的 WebView APK 更新。一般来说，大多数用户都拥有最新版本的 WebView APK，但您的应用仍必须谨慎，不要调用特定版本的 WebView APK 不支持的 API。

Jetpack Webkit 还抽象化了手动检查 WebView 版本的需求。如需确定某项功能是否可用，请检查其功能常量。例如，WebViewFeature.WEB_AUTHENTICATION。

两者如何协同发挥作用

Jetpack Webkit 弥合了静态框架 API 与频繁更新的 WebView APK 之间的差距。当您将 Jetpack Webkit API 与功能检测模式搭配使用时，该库会执行检查，以确定用户设备上安装的 WebView APK 是否支持相应功能。这样一来，您就不需要检查 Android 操作系统（框架）版本了。

如果 WebView APK 的版本足够新，该库会调用相应功能。 否则，它会报告该功能不可用，从而防止应用崩溃，并让您能够妥善处理这种情况。

比较 Jetpack Webkit 和框架 API

本部分将比较使用和不使用 Jetpack Webkit 库的实现方法：

启用高级身份验证 (WebAuthn)

不使用 Jetpack Webkit

无法通过框架 API 实现。

使用 Jetpack Webkit

利用 WebViewFeature.WEB_AUTHENTICATION 进行兼容性检查。

if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_AUTHENTICATION)) {
  WebSettingsCompat.setWebAuthenticationSupport(
      webView.settings,
      WebSettingsCompat.WEB_AUTHENTICATION_SUPPORT_FOR_APP
  )
}

删除来源（特定于网站的存储空间）的数据

不使用 Jetpack WebKit

没有可用于清除特定来源数据的直接 API。通常需要清除所有数据。

使用 Jetpack WebKit

使用兼容性 API 进行精确的数据删除。您可以使用以下任一选项：

WebStorageCompat.getInstance().deleteBrowsingData()

或

WebStorageCompat.getInstance().deleteBrowsingDataForSite()

获取 WebView 版本

不使用 Jetpack WebKit

使用标准框架类。

val webViewPackage = WebView.getCurrentWebViewPackage()

使用 Jetpack WebKit

使用兼容性层进行更安全的检索。

val webViewPackage = WebViewCompat.getCurrentWebViewPackage()

处理无响应的渲染器（渲染器客户端）

不使用 Jetpack WebKit

使用标准框架方法。

webView.setWebViewRenderProcessClient(myClient)

使用 Jetpack WebKit

使用 WebViewCompat 和功能检查来设置客户端。

if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_VIEW_RENDERER_CLIENT_BASIC_USAGE)) {
  WebViewCompat.setWebViewRenderProcessClient(webView, myClient)
}

如需了解详情，请参阅 androidx.webkit 参考文档。

将 Jetpack Webkit 集成到您的代码中

使用 Jetpack Webkit 可增强标准 WebView 类的功能，但不会完全取代原始 WebView 类。

您可以继续使用 android.webkit.WebView 类。您可以将其添加到 XML 布局中，并在代码中获取对该实例的引用。如需访问标准框架功能，您仍然可以直接对 WebView 实例或其设置对象调用方法。

如需访问现代功能，您可以使用 Jetpack Webkit 提供的静态辅助方法，例如 WebViewCompat 和 WebSettingsCompat。您需要将现有的 WebView 实例传递给这些方法。

Kotlin

import android.webkit.WebView
import androidx.webkit.WebSettingsCompat
import androidx.webkit.WebViewFeature

// You still get your WebView instance the standard way.
val webView: WebView = findViewById(R.id.my_webview)

// To enable a modern feature, you pass that instance to a Jetpack Webkit helper.
if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
    WebSettingsCompat.setForceDark(webView.settings, WebSettingsCompat.FORCE_DARK_ON)
}

Java

import android.webkit.WebView;
import androidx.webkit.WebSettingsCompat;
import androidx.webkit.WebViewFeature;

// You still get your WebView instance the standard way.
WebView webView = findViewById(R.id.my_webview);

// To enable a modern feature, you pass that instance to a Jetpack Webkit helper.
if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
    WebSettingsCompat.setForceDark(webView.settings, WebSettingsCompat.FORCE_DARK_ON);
}

实现 Jetpack Webkit

如需实现 Jetpack Webkit，请按照以下步骤操作。

第 1 步：添加依赖项

在模块的 build.gradle.kts 或 build.gradle 文件中，添加以下依赖项以添加 Jetpack Webkit：

Groovy

dependencies {
    implementation "androidx.webkit:webkit:1.14.0"
}

Kotlin

dependencies {
    implementation("androidx.webkit:webkit:1.14.0")
}

Jetpack Webkit 包含精简的封装容器，因此对应用大小的影响极小。

第 2 步：采用功能检测模式

为防止在调用不可用的 API 时发生崩溃，请使用功能检查。建议您在每次调用 API 时都进行功能检查，并考虑在 API 不可用时使用回退逻辑。

我们建议采用以下模式来使用现代 WebView API：

import android.webkit.WebView
import androidx.webkit.WebSettingsCompat
import androidx.webkit.WebViewFeature

// In your Kotlin code where you configure your WebView
val webView: WebView = findViewById(R.id.my_webview)

// Before you use a modern API, first check if it is supported.
if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
    // If the check passes, it is safe to call the API.
    WebSettingsCompat.setForceDark(webView.settings, WebSettingsCompat.FORCE_DARK_ON)
} else {
    // Optionally, provide a fallback for older WebView versions.
}

此模式有助于确保应用具有较高的可靠性。由于功能检查先运行，因此如果功能不可用，应用不会崩溃。WebViewFeature#isFeatureSupported() 检查的性能开销可忽略不计。