手把手教你解决 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 qq群,群号:217429001 有兴趣的加入哦

欢迎关注
姊妹篇《手把手教你编译Flutter engine》

最新消息: flutter内存泄漏问题,现在可以使用官方清理方式了

见 flutter.framework FlutterEngine里面的 destroyContext

-------------------------------------------------------- 历史的分割线 -------------------------------------

官方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

image.png
image.png

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下载列表

下面将一步步带领大家找到循环引用,解决循环引用,这一步可能比较繁琐,如果不愿看推理过程,可以直接跳到文末获取构建后的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.mmPluginRegister直接的关系混乱了
有两点情况

  1. 互相引用
  2. 内部引用没有release
  3. 多次retain
  4. block是否使用的__block引用
  5. 主动destory
  6. 编译,看dealloc
    从0.9.4经验来看,需要手动destory一下,destory完成这个类中变量的release
    以上五个过程需要不断的循环重试,过程比较长。。

方法论说完了,下面直接说我的几天试错结果。共计10个文件,核心的地方贴一下

maybesetupPlatformViewChannels

maybesetupPlatformViewChannels在flutterengine里面,启动默认平台changnle和方法回调

image.png

重心,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文件即可

  2. 工程中用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"

image.png

修改后代码

修改的文件放在1.0engine修改的文件,可以直接替换使用并构建自己的framework

打包framework

看一下构建后结果

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

如构建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

手把手教你在Flutter项目优雅的使用ORM数据库 by
williamwen1986

flutter通用基础库flutter_luakit_plugin by
williamwen1986

github - flutter_luakit_plugin使用例子 by
williamwen1986

手把手教你编译Flutter engine by 共田君

手把手教你解决 Flutter engine 内存泄漏 by 共田君

github - 编译产物下载 修复内存泄漏后的flutter engine(可直接使用)by 共田君</font>

github demo - 修复内存泄漏后的flutter engine by 共田君

持续更新中...

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容