Flutter中什么时候需要重写debugFillProperties方法？

核心本质 #

这个方法是Flutter调试体系下的专属方法，仅在Debug模式下执行，Release构建时会被完全剔除，不会带来任何性能损耗。它的核心作用是把你自定义的State/Widget属性注册到Flutter的诊断系统里，方便调试时查看。

实际作用 #

• 支持在Flutter DevTools的Widget Inspector中直接查看自定义属性
  默认情况下，你在Inspector里点自己写的StatefulWidget，只能看到Flutter内置的属性（比如key、style这些），你自己定义的min、max这类自定义状态变量不会显示。你在debugFillProperties里注册之后，这些属性就会直接展示在Inspector的属性面板里，不用手动打日志就能实时看当前值，调试复杂状态的时候效率提升非常明显。
• 自动输出状态变更的调试提示
  当组件热重载、状态更新触发重建时，Flutter的调试日志会自动对比新旧属性值，标出你注册过的属性发生了什么变化，不用自己写print去对比前后值。
• 方便组件使用者调试
  官方内置的Slider这类通用组件都实现了这个方法，就是为了让使用组件的开发者调试时能直接看到组件的所有状态值，不用翻源码猜内部逻辑。

测试时没看到效果的原因 #

你代码里加的print只是方法被调用时的触发提示，这个方法本身的作用不是给你写打印逻辑的。你注册的属性需要打开Flutter DevTools，进入Widget Inspector面板，选中你写的这个StatefulWidget，在右侧的属性列表里就能看到你添加的min字段的当前值。
另外你写的代码里有个小问题：min是double?类型，你用了IntProperty来注册，类型不匹配，换成DoubleProperty就能正常显示数值了。

什么时候需要用这个方法 #

• 你写的自定义StatefulWidget有较多自定义状态，调试时需要快速查看状态值
• 你在开发通用组件库给其他开发者使用，最好给所有自定义属性都加上注册逻辑，提升组件的可调试性
• 复杂业务页面的状态逻辑混乱，排查bug时需要直观看到所有状态的实时值，不用写大量打印日志

// 修正后的示例代码
double? min;
@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
  super.debugFillProperties(properties);
  // 对应double类型用DoubleProperty
  properties.add(DoubleProperty('min', min, defaultValue: 5, ifNull: "nulll"));
}

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