Flutter flutter_bloc同个BLoC跨状态变更保留多变量的最佳实践
flutter_bloc场景下跨状态驻留变量的成熟实现方案
方案一:将驻留变量作为Bloc类的内置成员(优先选择)
这是实际项目中适用范围最广、样板代码最少的实现,核心逻辑是厘清状态和业务实例的边界:
- 那些只要Bloc实例存活就需要保留、不需要参与状态相等对比、不会因为值变化单独触发UI重建的变量,根本不需要归属到State类的字段里
- 变量直接定义为Bloc的私有成员,在Bloc的整个生命周期内有效,只有在对应的业务方法里被显式修改时才会更新值
- 业务逻辑读取这些变量时直接从Bloc成员中取即可,完全不需要在每次emit新状态时把这些值拷贝到State构造函数里
代码示例:
class DashboardBloc extends Bloc<DashboardEvent, DashboardState> { // 三个需要跨状态保留的变量,直接作为Bloc的私有成员 String _currentCityCode = '110000'; int _refreshCount = 0; bool _isNotifyEnabled = false; DashboardBloc() : super(DashboardInitial()) { // 变量修改逻辑绑定到独立的业务方法,修改完成后按需emit对应的UI状态 on<UpdateUserPreferenceEvent>((event, emit) { // 仅当传入了新值时才覆盖原有变量,未传入的保留原值 _currentCityCode = event.cityCode ?? _currentCityCode; _isNotifyEnabled = event.isNotifyEnabled ?? _isNotifyEnabled; // 修改完成后直接emit需要的UI状态,不需要携带驻留变量 emit(const DashboardLoading()); }); on<FetchDashboardDataEvent>((event, emit) async { // 业务逻辑直接读取Bloc内部的驻留变量,不需要从State里取 final targetCity = _currentCityCode; final refreshTimes = _refreshCount; // ... 执行数据拉取逻辑 _refreshCount += 1; emit(DashboardLoadSuccess(cacheTime: DateTime.now())); }); } }
这个方案的优势:
- 完全消除冗余的样板拷贝代码,不需要为每个State子类写重复的字段定义和传参逻辑
- 不存在状态对比冗余:Bloc默认的状态相等判断仅对比State类的字段,驻留变量不在State里的话,完全不会触发无意义的UI重建
- 变量修改的逻辑完全收敛在Bloc内部,排查问题时不需要在各个State子类之间追值的流转路径
方案二:将驻留变量抽为公共基类字段(适用于需要被State感知的场景)
如果这些驻留变量确实需要参与状态相等判断、需要让BlocBuilder感知到值变化并触发UI重建,就不要再用每个State单独存三个字段的写法,而是把聚合后的模型作为所有State子类的公共继承字段:
- 单独定义承载所有驻留变量的可复用模型类,内置统一的
copyWith方法和值相等判断逻辑,只写一次即可全局复用 - 定义所有State的抽象基类,把驻留模型作为基类的唯一公共字段,各个具体的State子类只需要定义和自身瞬态场景相关的专属字段
代码示例:
// 仅写一次的驻留数据模型 class DashboardPrefs extends Equatable { final String cityCode; final int refreshCount; final bool isNotifyEnabled; const DashboardPrefs({ required this.cityCode, required this.refreshCount, required this.isNotifyEnabled, }); // 统一的值拷贝方法,不需要在每个State里重复写 DashboardPrefs copyWith({ String? cityCode, int? refreshCount, bool? isNotifyEnabled, }) => DashboardPrefs( cityCode: cityCode ?? this.cityCode, refreshCount: refreshCount ?? this.refreshCount, isNotifyEnabled: isNotifyEnabled ?? this.isNotifyEnabled, ); @override List<Object?> get props => [cityCode, refreshCount, isNotifyEnabled]; } // State抽象基类,统一持有驻留模型 abstract class DashboardState extends Equatable { final DashboardPrefs prefs; const DashboardState(this.prefs); @override List<Object?> get props => [prefs]; } // 各个具体的瞬态State,仅定义自身专属字段 class DashboardInitial extends DashboardState { const DashboardInitial(super.prefs); } class DashboardLoading extends DashboardState { const DashboardLoading(super.prefs); } class DashboardLoadSuccess extends DashboardState { final List<String> moduleList; const DashboardLoadSuccess(super.prefs, this.moduleList); @override List<Object?> get props => [super.props, moduleList]; } class DashboardLoadError extends DashboardState { final String errorDesc; const DashboardLoadError(super.prefs, this.errorDesc); @override List<Object?> get props => [super.props, errorDesc]; }
实际emit新状态的逻辑里,只需要通过copyWith更新一次驻留模型,再把新的模型传给要emit的State构造函数即可:
on<UpdateUserPreferenceEvent>((event, emit) { // 基于当前State里的驻留模型生成新的实例,不需要手动拷三个字段 final newPrefs = state.prefs.copyWith( cityCode: event.cityCode, isNotifyEnabled: event.isNotifyEnabled, ); // 把更新后的驻留模型传入目标State,不需要逐字段传值 emit(DashboardLoading(newPrefs)); });
这种写法的优势:
- 驻留变量的定义、拷贝逻辑只写一次,不会随着State子类的增多产生重复样板代码
- 状态流转的逻辑清晰,所有值的变更路径都能通过State的链式传递追溯到
- 完全兼容Bloc的状态相等判断机制,不会出现observer方案带来的逻辑耦合问题
明确需要规避的反模式
- 逐字段拷贝的硬编码写法:在每个State子类里重复定义三个驻留变量,每次emit时手动把旧State的三个值逐个传到新State的构造参数里。这种写法会随着State类型增多产生大量重复代码,还极易出现漏拷字段的逻辑bug。
- 滥用BlocObserver跨状态传值:BlocObserver的设计定位是状态流的观测、日志上报、调试能力,没有持有业务数据的职责,用它传递业务值会把观测逻辑和业务逻辑深度耦合,后续排查问题的成本极高。
补充注意事项
- 不要为了这类短生命周期的驻留变量引入全局状态管理、依赖注入等额外方案,只要变量的生命周期和当前Bloc完全绑定,上面两个方案的复杂度已经足够低
- 如果驻留变量的生命周期比当前Bloc更长(比如全局的用户登录信息、App级配置),可以将这部分值移到对应的全局存储层,在Bloc初始化时读取一次即可,不需要跟着状态流来回传递
- 市面上的Bloc状态机辅助工具,本质上也是把公共上下文数据抽为状态流的公共字段,和上述方案的核心逻辑完全一致
内容的提问来源于stack exchange,提问作者Rob Pitt
相关产品推荐
相关产品推荐

