Flutter WebSocket 心跳与重连机制初探(第一部分)
Http协议是无状态的,只能由客户端主动发起,服务端再被动响应,服务端无法向客户端主动推送内容,并且一旦服务器响应结束,链接就会断开(见注解部分),所以无法进行实时通信。WebSocket协议正是为解决客户端与服务端实时通信而产生的技术,现在已经被主流浏览器支持,所以对于Web开发者来说应该比较熟悉了,Flutter也提供了专门的包来支持WebSocket协议。
注意:Http协议中虽然可以通过keep-alive机制使服务器在响应结束后链接会保持一段时间,但最终还是会断开,keep-alive机制主要是用于避免在同一台服务器请求多个资源时频繁创建链接,它本质上是支持链接复用的技术,而并非用于实时通信,读者需要知道这两者的区别。
WebSocket协议本质上是一个基于tcp的协议,它是先通过HTTP协议发起一条特殊的http请求进行握手后,如果服务端支持WebSocket协议,则会进行协议升级。WebSocket会使用http协议握手后创建的tcp链接,和http协议不同的是,WebSocket的tcp链接是个长链接(不会断开),所以服务端与客户端就可以通过此TCP连接进行实时通信。有关WebSocket协议细节,读者可以看RFC文档,下面我们重点看看Flutter中如何使用WebSocket。
这个教程里包含以下步骤:
- 连接 WebSocket 服务器
- 监听来自服务器的消息
- 向服务器发送数据
- 关闭 WebSocket 连接
1. 连接 WebSocket 服务器
web_socket_channel 这个 package 提供了连接 WebSocket 服务器所需的一些工具。
该包提供的 WebSocketChannel
不仅可以让你监听到来自服务器的消息还可以让你向服务器推送消息。
在 Flutter 中,只用一行代码就可以创建一个连接到服务器的 WebSocketChannel
。
content_copy
final channel = WebSocketChannel.connect(
Uri.parse('wss://echo.websocket.events'),
);
2. 监听来自服务器的消息
建立了连接之后,你就可以监听来自服务器的消息了。
当你向测试服务器发送一条消息之后,它会将同样的消息发送回来。
在这个例子中,我们用 StreamBuilder 组件来监听新消息,并使用 Text 组件来展示它们。
content_copy
StreamBuilder(
stream: channel.stream,
builder: (context, snapshot) {
return Text(snapshot.hasData ? '${snapshot.data}' : '');
},
)
这样为什么可行?
WebSocketChannel
提供了一个来自服务器的 Stream 类消息。
这个 Stream
类是 dart:async
包的基本组成部分,它提供了一个从数据源监听异步事件的方法。和 Future
不一样的是,Future
只能返回一个单独的异步响应,而 Stream
类可以随着时间的推移传递很多事件。
StreamBuilder widget 会和 Stream
建立起连接,并且每当它接收到一个使用给定 builder()
函数的事件时,就会通知 Flutter 去 rebuild。
3. 向服务器发送数据
要向服务器发送数据,可以使用 WebSocketChannel
提供的 sink
下的 add()
方法来发送信息。
channel.sink.add('Hello!');
这又是如何工作的呢
WebSocketChannel
提供了一个 StreamSink 来向服务器推送消息。
这个 StreamSink
类提供了一个可以向数据源添加同步或者异步事件的通用方法。
4. 关闭 WebSocket 连接
当你使用完 WebSocket 之后,记得关闭这个连接。要关闭这个 WebSocket 连接,只需要关闭 sink
。
channel.sink.close();
下面我们实现一个简单案例
添加依赖:
# web_socket_channel 2.3.0 # WebSocket
class MyHomePage extends StatefulWidget {
const MyHomePage({Key? key, required this.title}) : super(key: key);
final String title;
@override
State<MyHomePage> createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
final TextEditingController _controller = TextEditingController();
final _channel = WebSocketChannel.connect(
Uri.parse('wss://echo.websocket.events'),
);
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
),
body: Padding(
padding: const EdgeInsets.all(20.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Form(
child: TextFormField(
controller: _controller,
decoration: const InputDecoration(labelText: 'Send message'),
),
),
const SizedBox(height: 24),
const Text("listen:"),
StreamBuilder(
stream: _channel.stream,
builder: (context, snapshot) {
return Text(snapshot.hasData ? '${snapshot.data}' : '');
},
)
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _sendMessage,
tooltip: 'Send message',
child: const Icon(Icons.send),
), // This trailing comma makes auto-formatting nicer for build methods.
);
}
void _sendMessage() {
if (_controller.text.isNotEmpty) {
_channel.sink.add(_controller.text);
}
}
@override
void dispose() {
_channel.sink.close();
_controller.dispose();
super.dispose();
}
}
下一篇文章我们将WebSocket封装为工具类,实现心跳以及重连机制