Flutter - 在iOS項目中嵌入Flutter模塊

目前在已有的原生APP中嵌入Flutter頁面主要有兩種方案,一種是將原生工程作為Flutter工程的子工程,由Flutter進行統一管理,這種模式稱為統一管理模式。一種是將Flutter工程作為原生工程的子模塊,維持原有的原生工程管理方式不變,這種模式稱為三端分離模式。


圖片.png

三端代碼分離模式的原理是把Flutter模塊作為原生工程的子模塊,從而快速地接入Flutter模塊,降低原生工程的改造成本。

原生iOS集成Flutter
環境要求:
Flutter支持iOS 8.0之后的版本
CocoaPods版本要求在1.10之后

一、創建Flutter模塊

進入原生工程目錄,執行如下命令:

cd path/
flutter create --template module my_flutter

Flutter子工程將會創建在path/my_flutter目錄下,在這個目錄下你可以使用flutter的所有命令進行操作,如flutter run --debug或者flutter build ios等。這個子工程包含一個單頁面示例,可以單獨測試該模塊。
目錄結構大致如下:

圖片.png

之后就可以在path/my_flutter/lib/編寫Dart代碼了
path/my_flutter/pubspec.yaml文件中添加Flutter依賴包或者插件
.ios目錄是一個隱藏子文件夾,包含模塊可以獨立運行的內容,其中podhelper.rb這個腳本文件可以幫助使用CocoaPods將依賴的Framework或者嵌入的模塊引入到已有原生工程中。

注意:原生代碼還在原生的結構目錄中進行編寫,不要寫在隱藏目錄.ios目錄之下,如果寫在該目錄下有可能被Flutter重寫掉。隱藏目錄.ios不需要進行源碼管理,該隱藏文件夾是自動生成的。在新機器中運行只需要在path/my_flutter/中執行flutter pub get就又可以自動生成了。
shift + Commond + ,這個快捷鍵可以快速切換隱藏文件的顯隱

二、將Flutter模塊嵌入到原生工程中

有兩種方式:
方式一:使用Cocoapods依賴安裝Flutter SDK(推薦使用)

開放式可以使開發人員有一個本地安裝的Flutter SDK版本,只需要在Xcode中構建應用程序,自動運行的腳本會嵌入Dart和插件代碼。
如果原生工程沒有Podfile,先為工程添加一下。如果已有Podfile
(1)添加如下內容到Podfile文件中:

flutter_application_path = 'my_flutter'
load File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')
圖片.png

(2)在每個Podfile 的target中嵌入Flutter

target 'xxxx' do
  install_all_flutter_pods(flutter_application_path)
end
圖片.png

(3)運行pod install

圖片.png

看到如下內容則嵌入完成,剩下的就是編寫代碼了

podhelper.rb文件將你的插件、Flutter.framework和App.framework嵌入到你的項目中。應用程序的Debug和Release構建配置也會分別嵌入Flutter的Debug和Release構建模式下。Flutter.framework是Flutter的引擎相關bundle,App.framework是項目的編譯的Dart代碼。

注意:當改變Flutter中pubspec.yaml中依賴的插件后,執行flutter pub get刷新插件列表,也會通過podhelp.rb腳本,在原生工程中需要重新執行以下pod install操作

方式二:將Flutter引擎、編譯的Dart代碼和插件打包成Framework,然后引入工程
該方式可以具體查看官方文檔

三、增加一個Flutter頁面

1、開啟FlutterEngine和FlutterViewController
FlutterEngine充當Dart VM和Flutter運行時的宿主,FlutterViewController連接到一個FlutterEngine,將UIKit輸入時間傳遞到Flutter,并顯示由FlutterEngine渲染的幀。

FlutterEngine和FlutterViewController可能有著相同的生命周期,或者比FlutterViewController的生命周期更長。

注意:通常建議為應用程序預熱一個更長生命周期的FlutterEngine,這是因為:
(1)當展示一個FlutterViewController的時候,第一幀出現的比較快
(2)Flutter和Dart的狀態要比FlutterViewController生命更長一些
(3)在顯示UI之前,您的應用程序和插件可以與Flutter和Dart有一些邏輯交互。

2、創建FlutterEngine
在APP的合適位置創建FlutterEngine,下邊以APP啟動在AppDelete中以暴露屬性的方式進行創建:
在AppDelegate.swift文件中

import UIKit
import Flutter
// Used to connect plugins (only if you have plugins with iOS platform code).
import FlutterPluginRegistrant

@UIApplicationMain
class AppDelegate: FlutterAppDelegate { // More on the FlutterAppDelegate.
  lazy var flutterEngine = FlutterEngine(name: "my flutter engine")

  override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Runs the default Dart entrypoint with a default Flutter route.
    flutterEngine.run();
    // Used to connect plugins (only if you have plugins with iOS platform code).
    GeneratedPluginRegistrant.register(with: self.flutterEngine);
    return super.application(application, didFinishLaunchingWithOptions: launchOptions);
  }
}

在事件或者調用的時候跳轉至FlutterViewController,FlutterViewController使用在AppDelegate中創建的FlutterEngine實例。

/// 按鈕點擊
@objc func showFlutter() {
    let flutterEngine = (UIApplication.shared.delegate as! AppDelegate).flutterEngine
    let flutterViewController =
        FlutterViewController(engine: flutterEngine, nibName: nil, bundle: nil)
    present(flutterViewController, animated: true, completion: nil)
}

到此,已經在iOS應用中嵌入了Flutter頁面,這時候當調用FlutterEngine中的run方法就能夠調到Dart中的main()函數了

3、另外一種選擇,使用隱式FlutterEngine的方式創建FlutterViewController

可以讓FlutterViewController隱式的創建自己的FlutterEngine,不需要提前預熱,這種方式通常并不推薦,因為按需創建FlutterEngine可能會在FlutterViewController呈現和渲染其第一幀的時候有明顯的延遲。這種方式適合用在很少使用Flutter的頁面或者無法確定在何時應該啟動Dart VM的時候。
要讓FlutterViewController在沒有現有FlutterEngine的情況下出現,忽略FlutterEngine的構造,并創建沒有引擎的FlutterViewController,可以如下使用:

func showFlutter() {
  let flutterViewController = FlutterViewController(project: nil, nibName: nil, bundle: nil)
  present(flutterViewController, animated: true, completion: nil)
}

4、使用FlutterAppDelegate

建議使用應用的UIApplicationDelegate子類FlutterAppDelegate,但不是必需的。

FlutterAppDelegate執行的函數如下:

  • 轉發應用程序回調函數,如openURL到插件,如local_auth。
  • 轉發狀態欄輕按(只能在AppDelegate中檢測到)來觸發滾動到頂部的行為。

如果你的應用代理不能直接使FlutterAppDelegate成為一個子類,可以讓你的應用代理實現FlutterAppLifeCycleProvider協議,以確保插件接收到必要的回調。否則,依賴于這些事件的插件可能有未定義的行為。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,362評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,577評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,486評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,852評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,600評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,944評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,944評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,108評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,652評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,385評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,616評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,111評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,798評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,205評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,537評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,334評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,570評論 2 379

推薦閱讀更多精彩內容