了解一下如何在 Android 原生項目中集成 Flutter

生成配置

在原生項目根目錄執(zhí)行命令
 
flutter create -t module --org {package_name} {module_name}
 
// 此處 module_name 的命令遵循 Android 子 module 的命名即可。不能有中劃線。
 
// 比如, 
 
flutter create -t module --org com.engineer.mini.flutter flutter_sub
 
// 此處 module_name 的命令遵循 Android 子 module 的命名即可。不能有中劃線。
 
// 比如, 
 
flutter create -t module --org com.engineer.mini.flutter flutter_sub
</pre>

結果

Creating project sub_flutter...
sub_flutter/test/widget_test.dart (created)
sub_flutter/sub_flutter.iml (created)
sub_flutter/.gitignore (created)
sub_flutter/.metadata (created)
sub_flutter/pubspec.yaml (created)
sub_flutter/README.md (created)
sub_flutter/lib/main.dart (created)
sub_flutter/sub_flutter_android.iml (created)
sub_flutter/.idea/libraries/Dart_SDK.xml (created)
sub_flutter/.idea/modules.xml (created)
sub_flutter/.idea/workspace.xml (created)
Running "flutter pub get" in sub_flutter... 1,054ms
Wrote 11 files.

最終生成了以上文件，注意這里最后 自動執(zhí)行了 flutter pub get 的命令。關于 flutter pub get 具體做了什么，可以參考后面的。

這里在項目根目錄創(chuàng)建子 module 只是為了把代碼放在一個倉庫，方便維護，理論上可以放在硬盤的任何位置。

配置原生項目 settings.gradle

在配置 settings.gradle 之前先來簡單回顧一下關于 Gradle 的一些基礎知識。

如果你了解過 Gradle 相關的配置的話，一定會看到一個概念，就是 約定優(yōu)于配置 ，什么意思呢，按照面向對象的思路來理解，每一個工程是一個巨大的 Project 類，整個類里有很多的屬性。而我們創(chuàng)建的每一個項目其實就是一個具體的 Project 對象（也就是實例).約定優(yōu)于配置的意思，就是在 project 實例化的時候，其內部的屬性已經有了默認值。那么我們怎么知道有哪些默認值呢？在項目根目錄執(zhí)行

./gradlew properties

就可以得到整個 Project 的一些默認配置，比如（此處節(jié)選部分結果）

------------------------------------------------------------
Root project
------------------------------------------------------------
 
allprojects: [root project 'MiniApp', project ':app', project ':thirdlib']
android.agp.version.check.performed: true
android.enableJetifier: true
android.enableR8: true
android.enableR8.libraries: true
android.useAndroidX: true
buildDir: /Users/username/Documents/mygithub/MinApp/build
buildFile: /Users/username/Documents/mygithub/MinApp/build.gradle
projectDir: /Users/username/Documents/mygithub/MinApp
rootDir: /Users/username/Documents/mygithub/MinApp
rootProject: root project 'MiniApp'

這里當前有一些是我們配置的，比如 useAndroidX，但也有一些是約定的，比如 對于整個 project 來說 buildDir 就是項目根目錄的 build 文件夾等。

執(zhí)行

./gradlew :app:properties

節(jié)選部分結果

buildDir: /Users/username/Documents/mygithub/MinApp/app/build
buildFile: /Users/username/Documents/mygithub/MinApp/app/build.gradle

就會得到關于 app 整個 module 現(xiàn)階段的一些配置信息，當然這些配置信息除了約定的，還有你自己配置的，比如 buildToolsVersion ，簽名等相關信息?？梢钥吹?buildDir 和整個 project 的是不一樣的。

回到主題， 看看如何把我們剛才創(chuàng)建的 sub_flutter 模塊集成到項目中。（嚴格來說并不是集成 sub_flutter 模塊，因為他只是一個 flutter 的模塊，而在 Android 主項目只能集成子 Android module，那么具體改怎么做呢，下面就來看看其中的奧秘）

按照官方的操作方法，會要求我們添加以下配置到 settings.gradle 中。

// Include the host app project.
include ':app'                                    // assumed existing content
setBinding(new Binding([gradle: this]))                                // new
evaluate(new File(                                                     // new
  settingsDir.parentFile,                                              // new
  'my_flutter/.android/include_flutter.groovy'                         // new
))                                                                     // new

首先看看 這里的 settingsDir 的值。在 settings.gradle 中直接添加

println "settings.dir=" + settingsDir
println "settings.dir.parent=" + settingsDir.parent

sync 之后就會看到輸出

settings.dir=/Users/username/Documents/mygithub/MinApp
settings.dir.parent=/Users/username/Documents/mygithub

所以，上面的配置信息，就是說結合 settings 所在目錄的父目錄和我們配置的目錄結合，找到一個名為 include_flutter.groovy 的文件，然后去執(zhí)行他。

前面說了，創(chuàng)建子 module 的時候，可以是在項目根目錄，也可以是在其他位置，如果是在其他位置，這里的 my_flutter 可以替換為你創(chuàng)建目錄的絕對路勁。

這里是在根目錄直接創(chuàng)建的，那么以上的配置就可以簡化為

setBinding(new Binding([gradle: this]))
evaluate(new File(settingsDir, 'sub_flutter/.android/include_flutter.groovy'))
include ':sub_flutter'
#### 關于 include_flutter.groovy

上面說了，settings.gradle 的配置，其實就是去執(zhí)行 include_flutter.groovy 這個文件，可以簡單看一下這個文件

def scriptFile = getClass().protectionDomain.codeSource.location.toURI()
def flutterProjectRoot = new File(scriptFile).parentFile.parentFile
 
gradle.include ":flutter"
gradle.project(":flutter").projectDir = new File(flutterProjectRoot, ".android/Flutter")
 
def localPropertiesFile = new File(flutterProjectRoot, ".android/local.properties")
def properties = new Properties()
 
assert localPropertiesFile.exists(), ":exclamation:️The Flutter module doesn't have a `$localPropertiesFile` file." +
                                     "\nYou must run `flutter pub get` in `$flutterProjectRoot`."
localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) }
 
def flutterSdkPath = properties.getProperty("flutter.sdk")
assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
gradle.apply from: "$flutterSdkPath/packages/flutter_tools/gradle/module_plugin_loader.gradle"

.android 其實就是一個 Android 項目，他包含一個 Flutter 文件夾，這 Flutter 是一個 library 類型的 Android module ，這個一點從他的 build.gradle 文件就可以看出。 include_flutter.groovy 所做的事情，就是將當前 library 命名為 flutter 的一個 moudle。然后檢查項目中 local.properties 中 sdk 的相關配置，最后去執(zhí)行 FlutterSDK 的中 gradle 腳本，這里具體的分析就不再展開了。

也就是說，現(xiàn)在有一個名為 flutter 的 Android Library Module 。這個 module 包含 flutter 的所有配置。我們如果依賴了這個 module ,那么就相當于是依賴了 Flutter .

依賴 flutter

最后在原生項目的 application-module 的 build.gradle 的 dependencies 閉包中添加

implementation project(':flutter')

至此，原生項目已經有了 Flutter 的依賴，可以使用 Flutter 的 View 了。

至此，現(xiàn)在的原生項目就包含 Flutter SDK 的所有依賴了，UI 相關的內容，改怎么寫還是用 dart 在 main.dart 中寫，然后我們就可以把這個 dart 渲染出來的內容按照 Activity 、Fragment 或 View 的形式添加到已有的項目中了。

flutter pub get

flutter pub get 或者 pub get 是在做 flutter 的時候在使用第三方 lib 或版本更新的時候經常會使用一個命令，通過這個命令會拉取相關的依賴，其實這個命令還會自動生成 Android 和 iOS 的原生項目。比如在我們創(chuàng)建就的 sub_flutter 模塊中，均自動生成了 .android 和 .ios 的原生項目目錄。同時這兩個目錄都是點打頭的，那么一般情況下就是隱藏文件，同時通過 .gitignore 文件也可以看到，對于 flutter module 形式來說，這兩個文件夾都是被忽略的，畢竟 flutter module 的核心，還是為了方便以 module 的形式集成到原生的項目中，內部的兩個原生目錄，一方面是為了方便集成，另一方面是便于直接運行執(zhí)行 hot-reload 的調試。

以上就是Android原生項目集成Flutter解決方案的詳細內容，更多關于Android集成Flutter的資料請關注腳本之家其它相關文章！

最新評論