手把手教你解決 Flutter engine 內(nèi)存泄漏

Flutter/engine 1.0 修復(fù)版介紹

tags: flutter engine memory leak fix natoto 內(nèi)存泄漏 循環(huán)引用

團(tuán)隊(duì)在0.9.4 版本解決了一系列循環(huán)引用，但是代碼不能上傳，由于flutter和engine的限制，必須flutter版本號(hào)和engine的commit號(hào)要保持一致，提交了將導(dǎo)致commit號(hào)不一致的問(wèn)題，導(dǎo)致運(yùn)行失敗，官方號(hào)稱1.0解決了循環(huán)引用，下載了一看，令人失望，還是沒(méi)有徹底解決，于是決定自己動(dòng)手,豐衣足食 ，經(jīng)過(guò)了幾天痛苦的下載編譯，調(diào)試，測(cè)試，終于把內(nèi)存降下來(lái)了。

廣告一下
紙上得來(lái)終覺(jué)淺，實(shí)踐之后才真懂
建了一個(gè)flutter qq群，群號(hào):217429001 有興趣的加入哦

歡迎關(guān)注
姊妹篇《手把手教你編譯Flutter engine》

最新消息： flutter內(nèi)存泄漏問(wèn)題，現(xiàn)在可以使用官方清理方式了

見(jiàn) flutter.framework FlutterEngine里面的 destroyContext

-------------------------------------------------------- 歷史的分割線 -------------------------------------

官方flutter的大麻煩

google團(tuán)隊(duì)的大bug,個(gè)人認(rèn)為內(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

image.png
image.png

flutter 1.0 解決了FlutterViewController的循環(huán)引用問(wèn)題，但是把循環(huán)引用的問(wèn)題轉(zhuǎn)嫁到了FlutterEngine上面，下面手把手教你如何解決1.0的循環(huán)引用。

如何找到內(nèi)存泄漏

為什么google難以解決

由于整個(gè)FlutterEngine是用MRC的方式編寫，所以內(nèi)存管理比較困難，每個(gè)變量生成retain，都需要被release，如果一個(gè)實(shí)例retain了兩次，只release一次，也會(huì)導(dǎo)致無(wú)法釋放，如果設(shè)置了autorelease，就有可能提前釋放，導(dǎo)致badasses，訪問(wèn)野指針。

客觀原因，一般的應(yīng)用只會(huì)創(chuàng)建一個(gè)flutter應(yīng)用，或者干脆就直接都是flutter應(yīng)用，不釋放就不釋放，多點(diǎn)內(nèi)存也無(wú)所謂，不影響崩潰，不影響使用，所以google照常發(fā)布1.0版。

現(xiàn)狀

每次進(jìn)去都會(huì)新增幾十M然而當(dāng)退出flutterViewController的時(shí)候，內(nèi)存僅僅下降2m左右，還有幾十兆保留在內(nèi)存中。下降的部分就是flutterviewcontroller，從程序運(yùn)行到了dealloc可以證明。

修改結(jié)果

這是修改后的文件

修改后的framework下載列表

下面將一步步帶領(lǐng)大家找到循環(huán)引用，解決循環(huán)引用，這一步可能比較繁瑣，如果不愿看推理過(guò)程，可以直接跳到文末獲取構(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是可以獨(dú)自創(chuàng)建和釋放，FlutterEngine是新1.0引進(jìn)，用于管理所有的metchodChannel，就是維護(hù)所有的方法消息，生命周期等作用。也是要解決它的引用問(wèn)題。
執(zhí)行engine runwithEntrypoint可以啟動(dòng)engine vm。

FlutterDartProject 用于配置啟動(dòng)參數(shù)，默認(rèn)可以直接new，或者從bundle啟動(dòng)，找boundle下面的的flutter_assets文件夾，或直接導(dǎo)入App.framework

FlutterViewController用來(lái)顯示flutter工程的，所有的界面都是在其上面渲染出來(lái)的。跟普通的UIViewController一樣，可以present出來(lái)，或者push出來(lái)。

Flutter的入口

plugin是flutter的入口，這個(gè)入口可以連接flutter和原生代碼
比如自帶的GeneratedPluginRegistrant，將flutter工程中用到的插件都集中注冊(cè)到原生

@implementation GeneratedPluginRegistrant

+ (void)registerWithRegistry:(NSObject<FlutterPluginRegistry>*)registry {
  [FlutterWebviewPlugin registerWithRegistrar:[registry registrarForPlugin:@"FlutterWebviewPlugin"]];
  [FLTPathProviderPlugin registerWithRegistrar:[registry registrarForPlugin:@"FLTPathProviderPlugin"]];
  [FLTSharedPreferencesPlugin registerWithRegistrar:[registry registrarForPlugin:@"FLTSharedPreferencesPlugin"]];
}

@end

介紹上面兩個(gè)是為了找到斷點(diǎn)入口

如何設(shè)flutter斷點(diǎn)

為了方便調(diào)試，可以在編譯現(xiàn)有工程的時(shí)候替換flutter.framework
具體做法是在build phases 中創(chuàng)建一個(gè)腳本，用自己編譯的engine中的flutter.framework替換 .ios/engine/Flutter.framework

替換腳本

替換完之后則可以設(shè)置symbol斷點(diǎn)了，如下

設(shè)置斷點(diǎn)

或者用lldb命令設(shè)置斷點(diǎn) br xxxx lldb傳送門

幾個(gè)疑點(diǎn)

從目前的情況來(lái)看engine沒(méi)有被釋放，就是FlutterEngine.mm FlutterChannel.mm 和 PluginRegister直接的關(guān)系混亂了
有兩點(diǎn)情況

  1. 互相引用
  2. 內(nèi)部引用沒(méi)有release
  3. 多次retain
  4. block是否使用的__block引用
  5. 主動(dòng)destory
  6. 編譯，看dealloc
    從0.9.4經(jīng)驗(yàn)來(lái)看，需要手動(dòng)destory一下，destory完成這個(gè)類中變量的release
    以上五個(gè)過(guò)程需要不斷的循環(huán)重試，過(guò)程比較長(zhǎng)。。

方法論說(shuō)完了，下面直接說(shuō)我的幾天試錯(cuò)結(jié)果。共計(jì)10個(gè)文件，核心的地方貼一下

maybesetupPlatformViewChannels

maybesetupPlatformViewChannels在flutterengine里面，啟動(dòng)默認(rèn)平臺(tái)changnle和方法回調(diào)

image.png

重心，F(xiàn)lutterChannel.mm里面 FlutterMethodChannel，flutter每個(gè)plugin的方法都會(huì)經(jīng)過(guò)通過(guò)register注冊(cè)一個(gè)channel，然而，messger是register，不應(yīng)該被持有或autorelease的，所以這樣做是會(huì)造成提前釋放或無(wú)法釋放的

對(duì)應(yīng)于其他的channel也是用了messager，會(huì)有相同的問(wèn)題。改造這些基本上就能解除大循環(huán)了。

總結(jié)engine的大循環(huán)引用

循環(huán)引用示例

如何使用

有兩種方法

  1. 替換flutter里面的framework
    路徑如下
    /Users/boo/Documents/flutter/bin/cache/artifacts/engine/ios
    不用擔(dān)心是否會(huì)破壞之前發(fā)flutter.framework，如果想用回官方的直接解壓同文件夾里面的.zip文件即可

  2. 工程中用zip，解壓成framework替換掉真正從官方復(fù)制過(guò)來(lái)的flutter.framework
    適用于 arm64真機(jī)

工程配置添加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"
image.png

修改后代碼

修改的文件放在1.0engine修改的文件，可以直接替換使用并構(gòu)建自己的framework

打包framework

看一下構(gòu)建后結(jié)果

engine的文件大小
一種模式的工程大小

如構(gòu)建debug版的engine如下路徑或生產(chǎn)一個(gè)framework，這個(gè)通過(guò)執(zhí)行all.wxworkspace生成的，注意arm架構(gòu)，如果選target是真機(jī)，則會(huì)生成arm64架構(gòu)framework
/Users/boo/Documents/engine/src/out/ios_debug/Flutter.framework

這個(gè)可以直接替換掉工程中原有的framework

構(gòu)建release framework類似。
詳細(xì)步驟可以參考《手把手教你編譯Flutter engine》

YY Flutter技術(shù)積累相關(guān)鏈接

一行代碼教你解決FlutterPlatformViews內(nèi)存泄露 by
AShawn

手把手教你在Flutter項(xiàng)目?jī)?yōu)雅的使用ORM數(shù)據(jù)庫(kù) by
williamwen1986

flutter通用基礎(chǔ)庫(kù)flutter_luakit_plugin by
williamwen1986

github - flutter_luakit_plugin使用例子 by
williamwen1986

手把手教你編譯Flutter engine by 共田君

手把手教你解決 Flutter engine 內(nèi)存泄漏 by 共田君

github - 編譯產(chǎn)物下載 修復(fù)內(nèi)存泄漏后的flutter engine（可直接使用）by 共田君</font>

github demo - 修復(fù)內(nèi)存泄漏后的flutter engine by 共田君

持續(xù)更新中...

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容