将 Flutter 模块集成到您的 Android 项目中
了解如何将 Flutter 模块集成到您现有的 Android 项目中。
Flutter 可以作为源代码 Gradle 子项目或 AAR(Android Archive)分步嵌入到您现有的 Android 应用程序中。
集成流程可以通过 Android Studio IDE 的 Flutter 插件完成,也可以手动完成。
集成您的 Flutter 模块
#使用 Android Studio 集成
#Android Studio IDE 可以帮助集成您的 Flutter 模块。使用 Android Studio,您可以在同一个 IDE 中编辑 Android 和 Flutter 代码。
您还可以使用 IntelliJ Flutter 插件的功能,例如 Dart 代码补全、热重载和 Widget 检查器。
为了构建您的应用,Android Studio 插件会配置您的 Android 项目,将 Flutter 模块添加为依赖项。
在 Android Studio 中打开您的 Android 项目。
-
转到 File > New > New Project...。此时会显示 New Project 对话框。
点击 Flutter。
-
如果提示提供 Flutter SDK path,请输入路径并点击 Next。
-
完成 Flutter 模块的配置。
如果您已有现有的项目
- 要选择现有项目,请点击 Project location 框右侧的 ...。
- 导航到您的 Flutter 项目目录。
- 点击 Open。
如果您需要创建新的 Flutter 项目
- 完成配置对话框。
- 在 Project type 菜单中,选择 Module。
点击 Finish(完成)。
不使用 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 17 或更高版本兼容。
在尝试将 Flutter 模块项目连接到宿主 Android 应用之前,请确保您的宿主 Android 应用在其应用的 build.gradle 文件中的 android { } 代码块下声明了以下源兼容性。
android {
// ...
compileOptions {
sourceCompatibility = JavaVersion.VERSION_17 // The minimum value
targetCompatibility = JavaVersion.VERSION_17 // The minimum value
}
// ...
}
集中管理仓库设置
#从 Gradle 7 开始,Android 建议在 settings.gradle 中使用集中式仓库声明,而不是在 build.gradle 文件中进行项目或模块级别的声明。
在尝试将 Flutter 模块项目连接到宿主 Android 应用之前,请对您的宿主应用进行以下更改:
-
移除所有应用
build.gradle文件中的repositories代码块。groovy// Remove the following block, starting on the next line repositories { google() mavenCentral() } // ...to the previous line -
将此步骤中显示的
dependencyResolutionManagement添加到settings.gradle文件中。
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
val storageUrl: String = System.getenv("FLUTTER_STORAGE_BASE_URL") ?: "https://storage.googleapis.com"
repositories {
google()
mavenCentral()
maven("$storageUrl/download.flutter.io")
}
}
dependencyResolutionManagement {
repositoriesMode = RepositoriesMode.PREFER_SETTINGS
String storageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
repositories {
google()
mavenCentral()
maven {
url = uri("$storageUrl/download.flutter.io")
}
}
}
将 Flutter 模块添加为依赖项
#在 Gradle 中将 Flutter 模块添加为现有应用的依赖项。您可以通过两种方式实现这一点。
-
Android Archive (AAR):AAR 机制创建通用的 Android AAR 作为封装您 Flutter 模块的中间件。当您的下游应用构建者不想安装 Flutter SDK 时,此方法非常有效。但如果您频繁构建,它会增加一个额外的构建步骤。
-
模块源代码:源代码子项目机制是一种便捷的一键构建过程,但需要安装 Flutter SDK。这是 Android Studio IDE 插件所使用的机制。
依赖 Android Archive (AAR)
#此选项将您的 Flutter 库封装为由 AAR 和 POM 工件组成的通用本地 Maven 仓库。此选项允许您的团队在不安装 Flutter SDK 的情况下构建宿主应用。然后,您可以从本地或远程仓库分发这些工件。
假设您在 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()
maven("https://storage.googleapis.com/download.flutter.io")
maven(url = "<some/path/flutter_module>/build/host/outputs/repo")
}
}
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。
在宿主应用的 app/build.gradle 文件中将 Flutter 模块包含为依赖项。
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 依赖配置添加到同一个应用级 build.gradle 文件的末尾。
configurations {
getByName("profileImplementation") {
}
}
依赖模块源代码
#此选项可同时为您的 Android 项目和 Flutter 项目实现一步构建。当您同时处理这两部分并进行快速迭代时,此选项很方便,但您的团队必须安装 Flutter SDK 才能构建宿主应用。
更新 settings.gradle
#
将 Flutter 模块作为子项目包含在宿主应用的 settings.gradle 中。此示例假设 flutter_module 和 MyApp 存在于同一目录中:
如果您正在使用 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,请应用以下更改:
// 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 的评估上下文中将自身(作为 :flutter)以及模块使用的任何 Flutter 插件(例如 :package_info 和 :video_player)包含进去。
更新 app/build.gradle
#
在您的应用中引入对 Flutter 模块的 implementation 依赖:
dependencies {
implementation(project(":flutter"))
}
现在,您的应用已将 Flutter 模块作为依赖项包含在内。
继续阅读将 Flutter 屏幕添加到 Android 应用指南。