跳到主内容

Android 和 Web 的延迟组件

如何创建延迟组件以提高下载性能。

介绍

#

使用 Flutter，Android 和 Web 应用能够下载延迟组件（额外的代码和资源），而应用已经在运行。如果您的应用很大，并且只想在用户需要时才安装组件，这将很有帮助。

虽然 Flutter 支持 Android 和 Web 上的延迟加载，但实现方式不同。两者都需要 Dart 的延迟导入。

  • Android 的 动态功能模块 将延迟组件作为 Android 模块打包提供。

    在构建 Android 应用时，虽然您可以延迟加载模块，但必须构建整个应用并将其作为单个 Android 应用包 (AAB) 上传。Flutter 不支持重新上传整个应用程序的新 Android 应用包而不进行部分更新。

    当您在 发布或分析模式 下编译 Android 应用时，Flutter 会执行延迟加载，但调试模式会将所有延迟组件视为常规导入。

  • Web 将延迟组件创建为单独的 *.js 文件。

要深入了解此功能的具体技术细节，请参阅 Deferred Components 在 Flutter wiki 上的内容。

如何为 Android 项目设置延迟组件

#

以下说明介绍了如何为延迟加载设置 Android 应用。

步骤 1：依赖项和初始项目设置

#

  1. 将 Play Core 添加到 Android 应用的 build.gradle 依赖项中。在 android/app/build.gradle 中添加以下内容

    android/app/build.gradle.kts
    kotlin
    ...
dependencies {
  ...
  implementation("com.google.android.play:core:1.8.0")
  ...
}
    android/app/build.gradle
    groovy
    ...
dependencies {
  ...
  implementation "com.google.android.play:core:1.8.0"
  ...
}

  2. 如果使用 Google Play 商店作为动态功能的发布模型，则该应用必须支持 SplitCompat 并提供 PlayStoreDeferredComponentManager 的实例。这两个任务都可以通过在 android/app/src/main/AndroidManifest.xml 中将应用程序的 android:name 属性设置为 io.flutter.embedding.android.FlutterPlayStoreSplitApplication 来完成。

    xml
    <manifest ...
  <application
     android:name="io.flutter.embedding.android.FlutterPlayStoreSplitApplication"
        ...
  </application>
</manifest>

    io.flutter.app.FlutterPlayStoreSplitApplication 会为您处理这两个任务。如果您使用 FlutterPlayStoreSplitApplication，则可以跳到步骤 1.3。

    如果您的 Android 应用程序很大或很复杂，您可能希望单独支持 SplitCompat 并手动提供 PlayStoreDynamicFeatureManager。

    要支持 SplitCompat，有三种方法（如 Android 文档 中所述），任何一种方法都是有效的

    • 使您的应用程序类扩展 SplitCompatApplication

      java
      public class MyApplication extends SplitCompatApplication {
    ...
}

    • 在 attachBaseContext() 方法中调用 SplitCompat.install(this);

      java
      @Override
protected void attachBaseContext(Context base) {
    super.attachBaseContext(base);
    // Emulates installation of future on demand modules using SplitCompat.
    SplitCompat.install(this);
}

    • 将 SplitCompatApplication 声明为应用程序子类，并将 Flutter 兼容性代码从 FlutterApplication 添加到您的应用程序类

      xml
      <application
    ...
    android:name="com.google.android.play.core.splitcompat.SplitCompatApplication">
</application>

    嵌入器依赖于注入的 DeferredComponentManager 实例来处理延迟组件的安装请求。通过将以下代码添加到您的应用初始化中，为 Flutter 嵌入器提供 PlayStoreDeferredComponentManager

    java
    import io.flutter.embedding.engine.dynamicfeatures.PlayStoreDeferredComponentManager;
import io.flutter.FlutterInjector;
...
PlayStoreDeferredComponentManager deferredComponentManager = new
  PlayStoreDeferredComponentManager(this, null);
FlutterInjector.setInstance(new FlutterInjector.Builder()
    .setDeferredComponentManager(deferredComponentManager).build());

  3. 通过将 deferred-components 条目添加到应用程序的 pubspec.yaml 文件下的 flutter 条目中，选择加入延迟组件

    yaml
    ...
flutter:
  ...
  deferred-components:
  ...

    flutter 工具会在 pubspec.yaml 中查找 deferred-components 条目，以确定是否应将应用构建为延迟应用。现在可以将其留空，除非您已经知道所需的组件以及进入每个组件的 Dart 延迟库。您将在 步骤 3.3 中填写此部分，一旦 gen_snapshot 生成加载单元。

步骤 2：实现延迟的 Dart 库

#

接下来，在您的应用的 Dart 代码中实现延迟加载的 Dart 库。实现不必立即完成。本页面的其余部分中的示例添加了一个新的简单延迟小部件作为占位符。您还可以通过修改导入并在延迟代码的使用前使用 loadLibrary() Future 来转换现有代码为延迟加载。

  1. 创建一个新的 Dart 库。例如，创建一个新的 DeferredBox 小部件，可以在运行时下载。此小部件可以具有任意复杂性，但为了本指南的目的，创建一个简单的框作为替代。要创建一个简单的蓝色框小部件，请创建 box.dart 并添加以下内容

    box.dart
    dart
    import 'package:flutter/material.dart';
​
/// A simple blue 30x30 box.
class DeferredBox extends StatelessWidget {
  const DeferredBox({super.key});
​
  @override
  Widget build(BuildContext context) {
    return Container(height: 30, width: 30, color: Colors.blue);
  }
}

  2. 使用 deferred 关键字在您的应用中导入新的 Dart 库，并调用 loadLibrary()（请参阅 延迟加载库）。以下示例使用 FutureBuilder 等待 loadLibrary Future（在 initState 中创建）完成，并显示一个 CircularProgressIndicator 作为占位符。当 Future 完成时，它将返回 DeferredBox 小部件。然后，可以在应用中使用 SomeWidget，并且永远不会尝试访问延迟的 Dart 代码，直到它成功加载为止。

    dart
    import 'package:flutter/material.dart';
import 'box.dart' deferred as box;
​
class SomeWidget extends StatefulWidget {
  const SomeWidget({super.key});
​
  @override
  State<SomeWidget> createState() => _SomeWidgetState();
}
​
class _SomeWidgetState extends State<SomeWidget> {
  late Future<void> _libraryFuture;
​
  @override
  void initState() {
    super.initState();
    _libraryFuture = box.loadLibrary();
  }
​
  @override
  Widget build(BuildContext context) {
    return FutureBuilder<void>(
      future: _libraryFuture,
      builder: (context, snapshot) {
        if (snapshot.connectionState == ConnectionState.done) {
          if (snapshot.hasError) {
            return Text('Error: ${snapshot.error}');
          }
          return box.DeferredBox();
        }
        return const CircularProgressIndicator();
      },
    );
  }
}

    loadLibrary() 函数返回一个 Future<void>，当库中的代码可用时，该函数将成功完成，否则将完成并出现错误。应将对延迟库中所有符号的使用都保护在完成的 loadLibrary() 调用之后。必须将库的所有导入标记为 deferred，才能将其编译为适当的形式，以便在延迟组件中使用。如果组件已经加载，则对 loadLibrary() 的额外调用将快速完成（但不同步）。也可以提前调用 loadLibrary() 以触发预加载，以帮助掩盖加载时间。

    您可以在 Flutter Gallery 的 lib/deferred_widget.dart 中找到另一个延迟导入加载示例。

步骤 3：构建应用

#

使用以下 flutter 命令构建延迟组件应用

flutter build appbundle

此命令通过验证您的项目是否已正确设置以构建延迟组件应用来帮助您。默认情况下，如果验证程序检测到任何问题，构建将失败，并指导您进行建议的更改以解决这些问题。

  1. flutter build appbundle 命令运行验证程序并尝试使用指示 gen_snapshot 生成拆分 AOT 共享库作为单独的 SO 文件的应用。首次运行时，验证程序可能会失败，因为它检测到问题；该工具会提出建议，说明如何设置项目并解决这些问题。

    验证程序分为两个部分：预构建验证和生成快照后验证。这是因为任何引用加载单元的验证都必须在 gen_snapshot 完成并生成最终的加载单元集后才能执行。

    验证程序检测 gen_snapshot 生成的任何新的、更改的或删除的加载单元。当前生成的加载单元在您的 <projectDirectory>/deferred_components_loading_units.yaml 文件中跟踪。应将此文件签入源代码控制，以确保其他开发人员对加载单元的更改可以被捕获。

    验证程序还在 android 目录中检查以下内容

    • <projectDir>/android/app/src/main/res/values/strings.xml
      为每个延迟组件映射键 ${componentName}Name 到 ${componentName} 的条目。此字符串资源由每个功能模块的 AndroidManifest.xml 用于定义 dist:title property。例如

      xml
      <?xml version="1.0" encoding="utf-8"?>
<resources>
  ...
  <string name="boxComponentName">boxComponent</string>
</resources>

    • <projectDir>/android/<componentName>
      为每个延迟组件存在 Android 动态功能模块，并包含 build.gradle 和 src/main/AndroidManifest.xml 文件。这仅检查是否存在，并且不验证这些文件的内容。如果文件不存在，它将生成一个默认的推荐文件。

    • <projectDir>/android/app/src/main/res/values/AndroidManifest.xml
      包含编码加载单元与关联加载单元组件名称之间映射的元数据条目。嵌入器使用此映射将 Dart 的内部加载单元 ID 转换为要安装的延迟组件的名称。例如

      xml
      ...
<application
    android:label="MyApp"
    android:name="io.flutter.app.FlutterPlayStoreSplitApplication"
    android:icon="@mipmap/ic_launcher">
    ...
    <meta-data android:name="io.flutter.embedding.engine.deferredcomponents.DeferredComponentManager.loadingUnitMapping" android:value="2:boxComponent"/>
</application>
...

    gen_snapshot 验证程序在预构建验证程序通过之前不会运行。

  2. 对于这些检查中的每一个，该工具都会生成修改或新的文件，以通过检查。这些文件放置在 <projectDir>/build/android_deferred_components_setup_files 目录中。建议通过复制和覆盖项目 android 目录中的相同文件来应用更改。在覆盖之前，应将当前项目状态提交到源代码控制，并应审查建议的更改以确保其适当。该工具不会自动对您的 android/ 目录进行任何更改。

  3. 一旦生成了可用的加载单元并记录在 <projectDirectory>/deferred_components_loading_units.yaml 中，就可以完全配置 pubspec.yaml 的 deferred-components 部分，以便将加载单元分配给所需的延迟组件。继续使用框示例，生成的 deferred_components_loading_units.yaml 文件将包含

    yaml
    loading-units:
  - id: 2
    libraries:
      - package:MyAppName/box.Dart

    加载单元 ID（在本例中为“2”）由 Dart 内部使用，可以忽略。基础加载单元（ID 为“1”）未列出，包含未明确包含在其他加载单元中的所有内容。

    现在，您可以将以下内容添加到 pubspec.yaml 中

    yaml
    ...
flutter:
  ...
  deferred-components:
    - name: boxComponent
      libraries:
        - package:MyAppName/box.Dart
  ...

    要将加载单元分配给延迟组件，请将加载单元中的任何 Dart 库添加到功能模块的 libraries 部分。请记住以下准则：

    • 加载单元不应包含在多个组件中。

    • 包含来自加载单元的一个 Dart 库表示整个加载单元已分配给延迟组件。

    • 未分配给延迟组件的所有加载单元都包含在基础组件中，基础组件始终隐式存在。

    • 分配给相同延迟组件的加载单元将一起下载、安装和交付。

    • 基础组件是隐式的，无需在 pubspec 中定义。

  4. 还可以通过在延迟组件配置中添加 assets 部分来包含资源。

    yaml
      deferred-components:
    - name: boxComponent
      libraries:
        - package:MyAppName/box.Dart
      assets:
        - assets/image.jpg
        - assets/picture.png
          # wildcard directory
        - assets/gallery/

    可以将资源包含在多个延迟组件中，但安装这两个组件会导致资源复制。也可以通过省略 libraries 部分来定义仅包含资源的组件。这些仅包含资源的组件必须使用 DeferredComponent 服务类中的实用程序类进行安装，而不是 loadLibrary()。由于 Dart 库与资源一起打包，因此如果使用 loadLibrary() 加载 Dart 库，则组件中的所有资源也会加载。但是，通过组件名称和 services 实用程序进行安装不会加载组件中的任何 Dart 库。

    您可以自由地将资源包含在任何组件中，只要在首次引用时安装并加载它们即可，尽管通常，资源和使用这些资源的 Dart 代码最好打包在同一个组件中。

  5. 手动将您在 pubspec.yaml 中定义的所有延迟组件添加到 android/settings.gradle 文件中作为 includes。例如，如果在 pubspec 中定义了三个延迟组件，名为 boxComponent、circleComponent 和 assetComponent，请确保 android/settings.gradle 包含以下内容：

    android/settings.gradle.kts
    kotlin
    include(":app", ":boxComponent", ":circleComponent", ":assetComponent")
...
    android/settings.gradle
    groovy
    include ':app', ':boxComponent', ':circleComponent', ':assetComponent'
...

  6. 重复步骤 3.1 到 3.6（此步骤），直到处理完所有验证器建议并且工具运行没有进一步的建议为止。

    成功后，此命令将在 build/app/outputs/bundle/release 中输出一个 app-release.aab 文件。

    成功的构建并不总是意味着应用程序是按预期构建的。确保所有加载单元和 Dart 库都包含在您预期的方式中，这取决于您。例如，一个常见的错误是意外地导入一个没有 deferred 关键字的 Dart 库，导致延迟库被编译为基础加载单元的一部分。在这种情况下，Dart 库将正确加载，因为它始终存在于基础中，并且库不会被拆分。可以通过检查 deferred_components_loading_units.yaml 文件来验证生成的加载单元是否按预期描述。

    在调整延迟组件配置或进行添加、修改或删除加载单元的 Dart 更改时，您应该预计验证器会失败。按照步骤 3.1 到 3.6（此步骤）应用任何建议的更改以继续构建。

在本地运行应用

#

一旦您的应用程序成功构建了 AAB 文件，请使用 Android 的 bundletool 使用 --local-testing 标志进行本地测试。

要在测试设备上运行 AAB 文件，请从 github.com/google/bundletool/releases 下载 bundletool jar 可执行文件并运行

java -jar bundletool.jar build-apks --bundle=<your_app_project_dir>/build/app/outputs/bundle/release/app-release.aab --output=<your_temp_dir>/app.apks --local-testing

java -jar bundletool.jar install-apks --apks=<your_temp_dir>/app.apks

其中 <your_app_project_dir> 是应用程序项目目录的路径，而 <your_temp_dir> 是用于存储 bundletool 输出的任何临时目录。这将您的 AAB 文件解包到一个 APK 文件并在设备上安装它。所有可用的 Android 动态功能都加载到设备上本地，并且延迟组件的安装被模拟。

在再次运行 build-apks 之前，请删除现有的应用程序 APK 文件

rm <your_temp_dir>/app.apks

Dart 代码库的更改需要增加 Android 构建 ID 或卸载并重新安装应用程序，因为 Android 不会在检测到新版本号之前更新功能模块。

发布到 Google Play 商店

#

构建的 AAB 文件可以直接上传到 Play 商店，如正常操作一样。当调用 loadLibrary() 时，包含 Dart AOT 库和资源的所需 Android 模块将由 Flutter 引擎使用 Play 商店的交付功能下载。

除非另有说明，此网站上的文档反映了 Flutter 3.38.6。页面最后更新于 2026-02-07。 查看源代码 或 报告问题。