WebSocket の操作

コンテンツ

通常の 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新しいメッセージをリッスンするためのウィジェット、および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. サーバーにデータを送信する

サーバーにデータを送信するには、add()へのメッセージsink提供されたによってWebSocketChannel。

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

Web sockets demo