原始碼篇:Flutter Bloc背後的思想,一篇糾結的文章

xdd666發表於2021-06-15

前言

看了Bloc原始碼後,心情有點複雜呀。。。

img

說點積極的...

用過Bloc的靚仔們,肯定能感受到,Bloc框架對開發頁面,做了很清晰劃分,框架強行定了倆種開發模式

  • Bloc模式:該模式劃分四層結構
    • bloc:邏輯層
    • state:資料層
    • event:所有的互動事件
    • view:頁面
  • Cubit模式:該模式劃分了三層結構
    • cubit:邏輯層
    • state:資料層
    • view:頁面

作者在層次的劃分上還是很老道的,state層是直接寫死在框架內部,這層必須要單獨分出來;我感覺如果不是被大型專案的克蘇魯程式碼山坑過,應該不會有這麼深的執念img

這個state層加的,我覺得相當有必要,因為某個頁面一旦維護的狀態很多,將狀態變數和邏輯方法混在一起,後期維護會非常頭痛。

說點批判的...

  • 大家可能在群裡,經常看到一些老哥說:Bloc是將Provider封裝了一層。

    • 這裡我證實下:這是真的,Bloc確實將Provider封了一層
    • 但是僅僅只用到Provider中子節點查詢最近父節點InheritedElement資料和頂層Widget並列佈局功能,Provider最經典的重新整理機制,完全沒用到!
  • 我相當懷疑Bloc作者沒看懂Provider的重新整理機制

    • 哪怕bloc框架在build widget裡用到了一行: Provider.of(context, listen: true) 或者去掉e.markNeedsNotifyDependents() ,我都不會說這話。。。
    • Bloc框架做了一些讓我非常疑惑的操作,_startListening方法中的回撥中呼叫了 e.markNeedsNotifyDependents()完全沒用!因為沒使用Provider.of(context, listen: true) 向 InheritedElement 新增子Element,所以是重新整理了個寂寞!為了驗證我的想法,我debug了 framework層的notifyClients方法,呼叫emit或yield重新整理的時候, _dependents的map一直為空,哎。。。
  • 拋棄了Provider機制極簡的Callback回撥機制,選擇了Stream流這種。。。

  • 我上面吐槽了很多,並非我對bloc有什麼意見

    • Bloc我也用了較長的時間,深度使用過程,對其用法做了一些優化,還為其寫了一個程式碼生成外掛,為它也算付出了一些時間和精力
    • 但是:程式碼是不會說謊的,所有好的或不好的都在其中,用心體悟就能感受到。

如果我理解有誤,懇請大家指出,我真的很想找出點其中所蘊含的深意,改變我上面的想法。。。

為啥說心情複雜呢?

之前在看Provider原始碼的時候,看的有些頭痛,內部邏輯確實有些複雜,但是總流程理通,重新整理邏輯清晰之後,那是一種酣暢淋漓的感覺!痛苦之後便是一種巨大的滿足感,並對Provider熟練運用Framework層各種api,然後實現了精彩的重新整理機制,感到讚歎!

然後,上面也講了,我在Bloc上面確實花了一些精力,優化它的使用,然後看了他的原始碼,再想想之前看的Provider原始碼,突然有種巨大的落差感。

在我看來,這樣大名鼎鼎的開源庫,上面這點疙瘩完全可以避免;也許是這種莫名的高期待,讓我產生了這種落差。。。

使用

這邊介紹下使用,對官方的用法做了一些調整

調整心路的歷程,可參照:flutter_bloc使用解析---騷年,你還在手搭bloc嗎!

下面就直接寫出調整後寫法了

外掛

因為官方外掛生成的寫法,和調整後寫法差距有點大,而且官方外掛不支援生成view層和相關設定,此處我就擼了一個外掛,完善了相關功能

請注意,Wrap程式碼和提示程式碼片段,參靠了官方外掛規則

Wrap Widget 規則來著:intellij_generator_plugin

快捷程式碼生成規則來著: intellij_generator_plugin

  • 在Android Studio裡面搜尋 flutter bloc

image-20210612163803311

  • 生成模板程式碼

bloc_template

  • 支援修改字尾

image-20210612165242515

  • Wrap Widget (alt + enter):RepositoryProvider,BlocConsumer,BlocBuilder,BlocProvider,BlocListener

image-20210612164717855

  • 輸入 bloc 可生成快捷程式碼片段

image-20210612164905296

用法

外掛可生成倆種模式程式碼:Bloc和Cubit;來看下

Cubit模式

  • view
class CounterPage extends StatelessWidget {
  final cubit = CounterCubit();

  @override
  Widget build(BuildContext context) {
    return BlocProvider(
      create: (BuildContext context) => cubit,
      child: Container(),
    );
  }
}
  • cubit
class CounterCubit extends Cubit<CounterState> {
  CounterCubit() : super(CounterState().init());
}
  • state
class CounterState {
  CounterState init() {
    return CounterState();
  }

  CounterState clone() {
    return CounterState();
  }
}

Bloc模式

  • view:預設新增了一個初始化事件
class CounterPage extends StatelessWidget {
  final bloc = CounterBloc();

  @override
  Widget build(BuildContext context) {
    return BlocProvider(
      create: (BuildContext context) => bloc..add(InitEvent()),
      child: Container(),
    );
  }
}
  • bloc
class CounterBloc extends Bloc<CounterEvent, CounterState> {
  CounterBloc() : super(CounterState().init());

  @override
  Stream<CounterState> mapEventToState(CounterEvent event) async* {
    if (event is InitEvent) {
      yield await init();
    }
  }

  Future<CounterState> init() async {
    return state.clone();
  }
}
  • event
abstract class CounterEvent {}

class InitEvent extends CounterEvent {}
  • state
class CounterState {
  CounterState init() {
    return CounterState();
  }

  CounterState clone() {
    return CounterState();
  }
}

總結

Bloc和Cubit模式對於結構,劃分的很清楚,因為有多層結構劃分,務必會有相應的模板程式碼和檔案,沒有外掛的幫助,每次都寫這些模板程式碼,會非常難受;這邊為大家寫了這個外掛,如果有什麼BUG,麻煩及時反饋哈。。。

這裡就不重複寫怎麼使用了,使用明細可參照:flutter_bloc使用解析---騷年,你還在手搭bloc嗎!

前置知識

想弄懂Bloc原理,需要先了解下Stream的相關知識

StreamController、StreamBuilder:這倆者的搭配也可以輕鬆的實現重新整理區域性Widget,來看下使用

  • view:Stream流必須要有關閉的操作,此處就需要使用StatefulWidget,需要它的dispose回撥
class StreamPage extends StatefulWidget {
  const StreamPage({Key? key}) : super(key: key);

  @override
  _StreamPageState createState() => _StreamPageState();
}

class _StreamPageState extends State<StreamPage> {
  final logic = StreamLogic();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Bloc-Bloc範例')),
      body: Center(
        child: StreamBuilder<StreamState>(
          initialData: logic.state,
          stream: logic.stream,
          builder: (context, snapshot) {
            return Text(
              '點選了 ${snapshot.data!.count} 次',
              style: TextStyle(fontSize: 30.0),
            );
          },
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () => logic.increment(),
        child: Icon(Icons.add),
      ),
    );
  }

  @override
  void dispose() {
    logic.dispose();
    super.dispose();
  }
}
  • logic:Stream資料來源是泛型,可以直接使用基礎型別,此處使用實體,是為了後期可擴充套件更多資料
class StreamLogic {
  final state = StreamState();

  // 例項化流控制器
  final _controller = StreamController<StreamState>.broadcast();

  Stream<StreamState> get stream => _controller.stream;

  void increment() {
    _controller.add(state..count = ++state.count);
  }

  void dispose() {
    // 關閉流控制器,釋放資源
    _controller.close();
  }
}
  • state
class StreamState {
  int count = 0;
}
  • 效果圖

stream

實際上,看了上述的使用,會發現有幾個很麻煩的地方

  • 需要建立Stream的一系列物件
  • Stream流必須要有關閉操作,所以要使用StatefulWidget
  • StreamBuilder需要寫三個引數,很麻煩

Bloc作者借住Provider的InheritedProvider控制元件,將上面的痛點都解決了

重新整理機制

Bloc的重新整理機制很簡單,上面的Stream操作,基本闡明瞭其核心的重新整理機制,但是Bloc作者做了一些封裝,我們來看看

BlocProvider的魅力

BlocProvider是一個非常重要的控制元件,重新整理引數的精簡和Stream流的關閉都和其有關,因為該封裝了一個Provider裡面InheritedProvider;但是,但是在我看來,他依舊是一個很有魅力的控制元件

  • BlocProvider:BlocProvider的原始碼很簡單,下面就是這個類的原始碼
class BlocProvider<T extends BlocBase<Object?>>
    extends SingleChildStatelessWidget with BlocProviderSingleChildWidget {
  /// {@macro bloc_provider}
  BlocProvider({
    Key? key,
    required Create<T> create,
    this.child,
    this.lazy,
  })  : _create = create,
        _value = null,
        super(key: key, child: child);

  BlocProvider.value({
    Key? key,
    required T value,
    this.child,
  })  : _value = value,
        _create = null,
        lazy = null,
        super(key: key, child: child);

  /// Widget which will have access to the [Bloc] or [Cubit].
  final Widget? child;
    
  final bool? lazy;

  final Create<T>? _create;

  final T? _value;

  static T of<T extends BlocBase<Object?>>(
    BuildContext context, {
    bool listen = false,
  }) {
    try {
      return Provider.of<T>(context, listen: listen);
    } on ProviderNotFoundException catch (e) {
      if (e.valueType != T) rethrow;
      throw FlutterError(
        '''
        BlocProvider.of() called with a context that does not contain a $T.
        No ancestor could be found starting from the context that was passed to BlocProvider.of<$T>().

        This can happen if the context you used comes from a widget above the BlocProvider.

        The context used was: $context
        ''',
      );
    }
  }

  @override
  Widget buildWithChild(BuildContext context, Widget? child) {
    final value = _value;
    return value != null
        ? InheritedProvider<T>.value(
            value: value,
            startListening: _startListening,
            lazy: lazy,
            child: child,
          )
        : InheritedProvider<T>(
            create: _create,
            dispose: (_, bloc) => bloc.close(),
            startListening: _startListening,
            child: child,
            lazy: lazy,
          );
  }

  static VoidCallback _startListening(
    InheritedContext<BlocBase> e,
    BlocBase value,
  ) {
    final subscription = value.stream.listen(
      (dynamic _) => e.markNeedsNotifyDependents(),
    );
    return subscription.cancel;
  }
}
  • BlocProvider和BlocProvider.value的區別

    • 看上面原始碼可知:BlocProvider.value沒有做Stream自動關閉操作
      • 所以BlocProvider.value不應該在普通的單頁面使用,可用於全域性Bloc例項
    • 單頁面Bloc請使用BlocProvider去建立Bloc或Cubit
  • create是外部例項化的XxxBloc,最終傳入了InheritedProvider中

    • create就是外部傳入的XxxBloc例項
    • 該例項直接傳入了InheritedProvider中,這就是涉及到Provider中,最終是儲存在 _InheritedProviderScopeElement中, _startListening也是Provider的內容
    • 說真的 _startListening裡面的邏輯沒什麼卵用
      • markNeedsNotifyDependents這個api是Provider作者專門為Provider子Element重新整理做的,必須配套 Provider.of(context, listen: true) 去註冊Widget控制元件才行
      • 涉及邏輯太多,都在上面Provider原始碼剖析文章中,感興趣的可以去看看
  • BlocProvider.of

    • 作用:可以在BlocProvider包裹的子控制元件中,獲取到BlocProvider Create傳入的XxxBloc
    • 請注意:如果使用BlocProvider父佈局context是拿不到XxxBloc的,必須是BlocProvider的子佈局
    • 原理:原始碼篇:Flutter Provider的另一面(萬字圖文+外掛),還是在這篇文章裡
      • 我真的不是推廣這文章啊,BlocProvider這部分,Bloc用了太多Provider特性
      • Provider文章,我花了九牛二虎之力將原理剖析完,在此處,就沒必要再做復讀機了

總結:來歸納下BlocProvider這個類的作用

  1. BlocProvider或會儲存外部傳入的XxxBloc例項,XxxBloc類必須繼承BlocBase
  2. BlocProvider儲存的XxxBloc例項,可以通過BlocProvider.of獲取到(必須是在BlocProvider或其子Widget)
  3. BlocProvider獲取的例項XxxBloc能夠自動釋放;BlocProvider.value命名建構函式例項的XxxBloc不會自動釋放

BlocProvider實現了上面這三個碉堡的功能,基本就可以把Stream使用模式徹底精簡了

  • 圖示

BlocProvider

基石BlocBase

毋庸置疑,BlocBase是很重要的一個抽象類

  • BlocBase
abstract class BlocBase<State> {
  BlocBase(this._state) {
    Bloc.observer.onCreate(this);
  }

  StreamController<State>? __stateController;
  StreamController<State> get _stateController {
    return __stateController ??= StreamController<State>.broadcast();
  }

  State _state;

  bool _emitted = false;

  State get state => _state;

  Stream<State> get stream => _stateController.stream;

  @Deprecated(
    'Use stream.listen instead. Will be removed in v8.0.0',
  )
  StreamSubscription<State> listen(
    void Function(State)? onData, {
    Function? onError,
    void Function()? onDone,
    bool? cancelOnError,
  }) {
    return stream.listen(
      onData,
      onError: onError,
      onDone: onDone,
      cancelOnError: cancelOnError,
    );
  }

  void emit(State state) {
    if (_stateController.isClosed) return;
    if (state == _state && _emitted) return;
    onChange(Change<State>(currentState: this.state, nextState: state));
    _state = state;
    _stateController.add(_state);
    _emitted = true;
  }

  @mustCallSuper
  void onChange(Change<State> change) {
    Bloc.observer.onChange(this, change);
  }

  @mustCallSuper
  void addError(Object error, [StackTrace? stackTrace]) {
    onError(error, stackTrace ?? StackTrace.current);
  }

  @protected
  @mustCallSuper
  void onError(Object error, StackTrace stackTrace) {
    Bloc.observer.onError(this, error, stackTrace);
    assert(() {
      throw BlocUnhandledErrorException(this, error, stackTrace);
    }());
  }

  @mustCallSuper
  Future<void> close() async {
    Bloc.observer.onClose(this);
    await _stateController.close();
  }
}

上面的BlocBase做了幾件比較重要的事,來梳理下

Bloc.observer這個不重要,這是框架內部定義的一個類,這邊可以忽略掉,不太重要

  1. 儲存了傳入的state物件
    • 每次使用emit重新整理的時候,會將傳入state替換之前儲存state物件
    • emit做了一個判斷,如果傳入state和儲存state物件相同,將不執行重新整理操作(這就是我在State類裡面,加clone方法的原因)
  2. 初始化了Stream一系列物件
  3. 封裝了關閉Stream流的操作
  • 將上面的程式碼精簡下
abstract class BlocBase<T> {
  BlocBase(this.state) : _stateController = StreamController<T>.broadcast();

  final StreamController<T> _stateController;

  T state;

  bool _emitted = false;

  Stream<T> get stream => _stateController.stream;

  void emit(T newState) {
    if (_stateController.isClosed) return;
    if (state == newState && _emitted) return;
    state = newState;
    _stateController.add(state);
    _emitted = true;
  }

  @mustCallSuper
  Future<void> close() async {
    await _stateController.close();
  }
}

BlocBuilder

BlocBuilder對StreamBuilder的用法做了很多精簡,來看下內部實現

  • BlocBuilder
    • 此處需要關注下builder引數; buildWhen是個判斷是否需要更新的引數
    • build方法裡面呼叫了builder,需要看下父類BlocBuilderBase
typedef BlocWidgetBuilder<S> = Widget Function(BuildContext context, S state);

class BlocBuilder<B extends BlocBase<S>, S> extends BlocBuilderBase<B, S> {
  const BlocBuilder({
    Key? key,
    required this.builder,
    B? bloc,
    BlocBuilderCondition<S>? buildWhen,
  }) : super(key: key, bloc: bloc, buildWhen: buildWhen);

  final BlocWidgetBuilder<S> builder;

  @override
  Widget build(BuildContext context, S state) => builder(context, state);
}
  • BlocBuilderBase
    • context.read< B>() 和 Provider.of(this, listen: false)效果是一樣的,就是對後者的一個封裝
    • 此處通過context.read< B>() 拿到了 我們在 BlocProvider中傳入的XxxBloc物件,賦值給了_BlocBuilderBaseState中的 _bloc變數
    • BlocBuilderBase抽象了一個build方法,在 _BlocBuilderBaseState中賦值給了 BlocListener
    • BlocBuilderBase還沒法看出重新整理邏輯,幾個重要的引數:_bloc,listener,widget.build都傳給了BlocListener;需要看下BlocListener的實現
abstract class BlocBuilderBase<B extends BlocBase<S>, S>
    extends StatefulWidget {
  const BlocBuilderBase({Key? key, this.bloc, this.buildWhen})
      : super(key: key);

  final B? bloc;

  final BlocBuilderCondition<S>? buildWhen;

  Widget build(BuildContext context, S state);

  @override
  State<BlocBuilderBase<B, S>> createState() => _BlocBuilderBaseState<B, S>();
}

class _BlocBuilderBaseState<B extends BlocBase<S>, S>
    extends State<BlocBuilderBase<B, S>> {
  late B _bloc;
  late S _state;

  @override
  void initState() {
    super.initState();
    _bloc = widget.bloc ?? context.read<B>();
    _state = _bloc.state;
  }

  ...

  @override
  Widget build(BuildContext context) {
    ...
    return BlocListener<B, S>(
      bloc: _bloc,
      listenWhen: widget.buildWhen,
      listener: (context, state) => setState(() => _state = state),
      child: widget.build(context, _state),
    );
  }
}
  • BlocListener:引數傳給父類的建構函式了,需要看下父類BlocListenerBase的實現
class BlocListener<B extends BlocBase<S>, S> extends BlocListenerBase<B, S>
  const BlocListener({
    Key? key,
    required BlocWidgetListener<S> listener,
    B? bloc,
    BlocListenerCondition<S>? listenWhen,
    Widget? child,
  }) : super(
          key: key,
          child: child,
          listener: listener,
          bloc: bloc,
          listenWhen: listenWhen,
        );
}
  • BlocListenerBase:精簡了一些邏輯程式碼
abstract class BlocListenerBase<B extends BlocBase<S>, S>
    extends SingleChildStatefulWidget {
  const BlocListenerBase({
    Key? key,
    required this.listener,
    this.bloc,
    this.child,
    this.listenWhen,
  }) : super(key: key, child: child);

  final Widget? child;

  final B? bloc;

  final BlocWidgetListener<S> listener;

  final BlocListenerCondition<S>? listenWhen;

  @override
  SingleChildState<BlocListenerBase<B, S>> createState() =>
      _BlocListenerBaseState<B, S>();
}

class _BlocListenerBaseState<B extends BlocBase<S>, S>
    extends SingleChildState<BlocListenerBase<B, S>> {
  StreamSubscription<S>? _subscription;
  late B _bloc;
  late S _previousState;

  @override
  void initState() {
    super.initState();
    _bloc = widget.bloc ?? context.read<B>();
    _previousState = _bloc.state;
    _subscribe();
  }

  ...

  @override
  Widget buildWithChild(BuildContext context, Widget? child) {
    return child!;
  }

  @override
  void dispose() {
    _unsubscribe();
    super.dispose();
  }

  void _subscribe() {
    _subscription = _bloc.stream.listen((state) {
      if (widget.listenWhen?.call(_previousState, state) ?? true) {
        widget.listener(context, state);
      }
      _previousState = state;
    });
  }

  void _unsubscribe() {
    _subscription?.cancel();
    _subscription = null;
  }
}

終於找了關鍵的程式碼了!

可以發現Bloc是通過 StreamController 和 listen配合實現重新整理的

呼叫的 widget.listener(context, state),這個實現的方法是個setState,大家可以看看 _BlocBuilderBaseState這個類

_bloc.stream.listen(
  (state) {
    if (widget.listenWhen?.call(_previousState, state) ?? true) {
      widget.listener(context, state);
    }
    _previousState = state;
  },
);

精簡BlocBuild

上面的BlocBuild的實現邏輯還是太繞,封裝層級太多,下面寫個精簡版的BlocBuild

當然了,肯定會保留BlocBuild重新整理的核心邏輯

class BlocEasyBuilder<T extends BlocBase<V>, V> extends StatefulWidget {
  const BlocEasyBuilder({
    Key? key,
    required this.builder,
  }) : super(key: key);

  final Function(BuildContext context, V state) builder;

  @override
  _BlocEasyBuilderState createState() => _BlocEasyBuilderState<T, V>();
}

class _BlocEasyBuilderState<T extends BlocBase<V>, V>
    extends State<BlocEasyBuilder<T, V>> {
  late T _bloc;
  late V _state;
  StreamSubscription<V>? _listen;

  @override
  void initState() {
    _bloc = BlocProvider.of<T>(context);
    _state = _bloc.state;

    //資料改變重新整理Widget
    _listen = _bloc.stream.listen((event) {
      setState(() {});
    });
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return widget.builder(context, _state);
  }

  @override
  void dispose() {
    _listen?.cancel();
    super.dispose();
  }
}
  • 來看下效果圖:詳細的使用程式碼,請檢視:flutter_use

builder

Event機制

如果使用Bloc模式開發,會多出一個Event層,該層是定義所有的事件互動

這邊提一下

  • Bloc:省略了一些程式碼
abstract class Bloc<Event, State> extends BlocBase<State> {
  /// {@macro bloc}
  Bloc(State initialState) : super(initialState) {
    _bindEventsToStates();
  }

  StreamSubscription<Transition<Event, State>>? _transitionSubscription;

  StreamController<Event>? __eventController;
  StreamController<Event> get _eventController {
    return __eventController ??= StreamController<Event>.broadcast();
  }

  void add(Event event) {
    if (_eventController.isClosed) return;
    try {
      onEvent(event);
      _eventController.add(event);
    } catch (error, stackTrace) {
      onError(error, stackTrace);
    }
  }

  Stream<Transition<Event, State>> transformEvents(
    Stream<Event> events,
    TransitionFunction<Event, State> transitionFn,
  ) {
    return events.asyncExpand(transitionFn);
  }

  @protected
  @visibleForTesting
  @override
  void emit(State state) => super.emit(state);

  Stream<State> mapEventToState(Event event);

  Stream<Transition<Event, State>> transformTransitions(
    Stream<Transition<Event, State>> transitions,
  ) {
    return transitions;
  }

  @override
  @mustCallSuper
  Future<void> close() async {
    await _eventController.close();
    await _transitionSubscription?.cancel();
    return super.close();
  }

  void _bindEventsToStates() {
    _transitionSubscription = transformTransitions(
      transformEvents(
        _eventController.stream,
        (event) => mapEventToState(event).map(
          (nextState) => Transition(
            currentState: state,
            event: event,
            nextState: nextState,
          ),
        ),
      ),
    ).listen(
      (transition) {
        if (transition.nextState == state && _emitted) return;
        try {
          emit(transition.nextState);
        } catch (error, stackTrace) {
          onError(error, stackTrace);
        }
      },
      onError: onError,
    );
  }
}

整體邏輯比較清晰,來理一下

  1. Bloc是抽象類
    • 建構函式裡面呼叫 _bindEventsToStates() 方法
    • Bloc抽象了一個mapEventToState(Event event)方法,繼承Bloc抽象類,必須實現該方法
  2. Bloc類中,例項了Stream流物件,來做Event的事件觸發機制
    • 新增Event事件時,會觸發 _bindEventsToStates() 方法中的listener回撥
  3. _bindEventsToStates裡面做了一些操作
    • 被新增的Event事件:events.asyncExpand(transitionFn);先將自身Event引數傳入transitionFn方法中執行
    • transitionFn的邏輯是:將Event引數傳入mapEventToState中,然後mapEventToState回傳State物件
    • 然後觸發listen回撥,listen中,將state傳emit中,然後觸發重新整理控制元件重建

總結

上面幾個關鍵的類分析完,整個Bloc的執行機制,一下子就明朗了

BlocProvider

  • 負責儲存 傳入XxxBloc加以儲存

  • 提供的of方法,可以在BlocProvider或其子節點位置,獲取到儲存的XxxBloc

  • 提供回收資源的回撥(回收Stream流)

BlocBase

  • 儲存了傳入的state物件

  • 初始化了Stream一系列物件

  • 封裝了關閉Stream流的操作

BlocBuilder

  • 本質是StatefulWidget
  • 通過BlocProvider獲取到XxxBloc,再通過其listener方法監聽資料改變
  • 資料改變後,通過setState重建StatefulWidget,以達到區域性重新整理的效果

手搓一個狀態管理框架

Bloc的原理相對Provider而言,要簡單很多。。。

模仿Bloc的重新整理機制,來手搓一個狀態管理框架!用EasyC來命名吧!

img

手搓

  • EasyC:首先需要寫一個基類,處理Stream一系列的操作
abstract class EasyC<T> {
  EasyC(this.state) : _controller = StreamController<T>.broadcast();

  final StreamController<T> _controller;

  T state;

  bool _emitted = false;

  Stream<T> get stream => _controller.stream;

  void emit(T newState) {
    if (_controller.isClosed) return;
    if (state == newState && _emitted) return;
    state = newState;
    _controller.add(state);
    _emitted = true;
  }

  @mustCallSuper
  Future<void> close() async {
    await _controller.close();
  }
}
  • EasyCProvider
    • 這裡就不使用Provider框架提供的InheritedProvider了
    • 這邊我用InheritedWidget手搓了一個
    • of方法和stream流的關閉都搞定了;不用手動關流,也不用寫StatefulWidget了!
class EasyCProvider<T extends EasyC> extends InheritedWidget {
  EasyCProvider({
    Key? key,
    Widget? child,
    required this.create,
  }) : super(key: key, child: child ?? Container());

  final T Function(BuildContext context) create;

  @override
  bool updateShouldNotify(InheritedWidget oldWidget) => false;

  @override
  InheritedElement createElement() => EasyCInheritedElement(this);

  static T of<T extends EasyC>(BuildContext context) {
    var inheritedElement =
        context.getElementForInheritedWidgetOfExactType<EasyCProvider<T>>()
            as EasyCInheritedElement<T>?;

    if (inheritedElement == null) {
      throw 'not found';
    }

    return inheritedElement.value;
  }
}

class EasyCInheritedElement<T extends EasyC> extends InheritedElement {
  EasyCInheritedElement(EasyCProvider<T> widget) : super(widget);

  bool _firstBuild = true;

  late T _value;

  T get value => _value;

  @override
  void performRebuild() {
    if (_firstBuild) {
      _firstBuild = false;
      _value = (widget as EasyCProvider<T>).create(this);
    }

    super.performRebuild();
  }

  @override
  void unmount() {
    _value.close();
    super.unmount();
  }
}
  • EasyCBuilder:最後整一個定點重新整理Widget
class EasyCBuilder<T extends EasyC<V>, V> extends StatefulWidget {
  const EasyCBuilder({
    Key? key,
    required this.builder,
  }) : super(key: key);

  final Function(BuildContext context, V state) builder;

  @override
  _EasyCBuilderState createState() => _EasyCBuilderState<T, V>();
}

class _EasyCBuilderState<T extends EasyC<V>, V>
    extends State<EasyCBuilder<T, V>> {
  late T _easyC;
  late V _state;
  StreamSubscription<V>? _listen;

  @override
  void initState() {
    _easyC = EasyCProvider.of<T>(context);
    _state = _easyC.state;

    //資料改變重新整理Widget
    _listen = _easyC.stream.listen((event) {
      setState(() {});
    });
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return widget.builder(context, _state);
  }

  @override
  void dispose() {
    _listen?.cancel();
    super.dispose();
  }
}

上面這三個檔案,基本就把Bloc的重新整理機制再現了

同時,也去掉了我心中的一個疙瘩,Bloc原始碼對 Provider的 _startListening方法,莫名其妙的使用。。。

使用

使用基本和Bloc一摸一樣

我本來想把emit倆個新舊state物件對比的判斷去掉,但是想想Bloc作者對這個理念好像有很深的執念,在很多地方都做了處理;所以,這邊我也就保留了,也可以保留Bloc原汁原味的用法

  • view
class CounterEasyCPage extends StatelessWidget {
  final easyC = CounterEasyC();

  @override
  Widget build(BuildContext context) {
    return EasyCProvider(
      create: (BuildContext context) => easyC,
      child: Scaffold(
        appBar: AppBar(title: Text('自定義狀態管理框架-EasyC範例')),
        body: Center(
          child: EasyCBuilder<CounterEasyC, CounterEasyCState>(
            builder: (context, state) {
              return Text(
                '點選了 ${easyC.state.count} 次',
                style: TextStyle(fontSize: 30.0),
              );
            },
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () => easyC.increment(),
          child: Icon(Icons.add),
        ),
      ),
    );
  }
}
  • logic
class CounterEasyC extends EasyC<CounterEasyCState> {
  CounterEasyC() : super(CounterEasyCState().init());

  ///自增
  void increment() => emit(state.clone()..count = ++state.count);
}
  • state
class CounterEasyCState {
  late int count;

  CounterEasyCState init() {
    return CounterEasyCState()..count = 0;
  }

  CounterEasyCState clone() {
    return CounterEasyCState()..count = count;
  }
}
  • 效果圖

EasyC

全域性也是可以的,和Provider沒什麼不一樣,我這邊就不重複寫了

總結

這手搓的EasyC框架,保留Bloc重新整理機制的精髓,同時,也做了大量的精簡

相信有緣人只要用心看看,一定能夠理解的

Bloc的原始碼並不複雜,他是對Stream的使用,做了一個大大的精簡,基本使用痛點,全都封裝起來,內部處理了

最後

留言板

Provider和Bloc的原始碼解析終於寫完了,就差最後一篇GetX了。。。

img

為了證明我寫的分析原始碼是有作用且有效果的,在末尾,我都根據其狀態管理框架的重新整理機制,手搓了一個全新的狀態管理框架

選擇狀態管理框架,應該是一件比較慎重的事;事先可以先看看其原理,理解了他的內部運轉機制,就完全可以去按需選擇了,因為你明白了它的內部運轉機制,就算使用過程中出現什麼問題,你也能從容應對了;如果你怕作者棄坑或不滿意其功能,選擇你自己想要的重新整理機制,自己去手搓一個!

Provider,Bloc,GetX這三個框架,我都寫了相應外掛,如果你選擇的狀態管理框架是這個三者中任意一個,相信這些外掛,都能幫你完成一些重複的工作量

image-20210614225646560

相關地址

系列文章

相關文章