Android 和 Web 的延迟组件

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

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

• Android 的 动态功能模块 将延迟组件打包为 Android 模块进行交付。

  在构建 Android 应用时，尽管您可以延迟加载模块，但您必须构建整个应用并将其作为单个 Android App Bundle (AAB) 上传。Flutter 不支持在不重新上传整个应用的新 Android App Bundle 的情况下分发部分更新。

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

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

有关此功能工作原理的更深入技术细节，请参阅 Flutter Wiki 上的 延迟组件。

以下说明解释了如何设置您的 Android 应用以进行延迟加载。

1. 将 Play Core 添加到 Android 应用的 build.gradle 依赖项中。在 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 声明为应用子类，并将 FlutterApplication 中的 Flutter 兼容代码添加到您的应用类中

     xml

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

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

   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. 通过在应用的 pubspec.yaml 中，在 flutter 条目下添加 deferred-components 条目，选择使用延迟组件

   yaml

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

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

接下来，在应用的 Dart 代码中实现延迟加载的 Dart 库。该实现尚无需功能完整。本页其余部分的示例添加了一个新的简单延迟小部件作为占位符。您还可以通过修改导入并将延迟代码的使用置于 loadLibrary() Futures 之后来将现有代码转换为延迟加载。

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>，当库中的代码可用时，该 Future 会成功完成；否则，会以错误完成。所有延迟库中符号的使用都应该在 loadLibrary() 调用完成后才能进行。库的所有导入都必须标记为 deferred，以便将其适当地编译用于延迟组件。如果组件已加载，对 loadLibrary() 的额外调用会快速完成（但不是同步的）。loadLibrary() 函数也可以提前调用以触发预加载，从而帮助掩盖加载时间。

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

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

flutter build appbundle

此命令通过验证您的项目是否正确设置为构建延迟组件应用来为您提供帮助。默认情况下，如果验证器检测到任何问题，构建将失败，并会引导您进行建议的更改以修复它们。

1. flutter build appbundle 命令会运行验证器，并尝试使用 gen_snapshot 构建应用，其中 gen_snapshot 会生成拆分的 AOT 共享库作为单独的 SO 文件。首次运行时，验证器可能会因为检测到问题而失败；该工具会提供有关如何设置项目和修复这些问题的建议。

   验证器分为两个部分：预构建验证和 post-gen_snapshot 验证。这是因为任何引用加载单元的验证都无法在 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 的 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 部分来定义仅包含资产的组件。这些仅包含资产的组件必须使用 services 中的 DeferredComponent 实用程序类进行安装，而不是 loadLibrary()。由于 Dart 库与资产一起打包，如果使用 loadLibrary() 加载 Dart 库，则组件中的任何资产也会被加载。但是，通过组件名称和服务实用程序进行安装不会加载组件中的任何 Dart 库。

   您可以将资产包含在任何组件中，只要它们在首次引用时被安装和加载即可，但通常情况下，资产和使用这些资产的 Dart 代码最好打包在同一个组件中。

5. 手动将您在 pubspec.yaml 中定义的所有延迟组件作为 include 添加到 android/settings.gradle 文件中。例如，如果 pubspec 中定义了三个名为 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 库都按照您预期的方式包含在内。例如，一个常见的错误是意外地导入 Dart 库时没有使用 deferred 关键字，导致延迟库作为基本加载单元的一部分进行编译。在这种情况下，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 不会更新功能模块，除非它检测到新的版本号。

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