Flutter/engine 1.0 修復版介紹
tags: flutter engine memory leak fix natoto 內(nèi)存泄漏 循環(huán)引用
團隊在0.9.4 版本解決了一系列循環(huán)引用宙拉，但是代碼不能上傳津畸，由于flutter和engine的限制逞敷，必須flutter版本號和engine的commit號要保持一致绎狭，提交了將導致commit號不一致的問題，導致運行失敗侥涵，官方號稱1.0解決了循環(huán)引用沼撕，下載了一看，令人失望芜飘，還是沒有徹底解決务豺，于是決定
自己動手,豐衣足食，經(jīng)過了幾天痛苦的下載編譯嗦明，調(diào)試笼沥，測試，終于把內(nèi)存降下來了。
廣告一下
紙上得來終覺淺敬拓，實踐之后才真懂
建了一個flutter qq群邻薯，群號:217429001 有興趣的加入哦
歡迎關(guān)注
姊妹篇《手把手教你編譯Flutter engine》
最新消息： flutter內(nèi)存泄漏問題，現(xiàn)在可以使用官方清理方式了
見 flutter.framework FlutterEngine里面的 destroyContext
-------------------------------------------------------- 歷史的分割線 -------------------------------------
官方flutter的大麻煩
google團隊的大bug,個人認為內(nèi)存是很重要的乘凸，尤其是集成到現(xiàn)有app中的方式厕诡。
https://github.com/flutter/flutter/issues/24714
https://github.com/flutter/flutter/issues/23231
https://github.com/flutter/flutter/issues/25255
https://github.com/flutter/engine/pull/6879
https://github.com/flutter/flutter/issues/16995
flutter 1.0 解決了FlutterViewController的循環(huán)引用問題，但是把循環(huán)引用的問題轉(zhuǎn)嫁到了FlutterEngine上面营勤，下面手把手教你如何解決1.0的循環(huán)引用灵嫌。
如何找到內(nèi)存泄漏
為什么google難以解決
由于整個FlutterEngine是用MRC的方式編寫，所以內(nèi)存管理比較困難葛作，每個變量生成retain寿羞，都需要被release，如果一個實例retain了兩次赂蠢，只release一次绪穆，也會導致無法釋放，如果設(shè)置了autorelease虱岂，就有可能提前釋放玖院，導致badasses，訪問野指針第岖。
客觀原因难菌，一般的應用只會創(chuàng)建一個flutter應用，或者干脆就直接都是flutter應用蔑滓，不釋放就不釋放郊酒，多點內(nèi)存也無所謂，不影響崩潰键袱，不影響使用燎窘，所以google照常發(fā)布1.0版。
現(xiàn)狀
每次進去都會新增幾十M然而當退出flutterViewController的時候杠纵，內(nèi)存僅僅下降2m左右荠耽，還有幾十兆保留在內(nèi)存中钩骇。下降的部分就是flutterviewcontroller比藻，從程序運行到了dealloc可以證明。
修改結(jié)果
修改后的framework下載列表
1.0版engine arm64 debug下載 https://github.com/Natoto/flutterOnExistApp/blob/multiflutter/flutterOnExistApp/Resources/Flutter.framework.zip
其他版本打包發(fā)布github 地址
https://github.com/Natoto/fixFlutterEngine
下面將一步步帶領(lǐng)大家找到循環(huán)引用倘屹，解決循環(huán)引用银亲，這一步可能比較繁瑣，如果不愿看推理過程纽匙，可以直接跳到文末獲取構(gòu)建后的framework务蝠。
使用flutterViewController
/**
* 加載boundle資源
*/
- (void)handleBoundleResource {
NSString * path = [[NSBundle mainBundle] pathForResource:@"flutter_assets" ofType:@""];
NSURL * url = [NSURL URLWithString:path];
FlutterDartProject * dart = [[FlutterDartProject alloc] init];
if (!self.engine) {
FlutterEngine * engine = [[FlutterEngine alloc] initWithName:path.lastPathComponent project:dart];
[engine runWithEntrypoint:nil];
self.engine = engine;
}
FlutterViewController* flutterViewController = [[FlutterViewController alloc] initWithEngine:self.engine nibName:nil bundle:nil];
[GeneratedPluginRegistrant registerWithRegistry:flutterViewController];
[self addBackButton:flutterViewController];
[flutterViewController setInitialRoute:@"route1"];
[self presentViewController:flutterViewController animated:YES completion:nil];
}
flutterEngine, flutter官方推薦方式是自己管理flutterEngine，然后flutterviewcontroller是可以獨自創(chuàng)建和釋放烛缔，FlutterEngine是新1.0引進馏段，用于管理所有的metchodChannel轩拨，就是維護所有的方法消息，生命周期等作用院喜。也是要解決它的引用問題亡蓉。
執(zhí)行engine runwithEntrypoint可以啟動engine vm。
FlutterDartProject 用于配置啟動參數(shù)喷舀，默認可以直接new砍濒，或者從bundle啟動，找boundle下面的的flutter_assets文件夾硫麻，或直接導入App.framework
FlutterViewController用來顯示flutter工程的爸邢，所有的界面都是在其上面渲染出來的。跟普通的UIViewController一樣拿愧，可以present出來杠河，或者push出來。
Flutter的入口
plugin是flutter的入口浇辜，這個入口可以連接flutter和原生代碼
比如自帶的GeneratedPluginRegistrant感猛，將flutter工程中用到的插件都集中注冊到原生
@implementation GeneratedPluginRegistrant
+ (void)registerWithRegistry:(NSObject<FlutterPluginRegistry>*)registry {
[FlutterWebviewPlugin registerWithRegistrar:[registry registrarForPlugin:@"FlutterWebviewPlugin"]];
[FLTPathProviderPlugin registerWithRegistrar:[registry registrarForPlugin:@"FLTPathProviderPlugin"]];
[FLTSharedPreferencesPlugin registerWithRegistrar:[registry registrarForPlugin:@"FLTSharedPreferencesPlugin"]];
}
@end
介紹上面兩個是為了找到斷點入口
如何設(shè)flutter斷點
為了方便調(diào)試，可以在編譯現(xiàn)有工程的時候替換flutter.framework
具體做法是在build phases 中創(chuàng)建一個腳本奢赂，用自己編譯的engine中的flutter.framework替換 .ios/engine/Flutter.framework
替換完之后則可以設(shè)置symbol斷點了陪白，如下
或者用lldb命令設(shè)置斷點 br xxxx lldb傳送門
幾個疑點
從目前的情況來看engine沒有被釋放，就是FlutterEngine.mm FlutterChannel.mm 和 PluginRegister直接的關(guān)系混亂了
有兩點情況
- 互相引用
- 內(nèi)部引用沒有release
- 多次retain
- block是否使用的__block引用
- 主動destory
- 編譯膳灶，看dealloc
從0.9.4經(jīng)驗來看咱士，需要手動destory一下，destory完成這個類中變量的release
以上五個過程需要不斷的循環(huán)重試轧钓，過程比較長序厉。。
方法論說完了毕箍，下面直接說我的幾天試錯結(jié)果弛房。共計10個文件，核心的地方貼一下
maybesetupPlatformViewChannels在flutterengine里面而柑，啟動默認平臺changnle和方法回調(diào)
重心文捶，F(xiàn)lutterChannel.mm里面 FlutterMethodChannel，flutter每個plugin的方法都會經(jīng)過通過register注冊一個channel媒咳，然而粹排，messger是register，不應該被持有或autorelease的涩澡，所以這樣做是會造成提前釋放或無法釋放的
對應于其他的channel也是用了messager顽耳，會有相同的問題。改造這些基本上就能解除大循環(huán)了。
總結(jié)engine的大循環(huán)引用
如何使用
有兩種方法
替換flutter里面的framework
路徑如下
/Users/boo/Documents/flutter/bin/cache/artifacts/engine/ios
不用擔心是否會破壞之前發(fā)flutter.framework射富，如果想用回官方的直接解壓同文件夾里面的.zip文件即可工程中用zip膝迎，解壓成framework替換掉真正從官方復制過來的flutter.framework
適用于 arm64真機
工程配置添加sh腳本
#R.replace.engine
cd "${SRCROOT}/flutterOnExistApp/Resources/"
unzip -u Flutter.framework.zip
cp -rf "${SRCROOT}/flutterOnExistApp/Resources/Flutter.framework" "${SRCROOT}/myflutter/.ios/Flutter/engine"
修改后代碼
修改的文件放在1.0engine修改的文件，可以直接替換使用并構(gòu)建自己的framework
- 1.0 修改的代碼地址 https://github.com/Natoto/flutterOnExistApp/tree/multiflutter/1.0engine%E4%BF%AE%E6%94%B9%E7%9A%84%E6%96%87%E4%BB%B6
- github demo 工程
https://github.com/Natoto/flutterOnExistApp/tree/multiflutter
- 1.0版engine arm64 debug下載 https://github.com/Natoto/flutterOnExistApp/blob/multiflutter/flutterOnExistApp/Resources/Flutter.framework.zip
打包framework
看一下構(gòu)建后結(jié)果
如構(gòu)建debug版的engine如下路徑或生產(chǎn)一個framework胰耗，這個通過執(zhí)行all.wxworkspace生成的弄抬，注意arm架構(gòu)，如果選target是真機宪郊，則會生成arm64架構(gòu)framework
/Users/boo/Documents/engine/src/out/ios_debug/Flutter.framework
這個可以直接替換掉工程中原有的framework
構(gòu)建release framework類似掂恕。
詳細步驟可以參考《手把手教你編譯Flutter engine》
YY Flutter技術(shù)積累相關(guān)鏈接
一行代碼教你解決FlutterPlatformViews內(nèi)存泄露 by
AShawn
手把手教你在Flutter項目優(yōu)雅的使用ORM數(shù)據(jù)庫 by
williamwen1986
flutter通用基礎(chǔ)庫flutter_luakit_plugin by
williamwen1986
github - flutter_luakit_plugin使用例子 by
williamwen1986
手把手教你解決 Flutter engine 內(nèi)存泄漏 by 共田君
github - 編譯產(chǎn)物下載 修復內(nèi)存泄漏后的flutter engine（可直接使用）by 共田君</font>
github demo - 修復內(nèi)存泄漏后的flutter engine by 共田君
持續(xù)更新中...
