手把手教你解決 Flutter engine 內存泄漏

Flutter/engine 1.0 修復版介紹

tags: flutter engine memory leak fix natoto

團隊在0.9.4 版本解決了一系列循環引用，但是代碼不能上傳，由於flutter和engine的限制，必須flutter版本號和engine的commit號要保持一致，提交了將導致commit號不一致的問題，導致運行失敗，官方號稱1.0解決了循環引用，下載了一看，令人失望，還是沒有徹底解決，於是決定自己動手,豐衣足食 ，經過了幾天痛苦的下載編譯，調試，測試，終於把內存降下來了。

歡迎關注
姊妹篇《手把手教你編譯Flutter engine》

官方flutter的大麻煩

google團隊的大bug,個人認爲內存是很重要的，尤其是集成到現有app中的方式。

https://github.com/flutter/fl...
https://github.com/flutter/fl...
https://github.com/flutter/fl...
https://github.com/flutter/en...
https://github.com/flutter/fl...

flutter 1.0 解決了FlutterViewController的循環引用問題，但是把循環引用的問題轉嫁到了FlutterEngine上面，下面手把手教你如何解決1.0的循環引用。

如何找到內存泄漏

爲什麼google難以解決

由於整個FlutterEngine是用MRC的方式編寫，所以內存管理比較困難，每個變量生成retain，都需要被release，如果一個實例retain了兩次，只release一次，也會導致無法釋放，如果設置了autorelease，就有可能提前釋放，導致badasses，訪問野指針。

客觀原因，一般的應用只會創建一個flutter應用，或者乾脆就直接都是flutter應用，不釋放就不釋放，多點內存也無所謂，不影響崩潰，不影響使用，所以google照常發佈1.0版。

現狀

每次進去都會新增幾十M然而當退出flutterViewController的時候，內存僅僅下降2m左右，還有幾十兆保留在內存中。下降的部分就是flutterviewcontroller，從程序運行到了dealloc可以證明。

修改結果

修改後的framework下載列表

• 1.0版engine arm64 debug下載 https://github.com/Natoto/flutterOnExistApp/blob/multiflutter/flutterOnExistApp/Resources/Flutter.framework.zip
• 其他版本打包發佈github 地址

https://github.com/Natoto/fixFlutterEngine

下面將一步步帶領大家找到循環引用，解決循環引用，這一步可能比較繁瑣，如果不願看推理過程，可以直接跳到文末獲取構建後的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是可以獨自創建和釋放，FlutterEngine是新1.0引進，用於管理所有的metchodChannel，就是維護所有的方法消息，生命週期等作用。也是要解決它的引用問題。
執行engine runwithEntrypoint可以啓動engine vm。

FlutterDartProject 用於配置啓動參數，默認可以直接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

介紹上面兩個是爲了找到斷點入口

如何設flutter斷點

爲了方便調試，可以在編譯現有工程的時候替換flutter.framework
具體做法是在build phases 中創建一個腳本，用自己編譯的engine中的flutter.framework替換 .ios/engine/Flutter.framework

替換完之後則可以設置symbol斷點了，如下

或者用lldb命令設置斷點 br xxxx lldb傳送門

幾個疑點

從目前的情況來看engine沒有被釋放，就是FlutterEngine.mm FlutterChannel.mm 和 PluginRegister直接的關係混亂了
有兩點情況

1. 互相引用
2. 內部引用沒有release
3. 多次retain
4. block是否使用的__block引用
5. 主動destory
6. 編譯，看dealloc

從0.9.4經驗來看，需要手動destory一下，destory完成這個類中變量的release
以上五個過程需要不斷的循環重試，過程比較長。。

方法論說完了，下面直接說我的幾天試錯結果。共計10個文件，核心的地方貼一下

maybesetupPlatformViewChannels在flutterengine裏面，啓動默認平臺changnle和方法回調

重心，FlutterChannel.mm裏面 FlutterMethodChannel，flutter每個plugin的方法都會經過通過register註冊一個channel，然而，messger是register，不應該被持有或autorelease的，所以這樣做是會造成提前釋放或無法釋放的

對應於其他的channel也是用了messager，會有相同的問題。改造這些基本上就能解除大循環了。

總結engine的大循環引用

如何使用

有兩種方法

1. 替換flutter裏面的framework

路徑如下
/Users/boo/Documents/flutter/bin/cache/artifacts/engine/ios
不用擔心是否會破壞之前發flutter.framework，如果想用回官方的直接解壓同文件夾裏面的.zip文件即可

1. 工程中用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修改的文件，可以直接替換使用並構建自己的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

看一下構建後結果

如構建debug版的engine如下路徑或生產一個framework，這個通過執行all.wxworkspace生成的，注意arm架構，如果選target是真機，則會生成arm64架構framework
/Users/boo/Documents/engine/src/out/ios_debug/Flutter.framework

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

構建release framework類似。
詳細步驟可以參考《手把手教你編譯Flutter engine》

---

### YY Flutter技術積累相關鏈接

[一行代碼教你解決FlutterPlatformViews內存泄露 by
AShawn ](https://juejin.im/post/5c6e6d...

[手把手教你在Flutter項目優雅的使用ORM數據庫 by
williamwen1986](https://juejin.im/post/5c45c7...

[flutter通用基礎庫flutter_luakit_plugin by
williamwen1986](https://juejin.im/post/5c3459...

[github - flutter_luakit_plugin使用例子 by
williamwen1986](https://github.com/williamwen...

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

手把手教你解決 Flutter engine 內存泄漏 by 共田君

github - 編譯產物下載 修復內存泄漏後的flutter engine（可直接使用）by 共田君</font>

github demo - 修復內存泄漏後的flutter engine by 共田君

持續更新中...