Flutter WebSocket通信插件cc_web_socket的使用

CC WebSocket 提供了一个强大的且灵活的 WebSocket 客户端，适用于 Flutter 应用程序。此插件允许您轻松管理和自定义 WebSocket 连接。

特性

• 简单初始化：通过简单的配置选项快速建立 WebSocket 连接。
• 超时和心跳设置：可以自定义连接超时时间和心跳间隔。
• 自动重连：当连接丢失时自动重新连接。
• 详细日志记录：可以选择记录连接状态、请求和响应。
• 模块化结构：通过插件和模块扩展功能。

安装

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  cc_web_socket: ^1.0.0

使用

初始化

要初始化 CCWebSocket，请使用以下代码：

CCWebSocket.init(
  socketOptions: CCSocketOptions(
    uri: Uri(
      scheme: "wss",
      host: "echo.websocket.org",
      port: 443,
      path: ".ws",
    ),
    connectTimeout: const Duration(seconds: 5),
    pingInterval: const Duration(seconds: 120),
    requestTypeName: "request_type",
    autoConnect: true,
  ),
  loggingOptions: CCSocketLogging(
    logEnabled: true,
    onConnection: (prompt) {},
    onReconnection: (prompt) {},
    onClosed: (prompt) {},
    onRequest: (prompt) {},
    onResponse: (prompt) {},
    onError: (prompt) {},
  ),
  modules: [
    Example(),
  ],
);

注意 requestTypeName 参数是在 JSON 内容中匹配返回数据正确模块的标识符。

连接

要发起 WebSocket 连接，请使用以下代码：

CCWebSocket.connect();

模块使用

通过模块发送请求：

CCWebSocket.getModule<Example>().request(
  body: {
    "request_type": "Unknown",
  },
);

示例模块

您可以创建自己的模块，定义一个类如下：

class Example extends RequestModule {
  [@override](/user/override)
  void request({required Map<String, dynamic> body}) {
    super.request(body: body);
  }

  [@override](/user/override)
  void response(dynamic response) {}
}

或者只处理响应：

class Example extends RequestModule {
  [@override](/user/override)
  void response(dynamic response) {}
}

贡献

如果您想贡献，请提交拉取请求或打开一个问题。我们非常重视所有类型的反馈。

许可证

该项目在 MIT 许可证下发布。更多详情请参阅 LICENSE 文件。

完整示例 Demo

以下是一个完整的示例，展示了如何使用 cc_web_socket 插件来实现 WebSocket 通信：

import 'package:flutter/material.dart';
import 'package:cc_web_socket/src/socket/socket_options.dart';
import 'package:cc_web_socket/src/socket/web_socket_client.dart';
import 'package:cc_web_socket/src/request/modules/request_module.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('WebSocket Demo')),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              // 初始化 WebSocket
              CCWebSocket.init(
                socketOptions: CCSocketOptions(
                  uri: Uri(
                    scheme: "wss",
                    host: "echo.websocket.org",
                    port: 443,
                    path: ".ws",
                  ),
                  connectTimeout: const Duration(seconds: 5),
                  pingInterval: const Duration(seconds: 120),
                  requestTypeName: "request_type",
                  autoConnect: true,
                ),
                loggingOptions: CCSocketLogging(
                  logEnabled: true,
                  onConnection: (prompt) {},
                  onReconnection: (prompt) {},
                  onClosed: (prompt) {},
                  onRequest: (prompt) {},
                  onResponse: (prompt) {},
                  onError: (prompt) {},
                ),
                modules: [
                  Example(),
                ],
              );

              // 发起连接
              CCWebSocket.connect();

              // 发送请求
              CCWebSocket.getModule<Example>().request(
                body: {
                  "request_type": "Unknown",
                },
              );
            },
            child: Text('Connect WebSocket'),
          ),
        ),
      ),
    );
  }
}

// 示例模块
class Example extends RequestModule {
  [@override](/user/override)
  void request({required Map<String, dynamic> body}) {
    super.request(body: body);
  }

  [@override](/user/override)
  void response(dynamic response) {
    print("Response received: $response");
  }
}