跳至主要内容

将 Flutter 模块集成到您的 Android 项目中

Flutter 可以作为源代码 Gradle 子项目或 AAR,分批嵌入到您现有的 Android 应用程序中。

可以使用带有 Flutter 插件 的 Android Studio IDE 或手动执行集成流程。

集成您的 Flutter 模块

#

与 Android Studio 集成

#

Android Studio IDE 可以帮助集成您的 Flutter 模块。使用 Android Studio,您可以在同一个 IDE 中编辑 Android 和 Flutter 代码。

您还可以使用 IntelliJ Flutter 插件的功能,例如 Dart 代码补全、热重载和 Widget 检查器。

要构建您的应用,Android Studio 插件会配置您的 Android 项目,将您的 Flutter 模块添加为依赖项。

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

  2. 转到**文件** > **新建** > **新建项目...**。将显示**新建项目**对话框。

  3. 点击**Flutter**。

  4. 如果系统要求您提供**Flutter SDK 路径**,请提供并点击**下一步**。

  5. 完成 Flutter 模块的配置。

    • 如果您有现有项目

      1. 要选择现有项目,请点击**项目位置**框右侧的**...**。
      2. 导航到您的 Flutter 项目目录。
      3. 点击**打开**。
    • 如果您需要创建新的 Flutter 项目

      1. 完成配置对话框。
      2. 在**项目类型**菜单中,选择**模块**。
  6. 点击**完成**。

无需 Android Studio 集成

#

要手动将 Flutter 模块与现有的 Android 应用集成,无需使用 Flutter 的 Android Studio 插件,请按照以下步骤操作

创建 Flutter 模块

#

假设您在 some/path/MyApp 中有一个现有的 Android 应用,并且您希望您的 Flutter 项目作为其同级项目

cd some/path/
flutter create -t module --org com.example flutter_module

这将创建一个 some/path/flutter_module/ Flutter 模块项目,其中包含一些 Dart 代码以帮助您入门,以及一个 .android/ 隐藏子文件夹。.android 文件夹包含一个 Android 项目,该项目既可以帮助您通过 flutter run 运行 Flutter 模块的精简版独立版本,也可以作为包装器,帮助引导 Flutter 模块成为可嵌入的 Android 库。

Java 版本要求

#

Flutter 要求您的项目声明与 Java 11 或更高版本兼容。

在尝试将 Flutter 模块项目连接到主机 Android 应用之前,请确保您的主机 Android 应用在应用的 build.gradle 文件中(位于 android { } 块内)声明以下源代码兼容性。

MyApp/app/build.gradle
groovy
android {
    // ...
    compileOptions {
        sourceCompatibility = 11 // The minimum value
        targetCompatibility = 11 // The minimum value
    }
}

集中存储库设置

#

从 Gradle 7 开始,Android 建议在 settings.gradle 中使用集中式存储库声明,而不是在 build.gradle 文件中使用项目或模块级声明。

在尝试将 Flutter 模块项目连接到主机 Android 应用之前,请进行以下更改。

  1. 删除所有应用的 build.gradle 文件中的 repositories 块。

    groovy
    // Remove the following block, starting on the next line
        repositories {
            google()
            mavenCentral()
        }
    // ...to the previous line
  2. 将此步骤中显示的 dependencyResolutionManagement 添加到 settings.gradle 文件中。

    groovy
    dependencyResolutionManagement {
       repositoriesMode = RepositoriesMode.PREFER_SETTINGS
       repositories {
           google()
           mavenCentral()
       }
    }

将 Flutter 模块添加为依赖项

#

在 Gradle 中将 Flutter 模块添加为现有应用的依赖项。您可以通过两种方式实现此目的。

  1. **Android 归档文件** AAR 机制创建通用的 Android AAR 作为中间体,用于打包 Flutter 模块。如果您的下游应用构建器不想安装 Flutter SDK,则此方法非常有用。但是,如果频繁构建,则会增加一个构建步骤。

  2. **模块源代码** 源代码子项目机制是一个方便的一键式构建过程,但需要 Flutter SDK。这是 Android Studio IDE 插件使用的机制。

依赖 Android 归档文件 (AAR)

#

此选项将 Flutter 库打包为由 AAR 和 POM 文件构成的通用本地 Maven 存储库。此选项允许您的团队在不安装 Flutter SDK 的情况下构建主机应用。然后,您可以从本地或远程存储库分发这些工件。

假设您在 some/path/flutter_module 中构建了一个 Flutter 模块,然后运行

cd some/path/flutter_module
flutter build aar

然后,按照屏幕上的说明进行集成。

更具体地说,此命令(默认情况下所有调试/概要文件/发布模式)创建一个 本地存储库,其中包含以下文件

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,使其包含本地存储库和依赖项

settings.gradle.kts
kotlin
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
        maven("https://storage.googleapis.com/download.flutter.io")
    }
}
settings.gradle
groovy
dependencyResolutionManagement {
    repositoriesMode = RepositoriesMode.PREFER_SETTINGS
    repositories {
        google()
        mavenCentral()

        // Add the new repositories starting on the next line...
        maven {
            url = uri("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 = uri("https://storage.googleapis.com/download.flutter.io")
        }
        // ...to before this line  
    }
}

基于 Kotlin DSL 的 Android 项目

#

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

在 Android 项目的 app/build.gradle 文件中将 Flutter 模块包含为依赖项。

MyApp/app/build.gradle.kts
kotlin
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 是一个自定义 configuration,需要在主机项目的 app/build.gradle 文件中实现。

host-project/app/build.gradle.kts
kotlin
configurations {
    getByName("profileImplementation") {
    }
}
MyApp/settings.gradle.kts
kotlin
include(":app")

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

依赖模块的源代码

#

此选项允许对 Android 项目和 Flutter 项目进行一步构建。当您同时处理这两个部分并快速迭代时,此选项很方便,但您的团队必须安装 Flutter SDK 才能构建主机应用。

更新 settings.gradle

#

将 Flutter 模块作为子项目包含在主机应用的 settings.gradle 中。此示例假设 flutter_moduleMyApp 存在于同一目录中

如果您使用的是 Kotlin,请应用以下更改

MyApp/settings.gradle.kts
kotlin
// Include the host app project. Assumed existing content.
include(":app")            
// Replace "flutter_module" with whatever package_name you supplied when you ran:
// `$ flutter create -t module [package_name]
val filePath = settingsDir.parentFile.toString() + "/flutter_module/.android/include_flutter.groovy"
apply(from = File(filePath))

如果您使用的是 Groovy,请应用以下更改

MyApp/settings.gradle
groovy
// Include the host app project.
include(":app")                                   // assumed existing content
setBinding(new Binding([gradle: this]))           // new
def filePath = settingsDir.parentFile.toString() + "/flutter_module/.android/include_flutter.groovy" // new
apply from: filePath                              // new

绑定和脚本评估允许 Flutter 模块在 settings.gradle 的评估上下文中 include 本身(作为 :flutter)以及模块使用的任何 Flutter 插件(例如 :package_info:video_player)。

更新 app/build.gradle

#

从您的应用中引入对 Flutter 模块的 implementation 依赖项

MyApp/app/build.gradle
groovy
dependencies {
    implementation(project(":flutter"))
}

您的应用现在已将 Flutter 模块作为依赖项包含在内。

继续前往 将 Flutter 屏幕添加到 Android 应用 指南。