Socket.IO Dart 客户端使用教程-优快云博客

Socket.IO Dart 客户端使用教程

socket.io-client-dart socket.io-client-dart: Dartlang port of socket.io-client https://github.com/socketio/socket.io-client 项目地址: https://gitcode.com/gh_mirrors/so/socket.io-client-dart

1. 项目介绍

socket.io-client-dart 是 Dart 语言对 JavaScript 的 socket.io-client 库的移植版本。它允许开发者在 Web、Flutter 和 Dart VM 环境中使用 Socket.IO 客户端功能。Socket.IO 是一个实时通信库，支持双向、低延迟的事件驱动通信，广泛应用于实时聊天、游戏、实时数据更新等场景。

2. 项目快速启动

2.1 安装依赖

首先，在你的 Dart 项目中添加 socket.io-client-dart 依赖：

dependencies:
  socket_io_client: ^2.0.3+1

然后运行 pub get 命令来安装依赖。

2.2 创建 Socket.IO 客户端

以下是一个简单的 Dart 客户端示例，连接到本地的 Socket.IO 服务器：

import 'package:socket_io_client/socket_io_client.dart' as IO;

void main() {
  // 创建 Socket.IO 客户端
  IO.Socket socket = IO.io('http://localhost:3000');

  // 连接事件
  socket.onConnect((_) {
    print('连接成功');
    socket.emit('msg', '测试消息');
  });

  // 接收事件
  socket.on('event', (data) => print(data));

  // 断开连接事件
  socket.onDisconnect((_) => print('断开连接'));

  // 自定义事件
  socket.on('fromServer', (_) => print(_));
}

2.3 手动连接

如果你需要手动控制连接，可以设置 autoConnect: false，并在需要时调用 connect() 方法：

IO.Socket socket = IO.io('http://localhost:3000', OptionBuilder()
    .setTransports(['websocket']) // 设置传输方式
    .disableAutoConnect() // 禁用自动连接
    .setExtraHeaders({'foo': 'bar'}) // 设置额外头信息
    .build());

socket.connect(); // 手动连接