dart
final channel = WebSocketChannel.connect(
Uri.parse('wss://echo.websocket.events'),
2. 监听来自服务器的消息
建立了连接之后,你就可以监听来自服务器的消息了。
当你向测试服务器发送一条消息之后,它会将同样的消息发送回来。
在这个例子中,我们用 StreamBuilder
组件来监听新消息,并使用 Text
组件来展示它们。
dartStreamBuilder(
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()
方法来发送信息。
dartchannel.sink.add('Hello!');
这又是如何工作的呢
WebSocketChannel
提供了一个 StreamSink
来向服务器推送消息。
这个 StreamSink
类提供了一个可以向数据源添加同步或者异步事件的通用方法。
4. 关闭 WebSocket 连接
当你使用完 WebSocket 之后,记得关闭这个连接。要关闭这个 WebSocket 连接,只需要关闭 sink
。
dartchannel.sink.close();
dartimport 'package:flutter/material.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
void main() => runApp(const MyApp());
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
const title = 'WebSocket Demo';
return const MaterialApp(
title: title,
home: MyHomePage(
title: title,
class MyHomePage extends StatefulWidget {
const MyHomePage({
super.key,
required this.title,
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),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Form(
child: TextFormField(
controller: _controller,
decoration: const InputDecoration(labelText: 'Send a message'),
const SizedBox(height: 24),
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();
除非另有说明,本文档之所提及适用于 Flutter 的最新稳定版本,本页面最后更新时间: 2024-08-08。
查看文档源码
为本页面内容提出建议。