与 WebSockets 通信
如何连接到 web socket。
除了普通的 HTTP 请求外，你还可以使用 WebSockets 连接到服务器。WebSockets 允许与服务器进行双向通信，而无需轮询。
在此示例中，我们将连接到一个 测试 WebSocket 服务器。服务器会将你发送给它的消息原样返回。本指南使用以下步骤：
- 连接到 WebSocket 服务器。
- 监听来自服务器的消息。
- 向服务器发送数据。
- 关闭 WebSocket 连接。
1. 连接到 WebSocket 服务器
#web_socket_channel 软件包提供了连接到 WebSocket 服务器所需的工具。
该软件包提供了一个 WebSocketChannel，允许你监听来自服务器的消息并向服务器推送消息。
在 Flutter 中，使用以下代码行创建一个连接到服务器的 WebSocketChannel：
final WebSocketChannel channel = WebSocketChannel.connect(
Uri.parse('wss://echo.websocket.org'),
);
2. 监听来自服务器的消息
#现在你已经建立了连接，可以监听来自服务器的消息了。
向测试服务器发送消息后，它会将相同的消息返回。
在此示例中，使用 StreamBuilder 小部件来监听新消息，并使用 Text 小部件来显示它们。
StreamBuilder(
stream: channel.stream,
builder: (context, snapshot) {
return Text(snapshot.hasData ? '${snapshot.data}' : '');
},
),
工作原理
#WebSocketChannel 提供了一个来自服务器的消息 Stream。
Stream 类是 dart:async 软件包的基础部分。它提供了一种监听来自数据源的异步事件的方法。与返回单个异步响应的 Future 不同，Stream 类可以随时间推移传递多个事件。
StreamBuilder 小部件连接到一个 Stream，并要求 Flutter 在每次通过给定的 builder() 函数接收到事件时重建界面。
3. 向服务器发送数据
#要向服务器发送数据，请使用 WebSocketChannel 提供的 sink 来 add() 消息。
channel.sink.add('Hello!');
工作原理
#WebSocketChannel 提供了一个 StreamSink 来向服务器推送消息。
StreamSink 类提供了一种向数据源添加同步或异步事件的通用方法。
4. 关闭 WebSocket 连接
#使用完 WebSocket 后，请关闭连接：
channel.sink.close();
完整示例
#import '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 WebSocketChannel _channel = WebSocketChannel.connect(
Uri.parse('wss://echo.websocket.org'),
);
@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();
}
}
