手把手教你解決 Flutter engine 記憶體洩漏

Natoto發表於2018-12-27

Flutter/engine 修復版介紹

tags: flutter engine memory leak fix natoto

官方flutter的大麻煩

google團隊的大bug,個人認為記憶體是很重要的，尤其是整合到現有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的迴圈引用問題，但是把迴圈引用的問題轉嫁到了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下載 github.com/Natoto/flut…
其他版本打包釋出github 地址 github.com/Natoto/fixF…

下面將一步步帶領大家找到迴圈引用，解決迴圈引用，這一步可能比較繁瑣，如果不願看推理過程，可以直接跳到文末獲取構建後的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直接的關係混亂了有兩點情況

互相引用
內部引用沒有release
多次retain
block是否使用的__block引用
主動destory
編譯，看dealloc 從0.9.4經驗來看，需要手動destory一下，destory完成這個類中變數的release 以上五個過程需要不斷的迴圈重試，過程比較長。。

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

maybesetupPlatformViewChannels在flutterengine裡面，啟動預設平臺changnle和方法回撥

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

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

總結engine的大迴圈引用

如何使用

有兩種方法

替換flutter裡面的framework 路徑如下 /Users/boo/Documents/flutter/bin/cache/artifacts/engine/ios 不用擔心是否會破壞之前發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修改的檔案，可以直接替換使用並構建自己的framework

1.0 修改的程式碼地址 github.com/Natoto/flut…
github demo 工程 github.com/Natoto/flut…
1.0版engine arm64 debug下載 github.com/Natoto/flut…

打包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》