與 WebSockets 通訊
除了普通的 HTTP 請求,你還可以使用 WebSockets 連線到伺服器。WebSockets 允許與伺服器進行雙向通訊,而無需輪詢。
在此示例中,連線到由 Lob.com 贊助的測試 WebSocket 伺服器。該伺服器會返回你傳送給它的相同訊息。此示例遵循以下步驟:
- 連線到 WebSocket 伺服器。
- 監聽來自伺服器的訊息。
- 向伺服器傳送資料。
- 關閉 WebSocket 連線。
1. 連線到 WebSocket 伺服器
#web_socket_channel 軟體包提供了連線到 WebSocket 伺服器所需的工具。
該軟體包提供了一個 WebSocketChannel,它允許你同時監聽來自伺服器的訊息並向伺服器傳送訊息。
在 Flutter 中,使用以下程式碼行建立一個連線到伺服器的 WebSocketChannel:
final channel = WebSocketChannel.connect(
Uri.parse('wss://echo.websocket.events'),
);2. 監聽來自伺服器的訊息
#現在你已經建立連線,可以監聽來自伺服器的訊息了。
向測試伺服器傳送訊息後,它會返回相同的訊息。
在此示例中,使用 StreamBuilder widget 監聽新訊息,並使用 Text widget 顯示它們。
StreamBuilder(
stream: channel.stream,
builder: (context, snapshot) {
return Text(snapshot.hasData ? '${snapshot.data}' : '');
},
),工作原理
#WebSocketChannel 提供了一個來自伺服器的訊息Stream。
Stream 類是 dart:async 軟體包的基本組成部分。它提供了一種監聽來自資料來源的非同步事件的方式。與返回單個非同步響應的 Future 不同,Stream 類可以隨時間傳遞許多事件。
StreamBuilder widget 連線到 Stream,並要求 Flutter 在每次收到事件時使用給定的 builder() 函式進行重建。
3. 向伺服器傳送資料
#要向伺服器傳送資料,請將訊息 add() 到 WebSocketChannel 提供的 sink。
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 _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();
}
}