内容
description bug_report

与 WebSockets 通信

内容

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

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

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

1. 连接到 WebSocket 服务器

#

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

该包提供了一个 WebSocketChannel，它允许您同时监听来自服务器的消息和将消息推送到服务器。

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

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

2. 监听来自服务器的消息

#

现在您已经建立了连接，请监听来自服务器的消息。

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

在本例中，使用 StreamBuilder 小部件监听新消息，并使用 Text 小部件显示它们。

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

工作原理

#

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

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

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

3. 向服务器发送数据

#

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

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

工作原理

#

WebSocketChannel 提供了一个 StreamSink 来将消息推送到服务器。

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

4. 关闭 WebSocket 连接

#

完成使用 WebSocket 后，请关闭连接

dart
channel.sink.close();

完整示例

#
dart
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 _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();
  }
}

Web sockets demo