Flutter StreamBuilder原始碼分析

i校長發表於2020-03-28
FlutterUI原始碼

您好

經過一段時間的接觸，和專案的不斷迭代，不得不用一些手段來控制Widget的狀態，對於大多數剛接觸Flutter的人，知道如何更新Flutter元件的方式無非就是setState，還在某些論壇或者官網上看到InheritedWidget這個東東，那他們是如何更新的UI呢？這期我們不談InheritedWidget，但當我點進去StreamBuilder裡看到它繼承自StatefulWidget時，我T..驚了，難道StreamBuilder也是setState？所以接下來，我們一探究竟。

StreamBuilder 原始碼

class StreamBuilder<T> extends StreamBuilderBase<T, AsyncSnapshot<T>> {
  /// [stream] 與指定[Streams]的互動快照，
  ///  [builder] 必須傳，構建UI
  /// [initialData] 初始化資料時用
  /// 建立StreamBuilder物件
  const StreamBuilder({
    Key key,
    this.initialData,
    Stream<T> stream,
    @required this.builder,
  }) : assert(builder != null),
       super(key: key, stream: stream);

  /// 為當前物件建立一個非同步策略的builder
  final AsyncWidgetBuilder<T> builder;

  /// 抽象這個主要是因為資料是非同步的，
  /// 需要一個初始值用於顯示。
  final T initialData;

  @override
  AsyncSnapshot<T> initial() => AsyncSnapshot<T>.withData(ConnectionState.none, initialData);

  @override
  AsyncSnapshot<T> afterConnected(AsyncSnapshot<T> current) => current.inState(ConnectionState.waiting);

  @override
  AsyncSnapshot<T> afterData(AsyncSnapshot<T> current, T data) {
    return AsyncSnapshot<T>.withData(ConnectionState.active, data);
  }

  @override
  AsyncSnapshot<T> afterError(AsyncSnapshot<T> current, Object error) {
    return AsyncSnapshot<T>.withError(ConnectionState.active, error);
  }

  @override
  AsyncSnapshot<T> afterDone(AsyncSnapshot<T> current) => current.inState(ConnectionState.done);

  @override
  AsyncSnapshot<T> afterDisconnected(AsyncSnapshot<T> current) => current.inState(ConnectionState.none);

  @override
  Widget build(BuildContext context, AsyncSnapshot<T> currentSummary) => builder(context, currentSummary);
}
複製程式碼

這裡觀察到四個關鍵的類

  • StreamBuilderBase<T, AsyncSnapshot>
  • AsyncWidgetBuilder
  • AsyncSnapshot
  • Stream 都是什麼鬼，我也不知道，我們往下看，接下來一個個分析下

StreamBuilderBase<T, AsyncSnapshot>

StreamBuilder的基類，StreamBuilderBase使用了泛型

  • T 就是我們定義的資料型別
  • S 從上面可以看到它的實現是AsyncSnapshot，為什麼用AsyncSnapshot包一層呢，一會我們看下AsyncSnapshot到底是幹嘛的就明白了。接著往下看，可以直接看原始碼註釋：
abstract class StreamBuilderBase<T, S> extends StatefulWidget {
  /// 建構函式，主要接收Stream流
  const StreamBuilderBase({ Key key, this.stream }) : super(key: key);

  /// 這裡需要注意的是，有可能為空，因為我們有可能不傳，我有個疑問，如果不傳的話，UI處理什麼呢？
  final Stream<T> stream;

   /// 我們結合子類的實現 
   /// AsyncSnapshot<T>.withData(ConnectionState.none, initialData)
   /// 返回了AsyncSnapshot的函式withData，並設定當前的AsyncSnapshot快照的狀態為ConnectionState.none，並傳入我們的初始化資料initialData
  S initial();

  /// 返回 current.inState(ConnectionState.waiting)，改狀態為waiting
  S afterConnected(S current) => current;

  /// 返回 AsyncSnapshot<T>.withData(ConnectionState.active, data)
  /// 改變連線狀態active，並更新資料data
  S afterData(S current, T data);

  /// 返回 AsyncSnapshot<T>.withError(ConnectionState.active, error);
  /// 通知前端有錯誤
  S afterError(S current, Object error) => current;

  /// 返回current.inState(ConnectionState.done)，改變狀態done
  S afterDone(S current) => current;

  /// current.inState(ConnectionState.none) ，改變狀態none
  S afterDisconnected(S current) => current;

  /// 返回 builder(context, currentSummary) 
  /// 其實這裡就是我們實現的builder程式碼
  Widget build(BuildContext context, S currentSummary);

  @override
  State<StreamBuilderBase<T, S>> createState() => _StreamBuilderBaseState<T, S>();
}
複製程式碼

這裡發現都是一些抽象函式，被StreamBuilder都逐個實現了，目的很清晰，抽象的函式都是對AsyncSnapshot的操作，從初始化到更新再到斷開。不難猜出，其實AsyncSnapshot就是對我們傳入的資料T的一個包裝類，用來記錄並控制資料的狀態，角色類似我們網路請求中BaseResponse的存在，是不是很像。接下來到重點了，來看看StreamBuilder如何操作的AsyncSnapshot。來看下程式碼

_StreamBuilderBaseState類

大致流程： 在 initState 、didUpdateWidget 中會呼叫 _subscribe 方法，從而呼叫 Stream 的 listen，然後通過 setState 更新UI

/// State for [StreamBuilderBase].
class _StreamBuilderBaseState<T, S> extends State<StreamBuilderBase<T, S>> {
  StreamSubscription<T> _subscription;
  S _summary;

  @override
  void initState() {
    super.initState();
    _summary = widget.initial();
    _subscribe();
  }

  @override
  void didUpdateWidget(StreamBuilderBase<T, S> oldWidget) {
    super.didUpdateWidget(oldWidget);
    if (oldWidget.stream != widget.stream) {
      if (_subscription != null) {
        _unsubscribe();
        _summary = widget.afterDisconnected(_summary);
      }
      _subscribe();
    }
  }

  @override
  Widget build(BuildContext context) => widget.build(context, _summary);

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

  void _subscribe() {
    if (widget.stream != null) {
      _subscription = widget.stream.listen((T data) {
        setState(() {
          _summary = widget.afterData(_summary, data);
        });
      }, onError: (Object error) {
        setState(() {
          _summary = widget.afterError(_summary, error);
        });
      }, onDone: () {
        setState(() {
          _summary = widget.afterDone(_summary);
        });
      });
      _summary = widget.afterConnected(_summary);
    }
  }

  void _unsubscribe() {
    if (_subscription != null) {
      _subscription.cancel();
      _subscription = null;
    }
  }
}
複製程式碼

這裡又出現了一個新角色 StreamSubscription ，請看_subscribe函式就知道是個什麼了，

_subscription = widget.stream.listen
複製程式碼

它就是Stream流的訂閱者 Subscription，嗯，到這裡我也明白了，Stream是一個觀察者，而流裡面的資料就是通過listen函式新增一個監聽， 當Stream裡的資料發生相應的變化，然後通知_subscription訂閱者。 我們再往下看，

_subscription = widget.stream.listen((T data) {
        setState(() {
          _summary = widget.afterData(_summary, data);
        });
      }, onError: (Object error) {
        setState(() {
          _summary = widget.afterError(_summary, error);
        });
      }, onDone: () {
        setState(() {
          _summary = widget.afterDone(_summary);
        });
      });
      _summary = widget.afterConnected(_summary);
    }
複製程式碼

看到了吧，setState出現了，還真是，我擦。這裡根據Stream流的實現去呼叫StreamBuilder中實現的afterData，afterError，afterDone等函式。 分析完StreamBuilderBase，發現不用往下分析了，因為全清晰了，那我們來總結一下

總結

StreamBuilder其實就是包裝了Stream流、還有對資料T包裝的AsyncSnapshot快照，在Statefulwiget合適的生命週期，初始化，繫結Stream流的監聽，並在生命結束的時候自動解綁，Stream流是一個生產者消費者模型，但資料是通過觀察者模式通知的，最關鍵的是資料還是通過setState更新。 總結幾點：

  • StreamBuilder 並沒有什麼實質性的效能提升
  • StreamBuilder 也是一個Statefulwidget，等於是增加了一層巢狀。
  • StreamBuilder 很像是VM的角色，建議使用，一個簡單的MVVM架構就這麼實現了。

相關文章