分析 flutter 打包流程及 aar 产物,并将最终的 aar 集成到现有工程(Android 篇)

本文运行环境说明: Flutter (Channel unknown, v1.9.1+hotfix.2, on Mac OS X 10.12.6 16G2128, locale zh-Hans-CN)

创建 flutter module 工程

Flutter create -t module flutter_library
  • 这种方式创建的 flutter 项目常常用来集成到现有 Android 或 ios 工程中,对于 Android 工程,我们希望的是将 flutter 工程打包成一个 aar 文件,放入 Android 项目中继承,本文就介绍一下打包集成方式。

将 flutter 打包成 aar

打包命令分析

从 flutter 1.9.1开始,支持直接打包为 aar,命令为

flutter build aar

如果想输出详细打包过程日志,可以在后面加上 -v 参数

使用 which flutter 命令可以找到 flutter 的命令文件,查看该文件,能找到真正执行的命令。不是很清楚 shell 脚本的话看起来比较费劲,这里直接说结论吧:命令采用了 dart 执行环境,编译打包逻辑在 flutter_tools.snapshot 中。dart 的 snapshot 相当于 Java 的 jar,因此,一个 snapshot 在执行的时候,必然有它的执行入口,也就是类似 main 函数的东西。这里的入口,正是 flutter/packages/flutter_tools/bin/flutter_tools.dart ,其 main 函数如下:

void main(List args) {
  executable.main(args);
}

进入 executable.dart,在 main 方法中可以看到创建了一堆 xxxCommand 对象,显然这是各种命令对应的类,我们暂时只需要关心 flutter build 命令匹配的 BuildCommand() 方法。

class BuildCommand extends FlutterCommand {
  BuildCommand({bool verboseHelp = false}) {
    addSubcommand(BuildAarCommand(verboseHelp: verboseHelp));
    addSubcommand(BuildApkCommand(verboseHelp: verboseHelp));
    addSubcommand(BuildAppBundleCommand(verboseHelp: verboseHelp));
    addSubcommand(BuildAotCommand(verboseHelp: verboseHelp));
    addSubcommand(BuildIOSCommand());
    addSubcommand(BuildBundleCommand(verboseHelp: verboseHelp));
    addSubcommand(BuildWebCommand());
    addSubcommand(BuildMacosCommand(verboseHelp: verboseHelp));
    addSubcommand(BuildLinuxCommand());
    addSubcommand(BuildWindowsCommand());
    addSubcommand(BuildFuchsiaCommand(verboseHelp: verboseHelp));
  }

  @override
  final String name = 'build';

  @override
  final String description = 'Flutter build commands.';

  @override
  Future runCommand() async => null;
}

abstract class BuildSubCommand extends FlutterCommand {
  BuildSubCommand() {
    requiresPubspecYaml();
  }
}

这里定义的一系列子命令,正是对应了我们运行 flutter build -h 所看到的内容。
通过与父类的一系列调用关系,最终调用子类真正的 runCommand 的方法,由于这里执行的是 build aar,所以子类是BuildAarCommand。
一番追踪之后,你会发现最终还是调用了 android 的 gradlew assembleRelease 命令,只是加入了一些参数而已。然后,继续追踪 flutter 工程的 .android 目录下的 gradle 文件。
.android 目录下有两个重要的 gradle 文件,一个是 include_flutter.groovy,另一个是 Flutter 目录下的 build.gradle。
前者的主要作用是编译 Flutter 目录和插件,后者检查了 flutter sdk 版本信息,然后进入了 flutter.gradle,它是一个 gradle 插件,里面实现了一些 task 以及设定了必要的依赖;
至于后续的打包过程还没有搞清楚,各位客官自己研究分析吧。

打包产物分析

打包命令运行后生成的产物被放在 build 目录下的不同文件夹里,我们主要关心 aar,它被放在 build/host/outputs/repo 文件夹,包括 flutter 主项目及每一个 flutter 插件对应的 aar,分别放在以主项目或插件包名对应路径下。介绍如下:

  • flutter_release.aar:类似这个名称的文件是 flutter 主项目对应生成的 aar,解压 aar 文件,里面的内容介绍:
    - jni:生成有 libflutter.so 和 libapp.so,这两个 Flutter 库和引擎、Dart VM 以及 dart 业务代码(这里指你自己写的代码逻辑)编译后的产物,从此可以看出,Flutter 库和引擎会被打包成 so 文件并最终汇总到 apk 中,以给 flutter 提供运行时环境;
    - assets:存放了 flutter 项目的资源文件,例如图片、自定义字体等;
    - libs: 含有 flatter.jar,主要是官方已经写好的、flutter 与 Android 通信的逻辑类,比如 FlutterActivity、MethodCall 等;
    - .classes.jar: Flutter.java、FlutterFragment.java、GeneratedPluginRegistrant.java的 class 文件,其实就是对应 .android/Flutter/src 目录下的代码;

  • 其他包里的 aar: 对应的是插件打包成的 aar,解压该 aar 文件,会看到插件的 Android 部分源码打在了 aar 里的 classes.jar 中,资源文件放在了 res 目录下;

将所有产物汇总成一个 aar

  • 方便起见,最好是将上面的主工程 aar 和每个插件的 aar 一起打到一个 aar 中,这个 aar 就可以放在其他 Android 工程中使用了;
  • 如果想将多个 aar 汇总成一个 aar,可以借助 fat-aar-android;

  • 清除缓存: 命令:flutter clean,这样会清楚 build 目录,另外要说明的是,这样也会清空 .android 目录,当执行 flutter packages get 后又会自动生成 .android 目录;

参考:

  • Add Flutter to existing apps
  • 浅谈Flutter构建
  • 研读Flutter——打包编译流程详解

你可能感兴趣的:(分析 flutter 打包流程及 aar 产物,并将最终的 aar 集成到现有工程(Android 篇))