了解一下如何在 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>

結(jié)果

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,054msWrote 11 files.

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

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

在配置 settings.gradle 之前先來簡單回顧一下關(guān)于 Gradle 的一些基礎(chǔ)知識。

如果你了解過 Gradle 相關(guān)的配置的話，一定會看到一個概念，就是 約定優(yōu)于配置 ，什么意思呢，按照面向?qū)ο蟮乃悸穪砝斫猓恳粋€工程是一個巨大的 Project 類，整個類里有很多的屬性。而我們創(chuàng)建的每一個項目其實就是一個具體的 Project 對象（也就是實例).約定優(yōu)于配置的意思，就是在 project 實例化的時候，其內(nèi)部的屬性已經(jīng)有了默認(rèn)值。那么我們怎么知道有哪些默認(rèn)值呢？在項目根目錄執(zhí)行

./gradlew properties

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

------------------------------------------------------------Root project------------------------------------------------------------ allprojects: [root project ’MiniApp’, project ’:app’, project ’:thirdlib’]android.agp.version.check.performed: trueandroid.enableJetifier: trueandroid.enableR8: trueandroid.enableR8.libraries: trueandroid.useAndroidX: truebuildDir: /Users/username/Documents/mygithub/MinApp/buildbuildFile: /Users/username/Documents/mygithub/MinApp/build.gradleprojectDir: /Users/username/Documents/mygithub/MinApprootDir: /Users/username/Documents/mygithub/MinApprootProject: root project ’MiniApp’

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

執(zhí)行

./gradlew :app:properties

節(jié)選部分結(jié)果

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

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

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

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

// Include the host app project.include ’:app’ // assumed existing contentsetBinding(new Binding([gradle: this]))// newevaluate(new File( // new settingsDir.parentFile, // new ’my_flutter/.android/include_flutter.groovy’ // new)) // new

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

println 'settings.dir=' + settingsDirprintln 'settings.dir.parent=' + settingsDir.parent

sync 之后就會看到輸出

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

所以，上面的配置信息，就是說結(jié)合 settings 所在目錄的父目錄和我們配置的目錄結(jié)合，找到一個名為 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’#### 關(guān)于 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 ，這個一點(diǎn)從他的 build.gradle 文件就可以看出。 include_flutter.groovy 所做的事情，就是將當(dāng)前 library 命名為 flutter 的一個 moudle。然后檢查項目中 local.properties 中 sdk 的相關(guān)配置，最后去執(zhí)行 FlutterSDK 的中 gradle 腳本，這里具體的分析就不再展開了。

也就是說，現(xiàn)在有一個名為 flutter 的 Android Library Module 。這個 module 包含 flutter 的所有配置。我們?nèi)绻蕾嚵诉@個 module ,那么就相當(dāng)于是依賴了 Flutter .

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

implementation project(’:flutter’)

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

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

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

以上就是Android原生項目集成Flutter解決方案的詳細(xì)內(nèi)容，更多關(guān)于Android集成Flutter的資料請關(guān)注好吧啦網(wǎng)其它相關(guān)文章！