cim_flutter_websocket_sdk 是一个用于在 Flutter 应用中实现 WebSocket 通信的插件。以下是如何使用该插件的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 cim_flutter_websocket_sdk 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  cim_flutter_websocket_sdk: ^版本号  # 替换为最新版本号

然后运行 flutter pub get 来获取依赖。

2. 导入插件

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

import 'package:cim_flutter_websocket_sdk/cim_flutter_websocket_sdk.dart';

3. 初始化 WebSocket 连接

使用 CIMWebSocket 类来初始化和管理 WebSocket 连接：

CIMWebSocket cimWebSocket = CIMWebSocket();

4. 连接到 WebSocket 服务器

使用 connect 方法连接到 WebSocket 服务器：

cimWebSocket.connect(
  url: 'wss://your.websocket.server.url', // WebSocket 服务器地址
  onOpen: () {
    print('WebSocket connected');
  },
  onMessage: (message) {
    print('Received message: $message');
  },
  onError: (error) {
    print('WebSocket error: $error');
  },
  onClose: () {
    print('WebSocket closed');
  },
);

5. 发送消息

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

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

6. 关闭连接

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

cimWebSocket.close();

7. 处理连接状态

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

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

8. 处理接收到的消息

在 onMessage 回调中处理从服务器接收到的消息：

cimWebSocket.connect(
  url: 'wss://your.websocket.server.url',
  onMessage: (message) {
    print('Received message: $message');
    // 在这里处理消息
  },
  // 其他回调
);

9. 错误处理

在 onError 回调中处理 WebSocket 错误：

cimWebSocket.connect(
  url: 'wss://your.websocket.server.url',
  onError: (error) {
    print('WebSocket error: $error');
    // 在这里处理错误
  },
  // 其他回调
);

10. 关闭回调

在 onClose 回调中处理 WebSocket 关闭事件：

cimWebSocket.connect(
  url: 'wss://your.websocket.server.url',
  onClose: () {
    print('WebSocket closed');
    // 在这里处理关闭事件
  },
  // 其他回调
);

完整示例

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

import 'package:flutter/material.dart';
import 'package:cim_flutter_websocket_sdk/cim_flutter_websocket_sdk.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> {
  CIMWebSocket cimWebSocket = CIMWebSocket();
  TextEditingController _controller = TextEditingController();

  [@override](/user/override)
  void initState() {
    super.initState();
    cimWebSocket.connect(
      url: 'wss://your.websocket.server.url',
      onOpen: () {
        print('WebSocket connected');
      },
      onMessage: (message) {
        print('Received message: $message');
        // 在这里处理消息
      },
      onError: (error) {
        print('WebSocket error: $error');
        // 在这里处理错误
      },
      onClose: () {
        print('WebSocket closed');
        // 在这里处理关闭事件
      },
    );
  }

  void _sendMessage() {
    if (_controller.text.isNotEmpty) {
      cimWebSocket.send(_controller.text);
      _controller.clear();
    }
  }

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('WebSocket Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _controller,
              decoration: InputDecoration(labelText: 'Enter a message'),
            ),
            SizedBox(height: 16.0),
            ElevatedButton(
              onPressed: _sendMessage,
              child: Text('Send'),
            ),
          ],
        ),
      ),
    );
  }
}