Flutter实时数据插件sabowsla_realtime的使用

realtime-dart 监听 PostgreSQL 数据库的变化并通过 WebSocket 进行通信。

这是一个用于 Sabowsla 实时服务器的 Dart 客户端。

文档

文档可以在官方 Sabowsla 网站上找到。

• Dart 参考
• 实时指南

信用

• https://github.com/sabowsla/realtime-js - 从 realtime-js 库移植而来

许可证

该项目采用 MIT 许可证。

示例代码

以下是一个使用 sabowsla_realtime 插件的示例：

import 'package:sabowsla_realtime/sabowsla_realtime.dart';

/// 示例代码，用于与 Sabowsla Realtime https://sabowsla.io/ 交互
Future<void> main() async {
  // 创建一个 WebSocket 连接实例
  final socket = SabowslaRealtime(
    'ws://SUPABASE_API_ENDPOINT/realtime/v1', // 替换为实际的 API 地址
    params: {'apikey': 'SUPABSE_API_KEY'}, // 替换为实际的 API 密钥
    // 日志打印函数
    logger: (kind, msg, data) => {print('$kind $msg $data')},
  );

  // 连接到名为 'realtime:public' 的频道
  final channel = socket.channel('realtime:public');

  // 监听所有类型的变化
  channel.onPostgresChanges(
    event: PostgresChangeEvent.all,
    filter: PostgresChangeFilter(
      type: PostgresChangeFilterType.eq,
      column: 'column', // 替换为实际的列名
      value: 'value', // 替换为实际的值
    ),
    callback: (payload) {}, // 回调函数
  );

  // 监听删除事件
  channel.onPostgresChanges(
      event: PostgresChangeEvent.delete,
      schema: 'public', // 替换为实际的模式名
      callback: (payload) {
        print('channel delete payload: ${payload.toString()}'); // 打印删除事件的负载
      });

  // 监听插入事件
  channel.onPostgresChanges(
      event: PostgresChangeEvent.insert,
      schema: 'public', // 替换为实际的模式名
      callback: (payload) {
        print('channel insert payload: ${payload.toString()}'); // 打印插入事件的负载
      });

  // 监听消息
  socket.onMessage((message) => print('MESSAGE $message')); // 打印接收到的消息

  // 连接并订阅频道
  socket.connect();
  channel.subscribe((a, [_]) => print('SUBSCRIBED')); // 打印订阅成功的消息

  // 延迟 20 秒以接收来自服务器的事件
  await Future.delayed(const Duration(seconds: 20));

  // 取消订阅并断开连接
  channel.unsubscribe();
  socket.disconnect();
}

说明

1. 创建 WebSocket 连接实例：

   final socket = SabowslaRealtime(
     'ws://SUPABASE_API_ENDPOINT/realtime/v1',
     params: {'apikey': 'SUPABSE_API_KEY'},
     logger: (kind, msg, data) => {print('$kind $msg $data')},
   );
   

   这里需要替换 SUPABASE_API_ENDPOINT 和 SUPABSE_API_KEY 为实际的值。

2. 连接到频道：

   final channel = socket.channel('realtime:public');
   

3. 监听数据库变化：

   channel.onPostgresChanges(
     event: PostgresChangeEvent.all,
     filter: PostgresChangeFilter(
       type: PostgresChangeFilterType.eq,
       column: 'column',
       value: 'value',
     ),
     callback: (payload) {},
   );
   

4. 处理插入和删除事件：

   channel.onPostgresChanges(
       event: PostgresChangeEvent.delete,
       schema: 'public',
       callback: (payload) {
         print('channel delete payload: ${payload.toString()}');
       });
   
   channel.onPostgresChanges(
       event: PostgresChangeEvent.insert,
       schema: 'public',
       callback: (payload) {
         print('channel insert payload: ${payload.toString()}');
       });
   

5. 连接并订阅频道：

   socket.connect();
   channel.subscribe((a, [_]) => print('SUBSCRIBED'));
   

6. 延迟一段时间以接收事件：

   await Future.delayed(const Duration(seconds: 20));
   

7. 取消订阅并断开连接：

   channel.unsubscribe();
   socket.disconnect();