Flutter WebSocket通信插件websocket_template的使用

websocket_template 是一个用于在 Flutter 应用中实现 WebSocket 通信的插件。它提供了一个简单易用的接口，帮助开发者快速集成 WebSocket 功能。以下是使用 websocket_template 插件进行 WebSocket 通信的基本步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 websocket_template 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  websocket_template: ^1.0.0  # 请确保使用最新版本

然后，运行 flutter pub get 来安装依赖。

2. 导入插件

在你的 Dart 文件中导入 websocket_template 插件：

import 'package:websocket_template/websocket_template.dart';

3. 创建 WebSocket 连接

使用 WebSocketTemplate 类来创建和管理 WebSocket 连接：

final ws = WebSocketTemplate(
  url: 'ws://your.websocket.url', // WebSocket 服务器的 URL
  onMessage: (message) {
    print('Received message: $message');
  },
  onError: (error) {
    print('WebSocket error: $error');
  },
  onDone: () {
    print('WebSocket connection closed');
  },
);

4. 连接 WebSocket

调用 connect 方法来建立 WebSocket 连接：

ws.connect();

5. 发送消息

使用 send 方法向 WebSocket 服务器发送消息：

ws.send('Hello, WebSocket!');

6. 关闭连接

当你不再需要 WebSocket 连接时，可以调用 close 方法来关闭连接：

ws.close();

7. 处理连接状态

你可以通过 WebSocketTemplate 的 isConnected 属性来检查当前的连接状态：

if (ws.isConnected) {
  print('WebSocket is connected');
} else {
  print('WebSocket is not connected');
}

8. 完整示例

以下是一个完整的示例，展示了如何使用 websocket_template 插件进行 WebSocket 通信：

import 'package:flutter/material.dart';
import 'package:websocket_template/websocket_template.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: WebSocketExample(),
    );
  }
}

class WebSocketExample extends StatefulWidget {
  [@override](/user/override)
  _WebSocketExampleState createState() => _WebSocketExampleState();
}

class _WebSocketExampleState extends State<WebSocketExample> {
  late WebSocketTemplate ws;

  [@override](/user/override)
  void initState() {
    super.initState();
    ws = WebSocketTemplate(
      url: 'ws://your.websocket.url',
      onMessage: (message) {
        print('Received message: $message');
      },
      onError: (error) {
        print('WebSocket error: $error');
      },
      onDone: () {
        print('WebSocket connection closed');
      },
    );
    ws.connect();
  }

  [@override](/user/override)
  void dispose() {
    ws.close();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('WebSocket Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            ws.send('Hello, WebSocket!');
          },
          child: Text('Send Message'),
        ),
      ),
    );
  }
}