作為系列文章的第十一篇，本篇將非常全面帶你了解 Flutter 中最關鍵的設計之一，深入原理幫助你理解 Stream 全家桶，這也許是目前 Flutter 中最全面的 Stream 分析了。
文章匯總地址：
一、Stream 由淺入深
Stream 在 Flutter 是屬于非常關鍵的概念，在 Flutter 中，狀態管理除了 InheritedWidget 之外，無論 rxdart，Bloc 模式，flutter_redux ，fish_redux 都離不開 Stream 的封裝，而事實上 Stream 并不是 Flutter 中特有的，而是 Dart 中自帶的邏輯。
通俗來說，Stream 就是事件流或者管道，事件流相信大家并不陌生，簡單的說就是：基于事件流驅動設計代碼，然后監聽訂閱事件，并針對事件變換處理響應。
而在 Flutter 中，整個 Stream 設計外部暴露的對象主要如下圖，主要包含了 StreamController 、Sink 、Stream 、StreamSubscription 四個對象。
1、Stream 的簡單使用
如下代碼所示，Stream 的使用并不復雜，一般我們只需要：
- 創建
StreamController， - 然后獲取
StreamSink用做事件入口， - 獲取
Stream對象用于監聽， - 并且通過監聽得到
StreamSubscription管理事件訂閱，最后在不需要時關閉即可，看起來是不是很簡單？
class DataBloc {
///定義一個Controller
StreamController<List<String>> _dataController = StreamController<List<String>>();
///獲取 StreamSink 做 add 入口
StreamSink<List<String>> get _dataSink => _dataController.sink;
///獲取 Stream 用于監聽
Stream<List<String>> get _dataStream => _dataController.stream;
///事件訂閱對象
StreamSubscription _dataSubscription;
init() {
///監聽事件
_dataSubscription = _dataStream.listen((value){
///do change
});
///改變事件
_dataSink.add(["first", "second", "three", "more"]);
}
close() {
///關閉
_dataSubscription.cancel();
_dataController.close();
}
}
在設置好監聽后，之后每次有事件變化時， listen 內的方法就會被調用，同時你還可以通過操作符對 Stream 進行變換處理。
如下代碼所示，是不是一股 rx 風撲面而來？
_dataStream.where(test).map(convert).transform(streamTransformer).listen(onData);
而在 Flutter 中， 最后結合 StreamBuilder , 就可以完成 基于事件流的異步狀態控件 了！
StreamBuilder<List<String>>(
stream: dataStream,
initialData: ["none"],
///這里的 snapshot 是數據快照的意思
builder: (BuildContext context, AsyncSnapshot<List<String>> snapshot) {
///獲取到數據，為所欲為的更新 UI
var data = snapshot.data;
return Container();
});
那么問題來了，它們內部究竟是如果實現的呢？原理是什么？各自的作用是什么？都有哪些特性呢？后面我們將開始深入解析這個邏輯 。
2、Stream 四天王
從上面我們知道，在 Flutter 中使用 Stream 主要有四個對象，那么這四個對象是如何“勾搭”在一起的？他們各自又擔任什么責職呢？
首先如下圖，我們可以從進階版的流程圖上看出 整個 Stream 的內部工作流程。
Flutter中 Stream 、StreamController 、StreamSink 和 StreamSubscription 都是 abstract 對象，他們對外抽象出接口，而內部實現對象大部分都是 _ 開頭的如 _SyncStreamController 、ControllerStream 等私有類，在這基礎上整個流程概括起來就是：
有一個事件源叫 Stream，為了方便控制 Stream ，官方提供了使用 StreamController 作為管理；同時它對外提供了 StreamSink 對象作為事件輸入口，可通過 sink 屬性訪問; 又提供 stream 屬性提供 Stream 對象的監聽和變換，最后得到的 StreamSubscription 可以管理事件的訂閱。
所以我們可以總結出：
- StreamController ：如類名描述，用于整個
Stream過程的控制，提供各類接口用于創建各種事件流。 - StreamSink：一般作為事件的入口，提供如
add，addStream等。 - Stream：事件源本身，一般可用于監聽事件或者對事件進行轉換，如
listen、where。 - StreamSubscription：事件訂閱后的對象，表面上用于管理訂閱過等各類操作，如
cacenl、pause，同時在內部也是事件的中轉關鍵。
回到 Stream 的工作流程上，在上圖中我們知道， 通過 StreamSink.add 添加一個事件時， 事件最后會回調到 listen 中的 onData 方法，這個過程是通過 zone.runUnaryGuarded 執行的，這里 zone.runUnaryGuarded 是什么作用后面再說，我們需要知道這個 onData 是怎么來的？
如上圖，通過源碼我們知道：
1、
Stream在listen的時候傳入了onData回調，這個回調會傳入到StreamSubscription中，之后通過zone.registerUnaryCallback注冊得到_onData對象( 不是前面的onData回調哦 )。2、
StreamSink在添加事件是，會執行到StreamSubscription中的_sendData方法，然后通過_zone.runUnaryGuarded(_onData, data);執行 1 中得到的_onData對象，觸發listen時傳入的回調方法。
可以看出整個流程都是和 StreamSubscription 相關的，現在我們已經知道從 事件入口到事件出口 的整個流程時怎么運作的，那么這個過程是**怎么異步執行的呢？其中頻繁出現的 zone 是什么？
3、線程
首先我們需要知道，Stream 是怎么實現異步的？
這就需要說到 Dart 中的異步實現邏輯了，因為 Dart 是 單線程應用 ，和大多數單線程應用一樣，Dart 是以 消息循環機制 來運行的，而這里面主要包含兩個任務隊列，一個是 microtask 內部隊列，一個是 event 外部隊列，而 microtask 的優先級又高于 event 。
默認的在 Dart 中，如 點擊、滑動、IO、繪制事件 等事件都屬于 event 外部隊列，microtask 內部隊列主要是由 Dart 內部產生，而 Stream 中的執行異步的模式就是 scheduleMicrotask 了。
因為 microtask 的優先級又高于 event ，所以如果 microtask 太多就可能會對觸摸、繪制等外部事件造成阻塞卡頓哦。
如下圖，就是 Stream 內部在執行異步操作過程執行流程：
4、Zone
那么 Zone 又是什么？它是哪里來的？
在上一篇章中說過，因為 Dart 中 Future 之類的異步操作是無法被當前代碼 try/cacth 的，而在 Dart 中你可以給執行對象指定一個 Zone，類似提供一個沙箱環境 ，而在這個沙箱內，你就可以全部可以捕獲、攔截或修改一些代碼行為，比如所有未被處理的異常。
那么項目中默認的 Zone 是怎么來的？在 Flutter 中，Dart 中的 Zone 啟動是在 _runMainZoned 方法 ，如下代碼所示 _runMainZoned 的 @pragma("vm:entry-point") 注解表示該方式是給 Engine 調用的，到這里我們知道了 Zone 是怎么來的了。
///Dart 中
@pragma('vm:entry-point')
// ignore: unused_element
void _runMainZoned(Function startMainIsolateFunction, Function userMainFunction) {
startMainIsolateFunction((){
runZoned<Future<void>>(····);
}, null);
}
///C++ 中
if (tonic::LogIfError(tonic::DartInvokeField(
Dart_LookupLibrary(tonic::ToDart("dart:ui")), "_runMainZoned",
{start_main_isolate_function, user_entrypoint_function}))) {
FML_LOG(ERROR) << "Could not invoke the main entrypoint.";
return false;
}
那么 zone.runUnaryGuarded 的作用是什么？相較于 scheduleMicrotask 的異步操作，官方的解釋是：在此區域中使用參數執行給定操作并捕獲同步錯誤。 類似的還有 runUnary 、 runBinaryGuarded 等，所以我們知道前面提到的 zone.runUnaryGuarded 就是 Flutter 在運行的這個 zone 里執行已經注冊的 _onData，并捕獲異常。
5、異步和同步
前面我們說了 Stream 的內部執行流程，那么同步和異步操作時又有什么區別？具體實現時怎么樣的呢？
我們以默認 Stream 流程為例子， StreamController 的工廠創建可以通過 sync 指定同步還是異步，默認是異步模式的。 而無論異步還是同步，他們都是繼承了 _StreamController 對象，區別還是在于 mixins 的是哪個 _EventDispatch 實現：
_AsyncStreamControllerDispatch_SyncStreamControllerDispatch
上面這兩個 _EventDispatch 最大的不同就是在調用 sendData 提交事件時，是直接調用 StreamSubscription 的 _add 方法，還是調用 _addPending(new _DelayedData<T>(data)); 方法的區別。
如下圖， 異步執行的邏輯就是上面說過的 scheduleMicrotask， 在 _StreamImplEvents 中 scheduleMicrotask 執行后，會調用 _DelayedData 的 perform ，最后通過 _sendData 觸發 StreamSubscription 去回調數據 。
6、廣播和非廣播。
在 Stream 中又非為廣播和非廣播模式，如果是廣播模式中，StreamControlle 的實現是由如下所示實現的，他們的基礎關系如下圖所示：
_SyncBroadcastStreamController_AsyncBroadcastStreamController
廣播和非廣播的區別在于調用 _createSubscription 時，內部對接口類 _StreamControllerLifecycle 的實現，同時它們的差異在于：
在
_StreamController里判斷了如果Stream是_isInitialState的，也就是訂閱過的，就直接報錯 "Stream has already been listened to." ，只有未訂閱的才創建StreamSubscription。在
_BroadcastStreamController中，_isInitialState的判斷被去掉了，取而代之的是isClosed判斷，并且在廣播中,_sendData是一個forEach執行：
_forEachListener((_BufferingStreamSubscription<T> subscription) {
subscription._add(data);
});
7、Stream 變換
Stream 是支持變換處理的，針對 Stream 我們可以經過多次變化來得到我們需要的結果。那么這些變化是怎么實現的呢？
如下圖所示，一般操作符變換的 Stream 實現類，都是繼承了 _ForwardingStream , 在它的內部的_ForwardingStreamSubscription 里，會通過上一個 Pre A Stream 的 listen 添加 _handleData 回調，之后在回調里再次調用新的 Current B Stream 的 _handleData 。
所以事件變化的本質就是，變換都是對 Stream 的 listen 嵌套調用組成的。
同時 Stream 還有轉換為 Future , 如 firstWhere 、 elementAt 、 reduce 等操作符方法，基本都是創建一個內部 _Future 實例，然后再 listen 的回調用調用 Future 方法返回。
二、StreamBuilder
如下代碼所示, 在 Flutter 中通過 StreamBuilder 構建 Widget ，只需提供一個 Stream 實例即可，其中 AsyncSnapshot 對象為數據快照，通過 data 緩存了當前數據和狀態，那 StreamBuilder 是如何與 Stream 關聯起來的呢？
StreamBuilder<List<String>>(
stream: dataStream,
initialData: ["none"],
///這里的 snapshot 是數據快照的意思
builder: (BuildContext context, AsyncSnapshot<List<String>> snapshot) {
///獲取到數據，為所欲為的更新 UI
var data = snapshot.data;
return Container();
});
如上圖所示， StreamBuilder 的調用邏輯主要在 _StreamBuilderBaseState 中，_StreamBuilderBaseState 在 initState 、didUpdateWidget 中會調用 _subscribe 方法，從而調用 Stream 的 listen，然后通過 setState 更新UI，就是這么簡單有木有？
我們常用的
setState中其實是調用了markNeedsBuild，markNeedsBuild內部標記element為diry，然后在下一幀WidgetsBinding.drawFrame才會被繪制，這可以看出setState并不是立即生效的哦。
三、rxdart
其實無論從訂閱或者變換都可以看出， Dart 中的 Stream 已經自帶了類似 rx 的效果，但是為了讓 rx 的用戶們更方便的使用，ReactiveX 就封裝了 rxdart 來滿足用戶的熟悉感，如下圖所示為它們的對應關系：
在 rxdart 中， Observable 是一個 Stream，而 Subject 繼承了 Observable 也是一個 Stream，并且 Subject 實現了 StreamController 的接口，所以它也具有 Controller 的作用。
如下代碼所示是 rxdart 的簡單使用，可以看出它屏蔽了外界需要對 StreamSubscription 和 StreamSink 等的認知，更符合 rx 歷史用戶的理解。
final subject = PublishSubject<String>();
subject.stream.listen(observerA);
subject.add("AAAA1");
subject.add("AAAA2"));
subject.stream.listen(observeB);
subject.add("BBBB1");
subject.close();
這里我們簡單分析下，以上方代碼為例，
PublishSubject內部實際創建是創建了一個廣播StreamController<T>.broadcast。當我們調用
add或者addStream時，最終會調用到的還是我們創建的StreamController.add。當我們調用
onListen時，也是將回調設置到StreamController中。rxdart在做變換時，我們獲取到的Observable就是 this，也就是PublishSubject自身這個Stream，而Observable一系列的變換，也是基于創建時傳入的stream對象，比如：
@override
Observable<S> asyncMap<S>(FutureOr<S> convert(T value)) =>
Observable<S>(_stream.asyncMap(convert));
所以我們可以看出來，rxdart 只是對 Stream 進行了概念變換，變成了我們熟悉的對象和操作符，而這也是為什么 rxdart 可以在 StreamBuilder 中直接使用的原因。
所以，到這里你對 Flutter 中 Stream 有全面的理解了沒？
自此，第十一篇終于結束了！(///▽///)
資源推薦
- Github ： https://github.com/CarGuo/
- 開源 Flutter 完整項目：https://github.com/CarGuo/GSYGithubAppFlutter
- 開源 Flutter 多案例學習型習項目: https://github.com/CarGuo/GSYFlutterDemo
- 開源 Fluttre 實戰電子書項目：https://github.com/CarGuo/GSYFlutterBook
