跳转至

BLoC 四个 Mixin

core/bloc/ 提供四个可组合的 Mixin,解决 MVI 在 Flutter 下的四个常见痛点。它们彼此正交,可任意组合

Mixin 解决的问题
BlocAwaitMixin add(Event) 是 fire-and-forget,UI 无法 await
BlocCancelTokenMixin 网络请求取消 / 去重,绑定 BLoC 生命周期
BlocEffectMixin 一次性副作用通道(Toast / Loading / Dialog)
BlocErrorHandlerMixin 把异常包装为 Result<T>(成功 / 失败 / 取消),Failure 携带原始 Exception

统一导出:import 'package:flutter_zero_app/core/bloc/bloc.dart';


1. BlocAwaitMixin —— 让事件可等待

add 返回 void,UI 没法 awaitrunAwait 返回一个 Future,事件处理结束时自动完成。

事件即等待标识:不需要手写任何标识,事件本身就是操作身份。相同事件正在处理时再次触发,新的调用会合并到同一趟操作上等待,不会重复发送事件、不会重复执行请求(重复下拉刷新、连续点击只跑一次);参数不同的同类事件则各自独立执行、各自唤醒自己的等待方。

手动收尾

class ItemBloc extends Bloc<ItemEvent, ItemState>
    with BlocAwaitMixin<ItemEvent, ItemState> {
  Future<void> refresh() =>
      runAwait(event: const ItemEvent.refresh());

  Future<void> _onRefresh(ItemRefresh event, Emitter<ItemState> emit) async {
    try {
      emit(state.copyWith(isRefreshing: true));
      await _repository.fetch();
    } finally {
      emit(state.copyWith(isRefreshing: false));
      completeAwait(event); // 必须手动收尾,否则 RefreshIndicator 挂起
    }
  }
}
RefreshIndicator(
  onRefresh: () => context.read<ItemBloc>().refresh(),
  child: ListView.builder(...),
)

自动收尾(推荐)

onAwaittry/finally 自动调用 completeAwait,避免漏写导致挂起:

ItemBloc(super.initialState) : super() {
  onAwait<ItemRefresh>(_onRefresh); // 事件类型 + handler
}

Future<void> _onRefresh(ItemRefresh event, Emitter<ItemState> emit) async {
  emit(state.copyWith(isRefreshing: true));
  await _repository.fetch();
  emit(state.copyWith(isRefreshing: false));
} // finally 由 onAwait 自动补齐

要点:

  • runAwait 默认 30s 超时,防止 handler 抛异常或 BLoC 关闭时永久挂起;每个等待方独立计时,超时只结束自己,同事件下的其他等待方不受影响。
  • 页面销毁(close())时,所有未完成的等待以正常方式结束,不再抛出异常——下拉刷新后立刻退出页面不会再触发未捕获错误。
  • 合并等待依赖事件的值相等性:用 freezed 定义的事件天然具备;手写的普通类事件若未实现 ==hashCode,会退化为不合并(每次触发各自执行,不会报错)。
  • 需要排队、丢弃、重启这类特殊调度时,退回原生 on 注册,并在处理器结束处手动调用 completeAwait(event)

2. BlocCancelTokenMixin —— 自动取消网络

按操作 key 管理 Dio CancelToken,页面销毁自动取消、连续调用自动去重。

class ItemBloc extends Bloc<ItemEvent, ItemState>
    with BlocCancelTokenMixin<ItemState> {

  Future<void> _onFetch(ItemFetch event, Emitter<ItemState> emit) async {
    try {
      final items = await _repository.fetchItems(
        cancelToken: token('items'), // 一行,全自动管理
      );
      emit(state.copyWith(items: items));
    } catch (e) {
      if (isCancelled(e)) return; // 主动取消 → 静默,无需 import Dio
      final ex = e is Exception ? e : Exception(e.toString());
      emitEffect(ex.toToastEffect());
    }
  }

  void onCancelTapped() => cancelAll(); // 取消按钮中断所有进行中请求
}

要点:

  • 去重token('items') 每次调用都会先取消上一个同 key 请求再创建新 token。
  • 生命周期绑定close() 自动 cancelAll(),页面 pop 后不会收到陈旧响应。
  • key 隔离:不同 key('items' / 'upload')互不影响;并发同类请求用不同 key。
  • 默认 key 为 'default',适合单一操作类型的简单 BLoC。

3. BlocEffectMixin —— 一次性副作用

提供 effectStreamemitEffect,副作用走独立 Stream,不污染 State

class ItemBloc extends Bloc<ItemEvent, ItemState>
    with BlocEffectMixin<ItemState> {

  Future<void> _onSubmit(ItemSubmit event, Emitter<ItemState> emit) async {
    emitEffect(const LoadingEffect(show: true));   // 显示 Loading
    // ... 业务逻辑 ...
    emitEffect(const LoadingEffect(show: false));  // 隐藏 Loading
    emitEffect(const ToastEffect(l10nCode: 'saved'));
  }
}

关闭 BLoC 时 Mixin 自动 close() 控制器,无泄漏。UIEffect开放基类,自定义类型只需 extends UIEffect(详见 Effect 与 Notifiers)。


4. BlocErrorHandlerMixin —— 统一错误处理

把底层异步操作(Dio 等)的异常包装成 Result<T>(成功 / 失败 / 取消)。Failure 直接携带原始 Exception——框架不做任何业务或文案假设,提示文案由 BLoC 自行决定(见 错误处理与 Result)。

首选:runCatching

取代手写 try/catch,三态显式:

class ItemBloc extends Bloc<ItemEvent, ItemState>
    with BlocEffectMixin<ItemState>, BlocErrorHandlerMixin<ItemState> {

  Future<void> _onFetch(ItemFetch event, Emitter<ItemState> emit) async {
    final result = await runCatching(() => _repository.fetchItems());
    result.when(
      success: (items) => emit(state.copyWith(items: items)),
      failure: (ex) => emitEffect(ex.toToastEffect()),
      cancel: () {/* 主动取消,通常什么都不做 */},
    );
  }
}

runCatching 的映射规则:成功 → SuccessExceptionFailure(e)(原样保留);主动取消 → Cancel;其余异常 → Failure(Exception('unknown exception'))

能力清单

方法 作用
runCatching<T>(action) 包裹异步操作,返回 Result<T>;取消 → CancelExceptionFailure(e),其余 → Failure(Exception('unknown exception'))
isCancelled(error) 判断是否为主动取消(Dio 取消异常),用于避免弹 Toast

取消判断默认按 Dio 的 DioExceptionType.cancel。使用其它 HTTP 客户端时,覆盖 isCancelled 即可。


组合示例(登录)

四个 Mixin 在 login 模块协同(完整代码见 编写第一个功能模块):

class LoginBloc extends Bloc<LoginEvent, LoginState>
    with
        BlocAwaitMixin<LoginEvent, LoginState>,
        BlocEffectMixin<LoginState>,
        BlocErrorHandlerMixin<LoginState> {
  Future<void> submit() =>
      runAwait(event: const LoginEvent.submit());

  Future<void> _onSubmit(LoginSubmit event, Emitter<LoginState> emit) async {
    emit(state.copyWith(isSubmitting: true));
    emitEffect(const LoadingEffect(show: true));
    final result = await runCatching(
      () => repository.login(username: state.username, password: state.password),
    );
    emitEffect(const LoadingEffect(show: false));
    result.when(
      success: (_) => emitEffect(const ToastEffect(l10nCode: 'loginSuccess')),
      failure: (_) => emitEffect(const ToastEffect(l10nCode: 'loginFailed')),
      cancel: () {},
    );
  }
}
  • BlocAwaitMixin 让页面 await submit() 后能跳转;重复点击提交会合并到同一趟操作,不会重复发起请求。
  • BlocEffectMixin 发 Loading / Toast。
  • BlocErrorHandlerMixinrunCatching 消除 try/catch
  • (取消场景)若需要,BlocCancelTokenMixintoken('login') 可中断登录请求。

本页原文:docs/zh/architecture/bloc-mixins.md

报告本页错误