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

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


圖片.png

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

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

一药蜻、創(chuàng)建Flutter模塊

進入原生工程目錄瓷式,執(zhí)行如下命令:

cd path/
flutter create --template module my_flutter

Flutter子工程將會創(chuàng)建在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/中執(zhí)行flutter pub get就又可以自動生成了。
shift + Commond + ,這個快捷鍵可以快速切換隱藏文件的顯隱

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

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

開放式可以使開發(fā)人員有一個本地安裝的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中依賴的插件后锥忿,執(zhí)行flutter pub get刷新插件列表牛郑,也會通過podhelp.rb腳本,在原生工程中需要重新執(zhí)行以下pod install操作

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

三、增加一個Flutter頁面

1钉答、開啟FlutterEngine和FlutterViewController
FlutterEngine充當Dart VM和Flutter運行時的宿主础芍,F(xiàn)lutterViewController連接到一個FlutterEngine,將UIKit輸入時間傳遞到Flutter数尿,并顯示由FlutterEngine渲染的幀仑性。

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

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

2豹储、創(chuàng)建FlutterEngine
在APP的合適位置創(chuàng)建FlutterEngine,下邊以APP啟動在AppDelete中以暴露屬性的方式進行創(chuàng)建:
在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淘这,F(xiàn)lutterViewController使用在AppDelegate中創(chuàng)建的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)
}

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

3朦乏、另外一種選擇,使用隱式FlutterEngine的方式創(chuàng)建FlutterViewController

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

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

4、使用FlutterAppDelegate

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

FlutterAppDelegate執(zhí)行的函數(shù)如下:

  • 轉發(fā)應用程序回調函數(shù),如openURL到插件仙畦,如local_auth输涕。
  • 轉發(fā)狀態(tài)欄輕按(只能在AppDelegate中檢測到)來觸發(fā)滾動到頂部的行為。

如果你的應用代理不能直接使FlutterAppDelegate成為一個子類慨畸,可以讓你的應用代理實現(xiàn)FlutterAppLifeCycleProvider協(xié)議莱坎,以確保插件接收到必要的回調。否則寸士,依賴于這些事件的插件可能有未定義的行為檐什。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市弱卡,隨后出現(xiàn)的幾起案子乃正,更是在濱河造成了極大的恐慌,老刑警劉巖谐宙,帶你破解...
    沈念sama閱讀 206,311評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件烫葬,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機搭综,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評論 2 382
  • 文/潘曉璐 我一進店門垢箕,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人兑巾,你說我怎么就攤上這事条获。” “怎么了蒋歌?”我有些...
    開封第一講書人閱讀 152,671評論 0 342
  • 文/不壞的土叔 我叫張陵帅掘,是天一觀的道長。 經(jīng)常有香客問我堂油,道長修档,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,252評論 1 279
  • 正文 為了忘掉前任府框,我火速辦了婚禮吱窝,結果婚禮上,老公的妹妹穿的比我還像新娘迫靖。我一直安慰自己院峡,他們只是感情好,可當我...
    茶點故事閱讀 64,253評論 5 371
  • 文/花漫 我一把揭開白布系宜。 她就那樣靜靜地躺著照激,像睡著了一般。 火紅的嫁衣襯著肌膚如雪盹牧。 梳的紋絲不亂的頭發(fā)上俩垃,一...
    開封第一講書人閱讀 49,031評論 1 285
  • 那天,我揣著相機與錄音欢策,去河邊找鬼吆寨。 笑死赏淌,一個胖子當著我的面吹牛踩寇,可吹牛的內容都是我干的。 我是一名探鬼主播六水,決...
    沈念sama閱讀 38,340評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼俺孙,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了掷贾?” 一聲冷哼從身側響起睛榄,我...
    開封第一講書人閱讀 36,973評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎想帅,沒想到半個月后场靴,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,466評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,937評論 2 323
  • 正文 我和宋清朗相戀三年旨剥,在試婚紗的時候發(fā)現(xiàn)自己被綠了咧欣。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,039評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡轨帜,死狀恐怖魄咕,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情蚌父,我是刑警寧澤哮兰,帶...
    沈念sama閱讀 33,701評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站苟弛,受9級特大地震影響喝滞,放射性物質發(fā)生泄漏。R本人自食惡果不足惜膏秫,卻給世界環(huán)境...
    茶點故事閱讀 39,254評論 3 307
  • 文/蒙蒙 一囤躁、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧荔睹,春花似錦狸演、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至吨拗,卻和暖如春满哪,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背劝篷。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工哨鸭, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人娇妓。 一個月前我還...
    沈念sama閱讀 45,497評論 2 354
  • 正文 我出身青樓像鸡,卻偏偏與公主長得像,于是被迫代替她去往敵國和親哈恰。 傳聞我的和親對象是個殘疾皇子只估,可洞房花燭夜當晚...
    茶點故事閱讀 42,786評論 2 345

推薦閱讀更多精彩內容