加载应用内内容

您可以为您的应用提供基于 Web 的内容（例如 HTML、JavaScript 和 CSS），这些内容会静态编译到应用中，而不是从互联网上获取。

应用内内容不需要互联网访问或消耗用户的带宽。如果内容专门为 WebView 设计（即，它依赖于与原生应用通信），那么用户无法意外地在 Web 浏览器中加载它。

但是，应用内内容也有一些缺点。更新基于 Web 的内容需要发布新的应用更新，并且如果用户拥有过时的应用版本，则网站上的内容与设备上应用中的内容之间可能会出现不匹配的情况。

WebViewAssetLoader

WebViewAssetLoader 是一种灵活且高效的方式，可以在 WebView 对象中加载应用内内容。此类支持以下功能

  • 使用 HTTP(S) URL 加载内容，以与 同源策略 兼容。
  • 加载子资源，例如 JavaScript、CSS、图像和 iframe。

在您的主要活动文件中包含 WebViewAssetLoader。以下是从 assets 文件夹加载简单 Web 内容的示例

Kotlin

private class LocalContentWebViewClient(private val assetLoader: WebViewAssetLoader) : WebViewClientCompat() {
    @RequiresApi(21)
    override fun shouldInterceptRequest(
        view: WebView,
        request: WebResourceRequest
    ): WebResourceResponse? {
        return assetLoader.shouldInterceptRequest(request.url)
    }

    // To support API < 21.
    override fun shouldInterceptRequest(
        view: WebView,
        url: String
    ): WebResourceResponse? {
        return assetLoader.shouldInterceptRequest(Uri.parse(url))
    }
}

Java

private static class LocalContentWebViewClient extends WebViewClientCompat {

    private final WebViewAssetLoader mAssetLoader;

    LocalContentWebViewClient(WebViewAssetLoader assetLoader) {
        mAssetLoader = assetLoader;
    }

    @Override
    @RequiresApi(21)
    public WebResourceResponse shouldInterceptRequest(WebView view,
                                     WebResourceRequest request) {
        return mAssetLoader.shouldInterceptRequest(request.getUrl());
    }

    @Override
    @SuppressWarnings("deprecation") // To support API < 21.
    public WebResourceResponse shouldInterceptRequest(WebView view,
                                     String url) {
        return mAssetLoader.shouldInterceptRequest(Uri.parse(url));
    }
}

您的应用必须配置 WebViewAssetLoader 实例以满足其需求。下一节将提供一个示例。

创建应用内资产和资源

WebViewAssetLoader 依赖于 PathHandler 实例来加载与给定资源路径对应的资源。虽然您可以实现此接口以根据您的应用需要检索资源，但 Webkit 库捆绑了 AssetsPathHandler 和 ResourcesPathHandler 分别用于加载 Android 资产和资源。

要开始，请为您的应用创建资产和资源。通常情况下，以下内容适用

  • 文本文件（如 HTML、JavaScript 和 CSS）位于 assets 中。
  • 图像和其他二进制文件位于 resources 中。

要将基于文本的 Web 文件添加到项目中，请执行以下操作

  1. 在 Android Studio 中，右键单击 app > src > main 文件夹，然后选择 新建 > 目录。
    An image showing Android Studio create-directory menus
    图 1. 为您的项目创建 assets 文件夹。
  2. 将文件夹命名为“assets”。
    An image showing the asset folder
    图 2. 命名 assets 文件夹。
  3. 右键单击 assets 文件夹，然后单击 新建 > 文件。输入 index.html 并按 Return 或 Enter 键。
  4. 重复上一步以创建 stylesheet.css 的空文件。
  5. 使用接下来的两个代码示例中的内容填充您创建的空文件。
```html
<!-- index.html content -->

<html>
  <head>
    <!-- Tip: Use relative URLs when referring to other in-app content to give
              your app code the flexibility to change the scheme or domain as
              necessary. -->
    <link rel="stylesheet" href="/assets/stylesheet.css">
  </head>
  <body>
    <p>This file is loaded from in-app content.</p>
    <p><img src="/res/drawable/android_robot.png" alt="Android robot" width="100"></p>
  </body>
</html>
```

```css
<!-- stylesheet.css content -->

body {
  background-color: lightblue;
}
```

要将基于图像的 Web 文件添加到项目中，请执行以下操作

  1. 将 Android_symbol_green_RGB.png 文件下载到您的本地计算机。

  2. 将文件名重命名为 android_robot.png。

  3. 手动将文件移动到硬盘驱动器上项目中的 main/res/drawable 目录。

图 4 显示了您添加的图像以及应用中呈现的前面代码示例中的文本。

An image showing app rendered output
图 4. 应用内 HTML 文件和图像文件在应用中呈现。

要完成应用，请执行以下操作

  1. 通过将以下代码添加到 onCreate() 方法中来注册处理程序并配置 AssetLoader

    Kotlin

    val assetLoader = WebViewAssetLoader.Builder()
                       .addPathHandler("/assets/", AssetsPathHandler(this))
                       .addPathHandler("/res/", ResourcesPathHandler(this))
                       .build()
webView.webViewClient = LocalContentWebViewClient(assetLoader)

    Java

    final WebViewAssetLoader assetLoader = new WebViewAssetLoader.Builder()
         .addPathHandler("/assets/", new WebViewAssetLoader.AssetsPathHandler(this))
         .addPathHandler("/res/", new WebViewAssetLoader.ResourcesPathHandler(this))
         .build();
mWebView.setWebViewClient(new LocalContentWebViewClient(assetLoader));

  2. 通过将以下代码添加到 onCreate() 方法中来加载内容

    Kotlin

    webView.loadUrl("https://appassets.androidplatform.net/assets/index.html")

    Java

    mWebView.loadUrl("https://appassets.androidplatform.net/assets/index.html");

将应用内内容与网站上的资源混合

您的应用可能需要加载应用内内容和来自互联网的内容的混合，例如由您网站的 CSS 样式化的应用内 HTML 页面。WebViewAssetLoader 支持此用例。如果注册的 PathHandler 实例均无法找到给定路径的资源，则 WebView 将回退到从互联网加载内容。如果您将应用内内容与网站上的资源混合，请为应用内资源保留目录路径，例如 /assets/ 或 /resources/。避免将网站上的任何资源存储在这些位置。

Kotlin

val assetLoader = WebViewAssetLoader.Builder()
                        .setDomain("example.com") // Replace this with your website's domain.
                        .addPathHandler("/assets/", AssetsPathHandler(this))
                        .build()

webView.webViewClient = LocalContentWebViewClient(assetLoader)
val inAppHtmlUrl = "https://example.com/assets/index.html"
webView.loadUrl(inAppHtmlUrl)
val websiteUrl = "https://example.com/website/data.json"

// JavaScript code to fetch() content from the same origin.
val jsCode = "fetch('$websiteUrl')" +
        ".then(resp => resp.json())" +
        ".then(data => console.log(data));"

webView.evaluateJavascript(jsCode, null)

Java

final WebViewAssetLoader assetLoader = new WebViewAssetLoader.Builder()
           .setDomain("example.com") // Replace this with your website's domain.
           .addPathHandler("/assets/", new AssetsPathHandler(this))
           .build();

mWebView.setWebViewClient(new LocalContentWebViewClient(assetLoader));
String inAppHtmlUrl = "https://example.com/assets/index.html";
mWebView.loadUrl(inAppHtmlUrl);
String websiteUrl = "https://example.com/website/data.json";

// JavaScript code to fetch() content from the same origin.
String jsCode = "fetch('" + websiteUrl + "')" +
      ".then(resp => resp.json())" +
      ".then(data => console.log(data));";

mWebView.evaluateJavascript(jsCode, null);

有关应用内 HTML 页面获取 Web 托管 JSON 数据的示例，请参阅 WebView GitHub 上的演示。

loadDataWithBaseURL

当您的应用只需要加载 HTML 页面并且不需要拦截子资源时，请考虑使用 loadDataWithBaseURL()，它不需要应用资产。您可以按照以下代码示例所示使用它

Kotlin

val html = "<html><body><p>Hello world</p></body></html>"
val baseUrl = "https://example.com/"

webView.loadDataWithBaseURL(baseUrl, html, "text/html", null, baseUrl)

Java

String html = "<html><body><p>Hello world</p></body></html>";
String baseUrl = "https://example.com/";

mWebView.loadDataWithBaseURL(baseUrl, html, "text/html", null, baseUrl);

谨慎选择参数值。请考虑以下几点

  • baseUrl：这是 HTML 内容加载到的 URL。这必须是 HTTP(S) URL。
  • data：这是您要显示的 HTML 内容，以字符串形式表示。
  • mimeType：这通常必须设置为 text/html。
  • encoding：当 baseUrl 为 HTTP(S) URL 时，此参数未使用，因此可以设置为 null。
  • historyUrl：此参数设置为与 baseUrl 相同的值。

我们强烈建议使用 HTTP(S) URL 作为 baseUrl，因为这有助于确保您的应用符合同源策略。

如果您无法为您的内容找到合适的 baseUrl 并更愿意使用 loadData()，则**必须使用** 百分比编码 或 Base64 编码**对内容进行编码。我们强烈建议选择 Base64 编码并使用 Android API 以编程方式进行编码，如以下代码示例所示

Kotlin

val encodedHtml: String = Base64.encodeToString(html.toByteArray(), Base64.NO_PADDING)

webView.loadData(encodedHtml, mimeType, "base64")

Java

String encodedHtml = Base64.encodeToString(html.getBytes(), Base64.NO_PADDING);

mWebView.loadData(encodedHtml, mimeType, "base64");

避免的事项

还有其他几种加载应用内内容的方法，但我们强烈建议不要使用它们