Flutter实时通信插件piesocket_channels的使用

Dart WebSocket客户端

PieSocket Channels SDK 是用 Dart 编写的 Flutter 实时通信插件。
此 SDK 可用于与任何第三方 WebSocket 服务器通信，并实现自动重连等最佳实践。

安装

在项目中添加 PieSocket Channels 插件。

flutter pub add piesocket_channels

使用方法

导入库

首先导入 piesocket_channels 库：

import 'package:piesocket_channels/channels.dart';

独立使用

创建一个 Channel 实例并监听 WebSocket 消息。

// 创建一个独立的 WebSocket 连接
Channel channel = Channel.connect("wss://example.com", true);

// 监听系统消息事件
channel.listen("system:message", (PieSocketEvent event) {
    print("WebSocket 消息到达！");
    print(event.toString());
});

使用 PieSocket 的托管 WebSocket 服务器

若要使用 PieSocket 的托管 WebSocket 服务，请先获取您的 API 密钥和集群 ID。

获取 API 密钥和集群 ID：PieSocket 注册页面

然后使用以下代码创建通道：

// 初始化 PieSocket 配置
PieSocketOptions options = PieSocketOptions();
options.setClusterId("demo"); // 替换为您的集群 ID
options.setApiKey("VCXCEuvhGcBDP7XhiJJUDvR1e1D3eiVjgZ9VRiaV"); // 替换为您的 API 密钥

// 创建 PieSocket 实例
PieSocket piesocket = PieSocket(options);

// 加入聊天室频道
Channel channel = piesocket.join("chat-room");

// 监听系统连接事件
channel.on("system:connected", (event) {
    print("WebSocket 已连接！");
});

PieSocket Channels 特性

PieSocket Channels 提供以下功能：

• 认证
• 私有频道
• 存在频道
• 通过 REST API 发布消息
• 自动扩展
• Webhooks
• 分析
• 认证
• 最高可达 60% 成本节省

我们强烈建议在生产环境中使用 PieSocket Channels，而不是自托管的 WebSocket 服务器。

事件

当 WebSocket 连接就绪时，会触发 <code>system:connected</code> 事件。有关更多系统消息的详细信息，请参考：PieSocket 系统消息文档。

文档

有关更多用法示例和信息，请参考官方文档：PieSocket 官方文档

完整示例代码

以下是一个完整的示例代码，展示了如何使用 PieSocket Channels 进行实时通信。

import 'package:flutter/material.dart';
import 'package:piesocket_channels/channels.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text("PieSocket Channels 示例")),
        body: Center(
          child: Text("请查看控制台日志！"),
        ),
      ),
    );
  }
}

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

class _PieSocketExampleState extends State<PieSocketExample> {
  late PieSocket piesocket;
  late Channel channel;

  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化 PieSocket 配置
    PieSocketOptions options = PieSocketOptions();
    options.setClusterId("demo"); // 替换为您的集群 ID
    options.setApiKey("VCXCEuvhGcBDP7XhiJJUDvR1e1D3eiVjgZ9VRiaV"); // 替换为您的 API 密钥

    // 创建 PieSocket 实例
    piesocket = PieSocket(options);

    // 加入聊天室频道
    channel = piesocket.join("chat-room");

    // 监听系统连接事件
    channel.on("system:connected", (event) {
      print("WebSocket 已连接！");
    });

    // 监听聊天消息事件
    channel.listen("message", (PieSocketEvent event) {
      print("收到消息: ${event.data}");
    });
  }

  [@override](/user/override)
  void dispose() {
    // 关闭通道以释放资源
    channel.disconnect();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: () {
        // 向聊天室发送消息
        channel.publish("message", {"text": "Hello, PieSocket!"});
      },
      child: Text("发送消息"),
    );
  }
}