您的位置: 首页 > 技术杂谈 > 正文

技术干货 | Flutter在线编程实践总结

2021-11-12 17:00 https://my.oschina.net/youdaotech/blog/5308383 有道技术团队次阅读条评论

本文主要记录了如何一步步学习了解Flutter视图绘制原理，然后应用到性能监控和性能优化的实践

作

作者 / 郭凯旋

编辑 / 李轶楠（实习）

youdao

1.Flutter架构

ydtech

Flutter的架构主要分成三层:Framework，Engine，Embedder。

1.Framework使用dart实现，包括Material Design风格的Widget,Cupertino(针对iOS)风格的Widgets，文本/图片/按钮等基础Widgets，渲染，动画，手势等。此部分的核心代码是:flutter仓库下的flutter package，以及sky_engine仓库下的io,async,ui(dart:ui库提供了Flutter框架和引擎之间的接口)等package。

2.Engine使用C++实现，主要包括:Skia,Dart和Text。Skia是开源的二维图形库，提供了适用于多种软硬件平台的通用API。

3.Embedder是一个嵌入层，即把Flutter嵌入到各个平台上去，这里做的主要工作包括渲染Surface设置,线程设置，以及插件等。从这里可以看出，Flutter的平台相关层很低，平台(如iOS)只是提供一个画布，剩余的所有渲染相关的逻辑都在Flutter内部，这就使得它具有了很好的跨端一致性。

图1

youdao

2.Flutter视图绘制

ydtech

对于开发者来说，使用最多的还是framework，我就从Flutter的入口函数开始一步步往下走，分析一下Flutter视图绘制的原理。

在Flutter应用中，main()函数最简单的实现如下:

void main() {  runApp(MyApp()); }

runApp方法调用了WidgetsFlutterBinding类ensureInitialized、attachRootWidget(app)、scheduleWarmUpFrame()三个方法，代码如下

// 参数app是一个widget，是Flutter应用启动后要展示的第一个Widget。void runApp(Widget app) {    WidgetsFlutterBinding.ensureInitialized()                 ..scheduleAttachRootWidget(app)      ..scheduleWarmUpFrame(); }

2.1

WidgetsFlutterBinding

WidgetsFlutterBinding继承自BindingBase 并混入了很多Binding，查看这些 Binding的源码可以发现这些Binding中基本都是监听并处理Window对象（包含了当前设备和系统的一些信息以及Flutter Engine的一些回调）的一些事件，然后将这些事件按照Framework的模型包装、抽象然后分发。

WidgetsFlutterBinding正是粘连Flutter engine与上层Framework的“胶水”。

1.GestureBinding：

提供了window.onPointerDataPacket 回调，绑定Framework手势子系统，是Framework事件模型与底层事件的绑定入口。

2.ServicesBinding：

提供了window.onPlatformMessage 回调，用于绑定平台消息通道（message channel），主要处理原生和Flutter通信。

3.SchedulerBinding：

提供了window.onBeginFrame和window.onDrawFrame回调，监听刷新事件，绑定Framework绘制调度子系统。

4. PaintingBinding：

绑定绘制库，主要用于处理图片缓存。

5. SemanticsBinding：

语义化层与Flutter engine的桥梁，主要是辅助功能的底层支持。

6.RendererBinding:

提供了window.onMetricsChanged 、window.onTextScaleFactorChanged 等回调。它是渲染树与Flutter engine的桥梁。

7.WidgetsBinding：

提供了window.onLocaleChanged、onBuildScheduled 等回调。它是Flutter widget层与engine的桥梁。

WidgetsFlutterBinding.ensureInitialized()负责初始化一个WidgetsBinding的全局单例，代码如下:

class WidgetsFlutterBinding extends BindingBase with GestureBinding, ServicesBinding, SchedulerBinding, PaintingBinding, SemanticsBinding, RendererBinding, WidgetsBinding {  static WidgetsBinding ensureInitialized() {    if (WidgetsBinding.instance == null)      WidgetsFlutterBinding();    return WidgetsBinding.instance;  }}

看到这个混入(with)很多的，下面先看父类:BindingBase

abstract class BindingBase {   ...  ui.SingletonFlutterWindow get window => ui.window;//获取window实例  @protected  @mustCallSuper  void initInstances() {    assert(!_debugInitialized);    assert(() {      _debugInitialized = true;      return true;    }());  }}

看到有句代码Window get window => ui.window链接宿主操作系统的接口，也就是Flutter framework 链接宿主操作系统的接口。系统中有一个Window实例，可以从window属性来获取，看看源码：

// window的类型是一个FlutterView，FlutterView里面有一个PlatformDispatcher属性ui.SingletonFlutterWindow get window => ui.window;// 初始化时把PlatformDispatcher.instance传入，完成初始化ui.window = SingletonFlutterWindow._(0, PlatformDispatcher.instance);// SingletonFlutterWindow的类结构class SingletonFlutterWindow extends FlutterWindow {  ...  // 实际上是给platformDispatcher.onBeginFrame赋值  FrameCallback? get onBeginFrame => platformDispatcher.onBeginFrame;  set onBeginFrame(FrameCallback? callback) {    platformDispatcher.onBeginFrame = callback;  }    VoidCallback? get onDrawFrame => platformDispatcher.onDrawFrame;  set onDrawFrame(VoidCallback? callback) {    platformDispatcher.onDrawFrame = callback;  }    // window.scheduleFrame实际上是调用platformDispatcher.scheduleFrame()  void scheduleFrame() => platformDispatcher.scheduleFrame();  ...}class FlutterWindow extends FlutterView {  FlutterWindow._(this._windowId, this.platformDispatcher);  final Object _windowId;  // PD  @override  final PlatformDispatcher platformDispatcher;  @override  ViewConfiguration get viewConfiguration {    return platformDispatcher._viewConfigurations[_windowId]!;  }}

‍

2.2

scheduleAttachRootWidget

scheduleAttachRootWidget紧接着会调用WidgetsBinding的attachRootWidget方法，该方法负责将根Widget添加到RenderView上，代码如下：

void attachRootWidget(Widget rootWidget) {    final bool isBootstrapFrame = renderViewElement == null;    _readyToProduceFrames = true;    _renderViewElement = RenderObjectToWidgetAdapter<RenderBox>(      container: renderView,      debugShortDescription: '[root]',      child: rootWidget,    ).attachToRenderTree(buildOwner!, renderViewElement as RenderObjectToWidgetElement<RenderBox>?);    if (isBootstrapFrame) {      SchedulerBinding.instance!.ensureVisualUpdate();    }  }

renderView变量是一个RenderObject，它是渲染树的根。renderViewElement变量是renderView对应的Element对象。可见该方法主要完成了根widget到根 RenderObject再到根Element的整个关联过程。

RenderView get renderView => _pipelineOwner.rootNode! as RenderView;

renderView是RendererBinding中拿到PipelineOwner.rootNode，PipelineOwner在 Rendering Pipeline 中起到重要作用：

随着 UI 的变化而不断收集『 Dirty Render Objects 』随之驱动 Rendering Pipeline 刷新 UI。

简单讲，PipelineOwner是『RenderObject Tree』与『RendererBinding』间的桥梁。

最终调用attachRootWidget，执行会调用RenderObjectToWidgetAdapter的attachToRenderTree方法，该方法负责创建根element，即RenderObjectToWidgetElement，并且将element与widget 进行关联，即创建出 widget树对应的element树。如果element 已经创建过了，则将根element 中关联的widget 设为新的，由此可以看出element 只会创建一次，后面会进行复用。BuildOwner是widget framework的管理类，它跟踪哪些widget需要重新构建。代码如下：

RenderObjectToWidgetElement<T> attachToRenderTree(BuildOwner owner, [RenderObjectToWidgetElement<T> element]) {  if (element == null) {    owner.lockState(() {      element = createElement();      assert(element != null);      element.assignOwner(owner);    });    owner.buildScope(element, () {      element.mount(null, null);    });  } else {    element._newWidget = this;    element.markNeedsBuild();  }  return element;}

2.3

scheduleWarmUpFrame

runApp的实现中，当调用完attachRootWidget后，最后一行会调用 WidgetsFlutterBinding 实例的 scheduleWarmUpFrame() 方法，该方法的实现在SchedulerBinding 中，它被调用后会立即进行一次绘制（而不是等待"vsync" 信号），在此次绘制结束前，该方法会锁定事件分发，也就是说在本次绘制结束完成之前Flutter将不会响应各种事件，这可以保证在绘制过程中不会再触发新的重绘。

下面是scheduleWarmUpFrame() 方法的部分实现(省略了无关代码)：

void scheduleWarmUpFrame() {  ...  Timer.run(() {    handleBeginFrame(null);   });  Timer.run(() {    handleDrawFrame();      resetEpoch();  });  // 锁定事件  lockEvents(() async {    await endOfFrame;    Timeline.finishSync();  }); ...}

该方法中主要调用了handleBeginFrame() 和 handleDrawFrame() 两个方法。

查看handleBeginFrame() 和 handleDrawFrame() 两个方法的源码，可以发现前者主要是执行了transientCallbacks队列，而后者执行了 persistentCallbacks 和 postFrameCallbacks 队列。

1. transientCallbacks：用于存放一些临时回调，一般存放动画回调。可以通过SchedulerBinding.instance.scheduleFrameCallback 添加回调。

2. persistentCallbacks：用于存放一些持久的回调，不能在此类回调中再请求新的绘制帧，持久回调一经注册则不能移除。 SchedulerBinding.instance.addPersitentFrameCallback()，这个回调中处理了布局与绘制工作。

3. postFrameCallbacks：在Frame结束时只会被调用一次，调用后会被系统移除，可由 SchedulerBinding.instance.addPostFrameCallback() 注册。

注意，不要在此类回调中再触发新的Frame，这可以会导致循环。

真正的渲染和绘制逻辑在RendererBinding中实现，查看其源码，发现在其initInstances()方法中有如下代码：

void initInstances() {  ... // 省略无关代码  addPersistentFrameCallback(_handlePersistentFrameCallback);}void _handlePersistentFrameCallback(Duration timeStamp) {  drawFrame();}void drawFrame() {  assert(renderView != null);  pipelineOwner.flushLayout(); // 布局  pipelineOwner.flushCompositingBits(); //重绘之前的预处理操作，检查RenderObject是否需要重绘  pipelineOwner.flushPaint(); // 重绘  renderView.compositeFrame(); // 将需要绘制的比特数据发给GPU  pipelineOwner.flushSemantics(); // this also sends the semantics to the OS.}

需要注意的是：由于RendererBinding只是一个mixin，而with它的是WidgetsBinding，所以需要看看WidgetsBinding中是否重写该方法，查看WidgetsBinding的drawFrame()方法源码：

@overridevoid drawFrame() { ...//省略无关代码  try {    if (renderViewElement != null)      buildOwner.buildScope(renderViewElement);     super.drawFrame(); //调用RendererBinding的drawFrame()方法    buildOwner.finalizeTree();  } }

在调用RendererBinding.drawFrame()方法前会调用 buildOwner.buildScope() （非首次绘制），该方法会将被标记为“dirty” 的 element 进行 rebuild()

我们再来看WidgetsBinding，在initInstances()方法中创建BuildOwner对象，然后执行buildOwner!.onBuildScheduled = _handleBuildScheduled;，这里将_handleBuildScheduled赋值给了buildOwnder的onBuildScheduled属性。

BuildOwner对象，它负责跟踪哪些widgets需要重新构建，并处理应用于widgets树的其他任务，其内部维护了一个_dirtyElements列表，用以保存被标“脏”的elements。

每一个element被新建时，其BuildOwner就被确定了。一个页面只有一个buildOwner对象，负责管理该页面所有的element。

// WidgetsBindingvoid initInstances() {  ...  buildOwner!.onBuildScheduled = _handleBuildScheduled;  ...  }());}

当调用buildOwner.onBuildScheduled()时，便会走下面的流程。

// WidgetsBinding类void _handleBuildScheduled() {  ensureVisualUpdate();}// SchedulerBinding类void ensureVisualUpdate() {    switch (schedulerPhase) {      case SchedulerPhase.idle:      case SchedulerPhase.postFrameCallbacks:        scheduleFrame();        return;      case SchedulerPhase.transientCallbacks:      case SchedulerPhase.midFrameMicrotasks:      case SchedulerPhase.persistentCallbacks:        return;    }  }

当schedulerPhase处于idle状态，会调用scheduleFrame，然后经过window.scheduleFrame()中的performDispatcher.scheduleFrame()去注册一个VSync监听。

 void scheduleFrame() {    ...
    window.scheduleFrame();    ...  }

2.4

小结

Flutter从启动到显示图像在屏幕主要经过：首先监听处理window对象的事件，将这些事件处理包装为Framework模型进行分发，通过widget创建element树，接着通过scheduleWarmUpFrame进行渲染，接着通过Rendererbinding进行布局，绘制，最后通过调用ui.window.render(scene)Scene信息发给Flutter engine，Flutter engine最后调用渲染API把图像画在屏幕上。

我大致整理了一下Flutter视图绘制的时序图，如下

图 2

youdao

3.Flutter性能监控

ydtech

在对视图绘制有一定的了解后后，思考一个问题，怎么在视图绘制的过程中去把控性能，优化性能，我们先来看一下Flutter官方提供给我们的两个性能监控工具。

3.1

Dart VM Service

1.observatory

observatory: 在engine/shell/testings/observatory可以找到它的具体实现,它开启了一个ServiceClient,用于获取dartvm运行状态.flutter app启动的时候会生成一个当前的observatory服务器的地址

flutter: socket connected in service Dart VM Service Protocol v3.44 listening on http://127.0.0.1:59378/8x9XRQIBhkU=/

图 3

比方说选择了timeline后，可以进行性能分析，如图

图 4

2.devTools

devTools也提供了一些基本的检测,具体的细节没有 Observatory 提供的完善. 可视性比较强。可以通过下面命令安装： f lutter pub global activate devtools 安装完成后通过devtools命令打开，输入DartVM地址

图 5

打开后的页面

图 6

devtools中的timeline就是performance，我们选择之后页面如下，操作体验上好了很多

图 7

observatory与devtools都是通过vm_service实现的，网上使用指南比较多，这边就不多赘述了，我这边主要介绍一下Dart VM Service （后面简称）vm_service，是 Dart 虚拟机内部提供的一套 Web 服务，数据传输协议是 JSON-RPC 2.0。

不过我们并不需要要自己去实现数据请求解析，官方已经写好了一个可用的 Dart SDK 给我们用：vm_service。vm_service 在启动的时候会在本地开启一个 WebSocket 服务，服务 URI 可以在对应的平台中获得：

1）Android 在 FlutterJNI.getObservatoryUri() 中；

2）iOS 在 FlutterEngine.observatoryUrl 中。

有了 URI 之后我们就可以使用的服务了，官方有一个帮我们写好的SDK: vm_service

  Future<void> connect() async {    ServiceProtocolInfo info = await Service.getInfo();    if (info.serverUri == null) {      print("service  protocol url is null,start vm service fail");      return;    }    service = await getService(info);    print('socket connected in service $info');    vm = await service?.getVM();    List<IsolateRef>? isolates = vm?.isolates;    main = isolates?.firstWhere((ref) => ref.name?.contains('main') == true);    main ??= isolates?.first;    connected = true;  }
  Future<VmService> getService(info) async {    Uri uri = convertToWebSocketUrl(serviceProtocolUrl: info.serverUri);    return await vmServiceConnectUri(uri.toString(), log: StdoutLog());  }

‍

获取frameworkVersion，调用一个VmService实例的callExtensionService，传入'flutterVersion'，就能拿到当前的flutter framework和engine信息

  Future<Response?> callExtensionService(String method) async {    if (_extensionService == null && service != null && main != null) {      _extensionService = ExtensionService(service!, main!);      await _extensionService?.loadExtensionService();    }    return _extensionService!.callMethod(method);  }

图 8

获取内存信息，调用一个VmService实例的getMemoryUsage，就能拿到当前的内存信息

  Future<MemoryUsage> getMemoryUsage(String isolateId) =>      _call('getMemoryUsage', {'isolateId': isolateId});

图 9

获取 Flutter APP 的 FPS，官方提供了好几个办法来让我们在开发 Flutter app 的过程中可以使用查看 fps等性能数据，如devtools，具体见文档 Debugging Flutter apps 、Flutter performance profiling 等。

// 需监听fps时注册void start() {  SchedulerBinding.instance.addTimingsCallback(_onReportTimings);}// 不需监听时移除void stop() {  SchedulerBinding.instance.removeTimingsCallback(_onReportTimings);}void _onReportTimings(List<FrameTiming> timings) {  // TODO}

3.2

崩溃日志捕获上报

flutter 的崩溃日志收集主要有两个方面：

1）flutter dart 代码的异常（包含app和framework代码两种情况，一般不会引起闪退，你猜为什么）

2）flutter engine 的崩溃日志（一般会闪退）

Dart 有一个 Zone 的概念，有点类似sandbox的意思。不同的 Zone 代码上下文是不同的互不影响，Zone 还可以创建新的子Zone。Zone 可以重新定义自己的print、timers、microtasks还有最关键的how uncaught errors are handled 未捕获异常的处理

runZoned(() {    Future.error("asynchronous error");}, onError: (dynamic e, StackTrace stack) {    reportError(e, stack);});

1.Flutter framework 异常捕获

注册 FlutterError.onError 回调，用于收集 Flutter framework 外抛的异常。

runZoned(() {    Future.error("asynchronous error");}, onError: (dynamic e, StackTrace stack) {    reportError(e, stack);});

2.Flutter engine 异常捕获

flutter engine 部分的异常，以Android 为例，主要为 libfutter.so发生的错误。

这部份可以直接交给native崩溃收集sdk来处理，比如 firebase crashlytics、 bugly、xCrash 等等

我们需要将 dart 异常及堆栈通过 MethodChannel传递给 bugly sdk 即可。

收集到异常之后，需要查符号表(symbols)还原堆栈。

首先需要确认该 flutter engine 所属版本号，在命令行执行：

flutter --version

输出如下：

Flutter 2.2.3 • channel stable • https://github.com/flutter/flutter.gitFramework • revision f4abaa0735 (4 months ago) • 2021-07-01 12:46:11 -0700Engine • revision 241c87ad80Tools • Dart 2.13.4

可以看到 Engine 的 revision 为 241c87ad80。

其次，在 flutter infra 上找到对应cpu abi 的 symbols.zip 并下载,解压后，可以得到带有符号信息的 debug so 文件—— libflutter.so，然后按照平台文档上传进行堆栈还原就可以了，如bugly平台就提供了上传工具

java -jar buglySymbolAndroid.jar -i xxx

youdao

4.Flutter性能优化

ydtech

在业务开发中我们要学会用devtools来检测工程性能，这样有助于我们实现健壮性更强的应用，在排查过程中，我发现视频详情页存在渲染耗时的问题，如图