一、創建一個Flutter模塊
cd some/path/
flutter create --template module my_flutter
上述命令讓我們在some/path/my_flutter/目錄下創建了一個Flutter模塊工程,在這個目錄下,我們可以向在其他Flutter獨立工程一樣執行一些flutter命令,如:flutter run --debug或flutter build ios。你也可以在Android Studio/IntelliJ或VS代碼中使用Flutter和Dart插件運行這個模塊工程。此項目包含一個模塊的單視圖示例版本,它是一個被嵌入到現有的app之前的版本,這有助于你的代碼中的純Flutter部分的增量測試。
二、模塊項目結構
my_flutter模塊目錄結構和普通的Flutter應用程序類似:
my_flutter/
├── .ios/
│ ├── Runner.xcworkspace
│ └── Flutter/podhelper.rb
├── lib/
│ └── main.dart
├── test/
└── pubspec.yaml
將Dart代碼添加到lib/目錄中。
將Flutter dependencies添加到my_flutter/pubspec。包括Flutter packages 和 plugins。
.ios隱藏文件夾包含一個Xcode workspace,在那里你可以獨立運行你的模塊工程 。它是一個用于引導Flutter代碼的包裝器項目,并包含幫助腳本,以方便構建框架或使用CocoaPods將模塊工程嵌入到現有的應用程序中。
注意:將自定義的iOS代碼添加到您現有的應用程序項目或插件中,而不是添加到模塊的.iOS /目錄中。在模塊的.iOS /目錄中所做的更改不會出現在使用該模塊的現有iOS項目中,而是會被Flutter覆蓋。
不要對.ios/目錄進行源代碼控制,因為它是自動生成的。在新機器上構建模塊之前,在使用flutter模塊構建iOS項目之前,先在my_flutter目錄下運行flutter pub get來重新生成. iOS /目錄。
三、將Flutter模塊嵌入到現有App的中
有兩種方法可以將Flutter嵌入到現有的App中。
- 1.app的CocoaPods和本地Flutter SDK。(推薦)。
- 2.全本地管理:將Flutter engine、編譯的Dart代碼、Flutter plugins打包生成frameworks,然后手動嵌入frameworks,并在Xcode中更新構建設置。
使用Flutter會增加包體積
1、使用CocoaPods+本地Flutter SDK
每個開發人員都有一個本地安裝的Flutter SDK版本。簡單地在Xcode中構建你的應用程序就能自動運行腳本嵌入你的Dart和插件代碼。這種方案能然你只用Xcode就能快速迭代最新的Flutter模塊。
下面的示例假設您的現有應用程序和Flutter模塊位于同級目錄中。如果您有一個不同的目錄結構,您可能需要調整相對路徑。
some/path/
├── my_flutter/
│ └── .ios/
│ └── Flutter/
│ └── podhelper.rb
└── MyApp/
└── Podfile
- 給Podfile添加代碼
flutter_application_path = '../my_flutter'
load File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')
- 給每一個用到Flutter的target添加
install_all_flutter_pods(flutter_application_path)
- 給每一個用到Flutter的target添加
target 'MyApp' do
install_all_flutter_pods(flutter_application_path)
end
- pod install
當你改變my_flutter/pubspec.yaml文件里面Flutter插件依賴關系時,需要在你的Flutter模塊工程目錄下執行flutter pub get刷新由podhelper.rb腳本讀取的插件列表。然后在原工程目錄some/path/MyApp上再pod install。
- pod install
podhelper.rb腳本:把你的plugins、Flutter.framework、App.framework嵌入項目
build configurations:分別嵌入Debug/Release/Profile模式下的Flutter
2、使用frameworks+手動嵌入
生成frameworks,并通過手動編輯現有的Xcode項目的方式將它們嵌入到App中。
使用場景:您的團隊成員不能在本地安裝Flutter SDK和CocoaPods,或者不想使用CocoaPods管理。
缺點:在flutter模塊中,每做一次代碼更改你都必須運行一次flutter build ios-framework。
1.生成frameworks
下面的例子假設你想生成frameworks到some/path/MyApp/Flutter/目錄。
flutter build ios-framework --output=some/path/MyApp/Flutter/
some/path/MyApp/
└── Flutter/
├── Debug/
│ ├── Flutter.framework
│ ├── App.framework
│ ├── FlutterPluginRegistrant.framework (only if you have plugins with iOS platform code)
│ └── example_plugin.framework (each plugin is a separate framework)
├── Profile/
│ ├── Flutter.framework
│ ├── App.framework
│ ├── FlutterPluginRegistrant.framework
│ └── example_plugin.framework
└── Release/
├── Flutter.framework
├── App.framework
├── FlutterPluginRegistrant.framework
└── example_plugin.framework
注意:import的Flutter.framework 和 App.framework路徑要保持一致,否則會導致runtime crashes(例如Profile/Flutter.framework 和 Debug/App.framework)
Tip:Xcode 11后,可以通過添加標志--xcframework --no-universal來生成XCFrameworks而不是通用框架。
2.將生成的frameworks嵌入并鏈接到Xcode中
鏈接frameworks
- 1.拖拽some/path/MyApp/Flutter/Release/ 下的frameworks到targets’ build settings > Build Phases > Link Binary With Libraries.
- 2.在target’s build settings的Framework Search Paths添加$(PROJECT_DIR)/Flutter/Release/
嵌入frameworks
- 拖拽framework到targets’ build settings > Build Phases > Embed Frameworks,選擇Embed & Sign
動態庫必須嵌入app以便在runtime時加載。Plugins可以生成靜態或動態框架。靜態框架應該鏈接,而不是嵌入。如果你嵌入一個靜態框架到你的應用程序,你的app將不能發布到App Store,并報一個archive error:Found an unexpected Mach-O header code。
Tip:為了適配不同模式,需要更改:
1.在MyApp.xcodeproj/project.pbxproj里面把path = Flutter/Release/example.framework;改為path = "Flutter/$(CONFIGURATION)/example.framework";
2.在Framework Search Paths添加$(PROJECT_DIR)/Flutter/$(CONFIGURATION)
還可以綜合方案1、2。用CocoaPods管理Flutter,手動嵌入frameworks。
總結:混合項目 有兩種方式:使用CocoaPods+本地Flutter SDK、使用frameworks+手動嵌入。