將 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")
    }
}