将 Flutter module 集成到 Android 项目

使用 Android Studio 集成

直接使用 Android Studio 是在现有应用中自动集成 Flutter 模块比较便捷的方法。在 Android Studio 中，你可以在一个项目中同时编写 Android 代码和 Flutter 代码。

你还可以继续使用各种常用的 IntelliJ Flutter 插件功能，例如 Dart 代码自动补全、热重载和 widget 检查器等。

在 Android Studio 2022.2 及以上的版本，配合 IntelliJ Flutter 插件 就可以直接通过 Android Studio 执行集成流程。 Android Studio 需要将你的 Flutter 模块作为依赖。

1. 在 Android Studio 中打开你的 Android 项目。

2. 前往 File > New > New Project…，此时 New Project 弹窗会显示。

3. 选择 Flutter。

4. 填写你的 Flutter SDK path 并点击 Next 继续。

5. 完成你的 Flutter 模块配置。

   • 如果你的项目是已有的：

     1. 点击 Project location 右侧的 … 选择现有的项目。

     2. 前往你的 Flutter 项目的目录所在位置。

     3. 点击 打开。

   • 如果你需要创建一个新的 Flutter 项目：

     1. 完成配置弹窗的内容。

     2. 在 Project type 菜单中，选择 Module。

6. 点击完成。

依赖 Android Archive (AAR)

这种方式会将 Flutter 库打包成由 AAR 和 POM artifacts 组成的本地 Maven 存储库。这种方案可以使你的团队不需要安装 Flutter SDK 即可编译宿主应用。之后，你可以从本地或远程存储库中分发更新 artifacts。

假设你在 some/path/flutter_module 下构建 Flutter 模块，执行如下命令：

cd some/path/flutter_module
flutter build aar

然后，根据屏幕上的提示完成集成操作。

详细地说，该命令应用于创建（debug/profile/release 所有模式） 本地仓库，主要包含以下文件：

build/host/outputs/repo
└── com
    └── example
        └── flutter_module
            ├── flutter_release
            │   ├── 1.0
            │   │   ├── flutter_release-1.0.aar
            │   │   ├── flutter_release-1.0.aar.md5
            │   │   ├── flutter_release-1.0.aar.sha1
            │   │   ├── flutter_release-1.0.pom
            │   │   ├── flutter_release-1.0.pom.md5
            │   │   └── flutter_release-1.0.pom.sha1
            │   ├── maven-metadata.xml
            │   ├── maven-metadata.xml.md5
            │   └── maven-metadata.xml.sha1
            ├── flutter_profile
            │   ├── ...
            └── flutter_debug
                └── ...

要依赖 AAR，宿主应用必须能够找到这些文件。

为此，需要在宿主应用程序中修改 settings.gradle 文件，使其包含本地存储库和上述依赖项：

dependencyResolutionManagement {
  repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
  repositories {
    google()
    mavenCentral()

  // Add the new repositories starting on the next line...
    maven {
      url 'some/path/flutter_module/build/host/outputs/repo'
      // This is relative to the location of the build.gradle file
      // if using a relative path.
    }
    maven {
      url 'https://storage.googleapis.com/download.flutter.io'
    }
  // ...to before this line  
  }
}

</br>

基于 Kotlin DSL 的 Android 项目

在基于 Kotlin DSL Android 项目的 aar 构建完成后，请按照以下步骤添加 flutter_module。

在 Android 项目的 app/build.gradle 文件中将 flutter module 列为依赖项。

android {
    buildTypes {
        release {
          ...
        }
        debug {
          ...
        }
        create("profile") {
            initWith(getByName("debug"))
        }
}
dependencies {
  // ...
  debugImplementation "com.example.flutter_module:flutter_debug:1.0"
  releaseImplementation 'com.example.flutter_module:flutter_release:1.0'
  add("profileImplementation", "com.example.flutter_module:flutter_profile:1.0")
}

profileImplementation ID 是在宿主项目的 app/build.gradle 文件中实施的自定义 configuration。

configurations {
    getByName("profileImplementation") {
    }
}

include(":app")

dependencyResolutionManagement {
    repositories {
        maven(url = "https://storage.googleapis.com/download.flutter.io")
        maven(url = "some/path/flutter_module_project/build/host/outputs/repo")
    }
}