如何判断Flutter框架正处于组件构建过程中？

问题背景 #

我有一个展示元素列表的组件，在initState中调用加载方法，加载完成后通知父级Scaffold刷新以在AppBar显示元素数量。异步加载时正常，但同步加载时触发错误：

setState() or markNeedsBuild() called during build.
I/flutter ( 6150): This ElementsList widget cannot be marked as needing to build because the framework is already in the process of building widgets. A widget can be marked as needing to be built during the build phase only if one of its ancestors is currently building. This exception is allowed because the framework builds parent widgets before children, which means a dirty descendant will always be built. Otherwise, the framework might not visit this widget during this build phase.

原因是同步加载时，在父组件构建过程中直接调用了setState。希望找到一种抽象的判断方式，而非数据驱动的跟踪，以便复用。

可行的抽象判断方法 #

1. 使用WidgetsBinding.instance.debugBuilding #

Flutter框架提供了debugBuilding属性，可直接判断当前是否处于构建阶段：

bool isFrameworkBuilding() {
  return WidgetsBinding.instance.debugBuilding;
}

• 注意：尽管属性名带debug，但release模式下仍能正常返回正确状态，官方标注为调试用途，但实际业务场景中可安全使用。

2. 通过SchedulerBinding检查调度阶段 #

Flutter的调度器会有不同的阶段，我们可以通过当前阶段判断是否处于构建流程：

bool isInBuildPhase() {
  final schedulerPhase = SchedulerBinding.instance.schedulerPhase;
  // persistentCallbacks 对应组件构建阶段
  return schedulerPhase == SchedulerPhase.persistentCallbacks;
}

• 补充：postFrameCallbacks是构建完成后的回调阶段，若需判断是否处于整个构建相关流程，可加上该阶段的判断。

3. 封装可复用工具类 #

将判断逻辑封装为工具类，方便在多个组件中复用：

class BuildStateChecker {
  // 判断是否处于构建中
  static bool get isBuilding => WidgetsBinding.instance.debugBuilding;

  // 判断是否处于构建阶段
  static bool get inBuildPhase {
    final phase = SchedulerBinding.instance.schedulerPhase;
    return phase == SchedulerPhase.persistentCallbacks;
  }
}

实际使用示例 #

在需要通知父组件刷新时，先判断构建状态，避免触发错误：

void updateParentState() {
  if (BuildStateChecker.isBuilding) {
    // 延迟到构建完成后执行
    SchedulerBinding.instance.addPostFrameCallback((_) {
      parent.setState(() {
        // 更新父组件状态逻辑
      });
    });
  } else {
    // 直接更新状态
    parent.setState(() {
      // 更新父组件状态逻辑
    });
  }
}

内容的提问来源于stack exchange，提问作者ouai