騰訊翻譯君Android客戶端集成Flutter Module的探索

前言

這篇文章介紹翻譯君客戶端如何在現有的原生App中加入一些flutter頁面,把已有的工程改造成flutter和native結合的App。
目前翻譯君App中已經應用了大量Flutter頁面,性能良好。
分享出來,如果有好的方案可以互相交流。

集成方案

如果需要本地開發,可前往flutter.io下載SDK并配置環境變量。
在配置完Flutter環境之后,如果通過IDE或者CML創建一個Flutter Application,目錄結構是這樣的:

Project
├── android //原生android app目錄
├── assets // dart引用的資源文件,比如圖片
├── build
├── gen
├── ios //原生iOS app目錄
├── lib //dart代碼目錄
├── pubspec.lock
└── pubspec.yaml //包管理工具pub

這是一個完全通過Flutter構建的App,入口也是Flutter的lib目錄下的main.dart;那么通過在lib目錄編寫dart代碼,就可以通過flutter run命令生成Android和iOS安裝包安裝運行。對于Android來講,是通過flutter.gradle來添加flutter.jar和vm/isolate_snapshot_data/instr,用它們編譯lib中的dart代碼,嵌入App中運行的。

那如果想要在已有的App里增加一些flutter頁面,根據上面的目錄結構,可以有兩種思路:

graph1. dependecy

左邊的方案,是在普通的Flutter Application的基礎上,把已有的Application替換到Flutter Project的子目錄;國內較早使用混合flutter開發較多的團隊使用的一般是左邊這種方案。后來大家也發現了這種方案的弊端,也就是耦合嚴重導致的開發效率降低。于是很多團隊都有自己的方案進行依賴清理,達到右邊這種集成方式。
好處是:
1)Native工程可以獨立構建,也可以迅速與flutter模塊交互,實現「熱插拔」。并且,jenkins打包也不再一定需要flutter環境。

2)Flutter工程可以通過flutter attach在chrome中進行調試,hot reload等等。如果使用Android Studio,并且把flutter模塊作為子目錄,無需打開兩個IDE,可在一個窗口中寫native代碼和dart代碼。

有興趣的同學,可以參考閑魚早期的方案

好的集成方案

好消息是,Flutter團隊也意識到了這個問題,大家可能一開始只是想在已有原生工程中集成flutter,而不是寫一個純flutter的app。所以,他們也在緊鑼密鼓地制定更簡單的集成方案

翻譯君使用了Flutter提供的創建模塊的方式來構造flutter模塊,可以參考Add Flutter to existing apps
也就是,使用$ flutter create -t module my_flutter創建flutter模塊。
這樣就直接實現了上面圖1右邊的剝離的flutter模塊帶來的種種好處。

注意,生成的Flutter Module可以放在Android、iOS原生工程的外面,也可以放在原生工程的內部,使用git submodule來管理,兩種方案各有優劣,可以自行選擇。放在外面的好處是在本地同一臺機器開發的時候,Android、iOS工程可以依賴同一個Flutter目錄,方便修改和調試;放在目錄內部作為git submodule的好處是,可以在同一個IDE窗口中開發調試native和dart代碼。

源碼依賴和aar依賴,打包

  1. 源碼依賴
    源碼依賴的優點是開發、調試方便,也就是在settings.gradlebuild.gradle里加入對創建的flutter模塊的依賴即可,可參考上面的鏈接。
// MyApp/settings.gradle
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
  1. aar依賴
    那如果需要用jenkins/RDM遠程打包,遠程的機器上沒有flutter環境,就可以把flutter和一些plugin打包成aar文件進行依賴。可以進入Flutter目錄和plugin目錄,分別運行./gradlew assembleDebug/assembleRelease來生成aar文件,再在主工程里引用,flutter aar中包含了flutter sdk的代碼,所以這種方式是不需要flutter環境的,也適合第三方快速接入。

由于這兩種方式只是在 settings.gradleapp/build.gradle中有一些差別,所以可以利用腳本實現快速切換兩種打包方式,切換完成之后sync即可。

flutter/native混合頁面跳轉

使用了stack manager實現native/flutter頁面跳轉,原理簡單講就是使用openurl來路由nativeflutter頁面,比如hrd://profile_page代表個人信息頁。在flutternative側各有一個路由中心來控制分發。

這種方式的優勢是在混合頁面比較多的情況下可以方便地管理跳轉,通過截圖手段減少了跳轉的白屏/黑屏現象;缺點是少量修改了flutter sdk里的源碼,以及使用起來比較麻煩,比如參數傳遞的功能實現得并不是很完善,我fork了一份對它進行了少量修改,它的原工程寫得蠻厲害的,我覺得大家可以在原工程的代碼上做適合自己的精簡或者優化。

另外,我認為如果新增的flutter頁面居多,可以盡量多用flutter本身的跳轉方式,無需采用Activity代理的方式,這樣性能更好也更方便。

調試和hot reload

作為模塊導入的flutter工程也是可以調試和hot reload的,但不能直接在IDE中進行,需要借助Observatory在瀏覽器中進行。
在flutter工程目錄下運行CML,輸入flutter attach。如果無法attach,可以重啟VM或者檢查代理。
打開一個flutter頁面,CML提示An Observatory debugger and profiler on Android SDK built for x86 is available at: http://127.0.0.1:55428/。
在CML窗口按下r可以hot reload, 按下R可以hot restart。
在chrome地址欄輸入http://127.0.0.1:55428/,可以進入Observatory進行debug等操作。

插件(plugin)管理

Plugin Packages插件可以放在flutter模塊的子目錄比如plugins通過yaml依賴,這樣,在源碼依賴的時候,主工程的gradle會自動通過flutter.gradle識別插件中包含的原生工程代碼。

graph2. plugin packages

如果需要提供橋接,可以通過注冊監聽器的方式來規避雙向依賴的問題;比如插件中需要引用外部工程的代碼,這肯定是不合適的,這種情況就可以通過接口回調的方式實現flutter對native功能的調用。

一些issues

  1. ./gradlew build的時候提示找不到product_vm_isolate_snapshot.bin的問題。這個應該是flutter本身的問題。已提issue。可以執行gradlew assembleDebug/assembleRelease規避。
  2. 找不到icudtl.dat的問題。這個也是一個flutter的issue,貌似仍未解決(flutter團隊更新0.9+以后以為解決了其實并沒有),目前可以通過手動拷貝它到assets/flutter_shared/目錄規避。
  3. "flutter/runtime/dart_vm.ccVM snapshot must be valid/ duplicated resources"之類的問題,可通過手動刪除app/build目錄進行規避。

目前簡單總結了這么多,有問題可以多多交流。

https://github.com/chaangliu

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

推薦閱讀更多精彩內容

  • 用兩張圖告訴你,為什么你的 App 會卡頓? - Android - 掘金 Cover 有什么料? 從這篇文章中你...
    hw1212閱讀 12,822評論 2 59
  • 夏天,羊羊再一次搬家了,大人們忙里忙外,小孩子盡量不往前湊,避免大人們將煩躁發泄在他們身上。 1,2,3。。第六次...
    走邊關的蒲公英閱讀 275評論 5 0
  • 上回書說到,約瑟發現,給埃及國王法老敬酒的那個朋友,不會來救自己了,很失望,上帝跟他說,不要著急,法老是國王,你覺...
    GodFatherPaul閱讀 791評論 0 0
  • 野蠻撕裂骨架的組合喇叭吹出火焰山大氣在燃燒天是個倒過來的鍋飛行器劃過的痕跡這是大廚用鏟子翻滾天鍋煙火緩緩散去去與白...
    一元真人閱讀 240評論 0 3