前言
在 Flutter 中有兩種處理非同步操作的方式 Future 和 Stream，Future 用於處理單個非同步操作，Stream 用來處理連續的非同步操作。比如往水杯倒水，將一個水杯倒滿為一個 Future，連續的將多個水杯倒滿就是 Stream。
Stream 詳解
Stream 是一個抽象類，用於表示一序列非同步資料的源。它是一種產生連續事件的方式，可以生成資料事件或者錯誤事件，以及流結束時的完成事件。
abstract class Stream<T> {
Stream();
}
複製程式碼Stream 分單訂閱流和廣播流。
單訂閱流在傳送完成事件之前只允許設定一個監聽器，並且只有在流上設定監聽器後才開始產生事件，取消監聽器後將停止傳送事件。即使取消了第一個監聽器，也不允許在單訂閱流上設定其他的監聽器。廣播流則允許設定多個監聽器，也可以在取消上一個監聽器後再次新增新的監聽器。
Stream 有同步流和非同步流之分。
它們的區別在於同步流會在執行 add，addError 或 close 方法時立即向流的監聽器 StreamSubscription 傳送事件，而非同步流總是在事件佇列中的程式碼執行完成後在傳送事件。
Stream 家族
StreamController
帶有控制流方法的流。 可以向它的流傳送資料，錯誤和完成事件，也可以檢查資料流是否已暫停，是否有監聽器。sync 引數決定這個流是同步流還是非同步流。
abstract class StreamController<T> implements StreamSink<T> {
Stream<T> get stream;
/// ...
}
StreamController _streamController = StreamController(
onCancel: () {},
onListen: () {},
onPause: () {},
onResume: () {},
sync: false,
);
複製程式碼StreamSink
流事件的入口。提供 add，addError，addStream 方法向流傳送事件。
abstract class StreamSink<S> implements EventSink<S>, StreamConsumer<S> {
Future close();
/// ...
Future get done;
}
複製程式碼StreamSubscription
流的監聽器。提供 cacenl、pause, resume 等方法管理。
abstract class StreamSubscription<T> {
/// ...
}
StreamSubscription subscription = StreamController().stream.listen(print);
subscription.onDone(() => print('done'));
複製程式碼StreamBuilder
使用流資料渲染 UI 介面的部件。
StreamBuilder(
// 資料流
stream: stream,
// 初始資料
initialData: 'loading...',
builder: (context, AsyncSnapshot snapshot) {
// AsyncSnapshot 物件為資料快照，快取了當前資料和狀態
// snapshot.connectionState
// snapshot.data
if (snapshot.hasData) {
Map data = snapshot.data;
return Text(data),
}
return CircularProgressIndicator();
},
)
複製程式碼建立 Stream
在 Dart 有幾種方式建立 Stream
從現有的生成一個新的流 Stream，使用map，where，takeWhile等方法。
// 整數流
Stream<int> intStream = StreamController<int>().stream;
// 偶數流
Stream<int> evenStream = intStream.where((int n) => n.isEven);
// 兩倍流
Stream<int> doubleStream = intStream.map((int n) => n * 2);
// 數字大於 10 的流
Stream<int> biggerStream = intStream.takeWhile((int n) => n > 10);
複製程式碼使用 async*函式。
Stream<int> countStream(int to) async* {
for (int i = 1; i <= to; i++) {
yield i;
}
}
Stream stream = countStream(10);
stream.listen(print);
複製程式碼使用 StreamController。
StreamController<Map> _streamController = StreamController(
onCancel: () {},
onListen: () {},
onPause: () {},
onResume: () {},
sync: false,
);
Stream _stream = _streamController.stream;
複製程式碼使用 Future物件生成
Future<int> _delay(int seconds) async {
await Future.delayed(Duration(seconds: seconds));
return seconds;
}
List<Future> futures = [];
for (int i = 0; i < 10; i++) {
futures.add(_delay(3));
}
Stream _futuresStream = Stream.fromFutures(futures);
複製程式碼應用 Stream
Stream Counter
把 Flutter 的預設專案改用 Stream 實現
import 'dart:async';
import 'package:flutter/material.dart';
class StreamCounter extends StatefulWidget {
@override
_StreamCounterState createState() => _StreamCounterState();
}
class _StreamCounterState extends State<StreamCounter> {
// 建立一個 StreamController
StreamController<int> _counterStreamController = StreamController<int>(
onCancel: () {
print('cancel');
},
onListen: () {
print('listen');
},
);
int _counter = 0;
Stream _counterStream;
StreamSink _counterSink;
// 使用 StreamSink 向 Stream 傳送事件，當 _counter 大於 9 時呼叫 close 方法關閉流。
void _incrementCounter() {
if (_counter > 9) {
_counterSink.close();
return;
}
_counter++;
_counterSink.add(_counter);
}
// 主動關閉流
void _closeStream() {
_counterStreamController.close();
}
@override
void initState() {
super.initState();
_counterSink = _counterStreamController.sink;
_counterStream = _counterStreamController.stream;
}
@override
void dispose() {
super.dispose();
_counterSink.close();
_counterStreamController.close();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Stream Counter'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Text('You have pushed the button this many times:'),
// 使用 StreamBuilder 顯示和更新 UI
StreamBuilder<int>(
stream: _counterStream,
initialData: _counter,
builder: (context, snapshot) {
if (snapshot.connectionState == ConnectionState.done) {
return Text(
'Done',
style: Theme.of(context).textTheme.bodyText2,
);
}
int number = snapshot.data;
return Text(
'$number',
style: Theme.of(context).textTheme.bodyText2,
);
},
),
],
),
),
floatingActionButton: Row(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
child: Icon(Icons.add),
),
SizedBox(width: 24.0),
FloatingActionButton(
onPressed: _closeStream,
tooltip: 'Close',
child: Icon(Icons.close),
),
],
),
);
}
}
複製程式碼NetWork Status
監聽手機的網路連結狀態，首先新增 connectivity 外掛
dependencies:
connectivity: ^0.4.8+2
複製程式碼
import 'dart:async';
import 'package:connectivity/connectivity.dart';
import 'package:flutter/material.dart';
class NetWorkStatus extends StatefulWidget {
@override
_NetWorkStatusState createState() => _NetWorkStatusState();
}
class _NetWorkStatusState extends State<NetWorkStatus> {
StreamController<ConnectivityResult> _streamController = StreamController();
StreamSink _streamSink;
Stream _stream;
String _result;
void _checkStatus() async {
final ConnectivityResult result = await Connectivity().checkConnectivity();
if (result == ConnectivityResult.mobile) {
_result = 'mobile';
} else if (result == ConnectivityResult.wifi) {
_result = 'wifi';
} else if (result == ConnectivityResult.none) {
_result = 'none';
}
setState(() {});
}
@override
void initState() {
super.initState();
_stream = _streamController.stream;
_streamSink = _streamController.sink;
_checkStatus();
Connectivity().onConnectivityChanged.listen(
(ConnectivityResult result) {
_streamSink.add(result);
},
);
}
@override
dispose() {
super.dispose();
_streamSink.close();
_streamController.close();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Network Status'),
),
body: Center(
child: StreamBuilder<ConnectivityResult>(
stream: _stream,
builder: (context, AsyncSnapshot snapshot) {
if (snapshot.hasData) {
if (snapshot.data == ConnectivityResult.mobile) {
_result = 'mobile';
} else if (snapshot.data == ConnectivityResult.wifi) {
_result = 'wifi';
} else if (snapshot.data == ConnectivityResult.none) {
return Text('還沒有連結網路');
}
}
if (_result == null) {
return CircularProgressIndicator();
}
return ResultText(_result);
},
),
),
);
}
}
class ResultText extends StatelessWidget {
final String result;
const ResultText(this.result);
@override
Widget build(BuildContext context) {
return RichText(
text: TextSpan(
style: TextStyle(color: Colors.black),
text: '正在使用',
children: [
TextSpan(
text: ' $result ',
style: TextStyle(
color: Colors.red,
fontSize: 20.0,
fontWeight: FontWeight.bold,
),
),
TextSpan(text: '連結網路'),
],
),
);
}
}
複製程式碼Random Article
請求網路資料建立流
dependencies:
dio: ^3.0.9
flutter_html: ^0.11.1
複製程式碼
import 'dart:async';
import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'package:flutter_html/flutter_html.dart';
class RandomArticle extends StatefulWidget {
@override
_RandomArticleState createState() => _RandomArticleState();
}
class _RandomArticleState extends State<RandomArticle> {
static Dio _dio = Dio(
BaseOptions(baseUrl: 'https://interface.meiriyiwen.com'),
);
static Future<Map> _getArticle() async {
Response response = await _dio.get(
'/article/random',
queryParameters: {"dev": 1},
);
final data = response.data['data'];
return data;
}
Stream<Map> _futuresStream;
@override
void initState() {
List<Future<Map>> futures = [];
for (int i = 0; i < 10; i++) {
// 新增 Future
futures.add(_getArticle());
}
// 生成 Stream
_futuresStream = Stream<Map>.fromFutures(futures);
super.initState();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: Text('Random Article')),
body: SingleChildScrollView(
child: Center(
child: StreamBuilder<Map>(
stream: _futuresStream,
builder: (context, AsyncSnapshot snapshot) {
if (snapshot.hasData) {
Map article = snapshot.data;
return Container(
child: Column(
children: <Widget>[
SizedBox(height: 24.0),
Text(
article['title'],
style: TextStyle(fontSize: 24.0),
),
Padding(
padding: const EdgeInsets.only(
top: 12.0,
left: 12.0,
right: 12.0,
bottom: 60.0,
),
child: Html(
data: article['content'],
),
),
],
),
);
}
return CircularProgressIndicator();
},
),
),
),
);
}
}
複製程式碼Broadcast Stream
使用廣播流
import 'dart:async';
import 'package:flutter/material.dart';
class BroadcastStream extends StatefulWidget {
@override
_BroadcastStreamState createState() => _BroadcastStreamState();
}
class _BroadcastStreamState extends State<BroadcastStream> {
StreamController<int> _streamController = StreamController<int>.broadcast();
StreamSubscription _subscription1;
StreamSubscription _subscription2;
StreamSubscription _subscription3;
int _count = 0;
int _s1 = 0;
int _s2 = 0;
int _s3 = 0;
@override
void initState() {
_subscription1 = _streamController.stream.listen((n) {
setState(() {
_s1 += 1;
});
});
_subscription2 = _streamController.stream.listen((n) {
setState(() {
_s2 += 2;
});
});
_subscription3 = _streamController.stream.listen((n) {
setState(() {
_s3 -= 1;
});
});
super.initState();
}
void _add() {
if (_count > 10) {
// 大於 10 時停止第一個訂閱
_subscription1.cancel();
}
_count++;
_streamController.add(_count);
}
@override
void dispose() {
super.dispose();
_streamController.close();
_subscription1.cancel();
_subscription2.cancel();
_subscription3.cancel();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Broadcast Stream'),
),
body: Container(
width: double.infinity,
height: MediaQuery.of(context).size.height,
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
crossAxisAlignment: CrossAxisAlignment.center,
children: [
Text('Count: $_count'),
SizedBox(height: 12.0),
Text('S1: $_s1'),
SizedBox(height: 12.0),
Text('S2: $_s2'),
SizedBox(height: 12.0),
Text('S3: $_s3'),
SizedBox(height: 12.0),
FloatingActionButton(
onPressed: _add,
child: Icon(Icons.plus_one),
),
],
),
),
);
}
}
複製程式碼總結
Stream 是處理非同步程式設計的方式之一，它提供一個了非同步的事件序列，並在你準備好接受時傳送。在 Dart 中流分為同步流和非同步流，以及單訂閱流和廣播流，有多種方式建立 Stream。
參考
Building a Widget with StreamBuilder
本文使用 mdnice 排版
PS:【廣州】作者求職中歡迎聯絡。