与 WebSockets 通信

除了常规的 HTTP 请求外，你还可以使用 WebSockets 连接到服务器。WebSockets 允许与服务器进行双向通信，而无需轮询。

在此示例中，连接到由 Lob.com 赞助的测试 WebSocket 服务器。服务器会将你发送给它的相同消息发回。此示例包含以下步骤：

连接到 WebSocket 服务器。
监听来自服务器的消息。
向服务器发送数据。
关闭 WebSocket 连接。

web_socket_channel 包提供了连接到 WebSocket 服务器所需的工具。

该包提供了一个 WebSocketChannel，允许你既监听来自服务器的消息，又向服务器推送消息。

在 Flutter 中，使用以下代码行创建一个连接到服务器的 WebSocketChannel

dartfinal channel = WebSocketChannel.connect(
  Uri.parse('wss://echo.websocket.events'),
);

建立连接后，监听来自服务器的消息。

向测试服务器发送消息后，它会将相同的消息发回。

在此示例中，使用 StreamBuilder widget 监听新消息，并使用 Text widget 显示它们。

dartStreamBuilder(
  stream: channel.stream,
  builder: (context, snapshot) {
    return Text(snapshot.hasData ? '${snapshot.data}' : '');
  },
),

WebSocketChannel 提供了来自服务器的消息 Stream。

Stream 类是 dart:async 包的基础组成部分。它提供了一种监听来自数据源的异步事件的方式。与返回单个异步响应的 Future 不同，Stream 类可以随时间传递许多事件。

StreamBuilder widget 连接到 Stream，并要求 Flutter 在每次使用给定的 builder() 函数接收到事件时重新构建。

要向服务器发送数据，请将消息 add() 到 WebSocketChannel 提供的 sink 中。

dart

channel.sink.add('Hello!');

WebSocketChannel 提供了 StreamSink 以向服务器推送消息。

StreamSink 类提供了一种将同步或异步事件添加到数据源的通用方法。

使用完 WebSocket 后，关闭连接

dart

channel.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();
  }
}