Flutter工具集成插件zaptools_client的使用

Flutter工具集成插件zaptools_client的使用

Zaptools

Zaptools 是一个用于事件驱动的 websocket 管理工具库。它基于 Websocket 构建。

使用说明

为了与服务器建立连接，zaptools-dart 提供了两种客户端：基于回调和基于流。

• 基于回调的客户端 (ZapConsumer): 当事件被触发时会触发回调。

  final zConsumer = ZapConsumer('ws://127.0.0.1:8000/')..connect();
  
  zConsumer.onConnected((eventData) {
    print('connected!');
  });
  
  zConsumer.onDisconnected((eventData) {
    print('disconnected!');
  });
  
  zConsumer.onEvent("myEvent", (eventData) { 
    print("myEvent Received");
  });
  

• 基于流的客户端 (ZapSubscriber): 提供 ConnectionState 的流和事件接收的流。你可以订阅特定事件、一组事件或所有事件。

  final zSubscriber = ZapSubscriber('ws://127.0.0.1:8000/')..connect();
  
  zSubscriber.connectionState.listen((event) {
    if (event case ConnectionState.online) {
      print("connected!"); 
    }
    if (event case ConnectionState.offline) {
      print("disconnected!"); 
    }
  });
  
  zSubscriber.subscribeToEvent("myEVent").listen((eventData){
    print("event received!");
    // listen when 'myEvent' is received.
  });
  
  zSubscriber.subscribeToEvents(["myEvent", "myOtherEvent"]).listen((event) { 
    print("a event is received");
    // listen when 'myEvent' or 'myOtherEvent' are received.
  });
  
  zSubscriber.subscribe toAllEvent().listen((event) {
    print("whatever is received!");
    // listen all events 
  });
  

  注意：记得取消订阅流以防止不必要的资源消耗。

发送事件

ZapConsumer 和 ZapSubscriber 都可以通过 send 方法向服务器发送事件。

zSubscriber.sendEvent("eventName", "payload");

zConsumer.sendEvent("eventName", "payload");

连接、断开连接、重试连接

connect 方法用于初始连接和在连接丢失时重新连接到服务器。

zConsumer.connect();
zSubscriber.connect();

disconnect 方法用于关闭与服务器的 WebSocket 连接。

zConsumer.disconnect();
zSubscriber.disconnect();

清洁

当您调用 disconnect 方法在 ZapSubscriber 中时，虽然关闭了 WebSocket 连接，但 ZapSubscriber 仍然等待事件发出。如果 ZapSubscriber 从 WebSocket 断开连接，再次调用 connect 方法会使 ZapSubscriber 重新连接到 WebSocket 并可以发出来自服务器的事件，这可以防止创建新的订阅并防止重复事件。

final zSubscriber = ZapSubscriber('ws://127.0.0.1:8000/')..connect();

zSubscriber.connectionState.listen((event) {
  // code here
  // still received event after reconnect
});

zSubscriber.subscribeToEvent("myEVent").listen((eventData){
  // code here
  // still received event after reconnect
});

zSubscriber.disconnect();

zSubscriber.connect();

如果您想完全关闭 ZapSubscriber，请调用 clean 方法，这将关闭并清理与 WebSocket 的连接。

final zSubscriber = ZapSubscriber('ws://127.0.0.1:8000/')..connect();

zSubscriber.connectionState.listen((event) {
  // code here
  // No received event after clean
});

zSubscriber.subscribe toEvent("myEVent").listen((eventData){
  // code here
  // No received event after clean
});

zSubscriber.clean(); // all subscriptions "done"

重要提示: 取消所有 StreamSubscription 以避免不必要的资源消耗。

示例代码

import 'package:zaptools_client/zaptools_client.dart';

void main() {
  final uri = Uri.parse('ws://127.0.0.1:8000/');
  final zConsumer = ZapConsumer(uri)..connect();

  zConsumer.onConnected((eventData) {
    print('connected!');
  });

  zConsumer.onDisconnected((eventData) {
    print('disconnected!');
  });

  zConsumer.sendEvent('hello', 'hello from client');

  zConsumer.onEvent(
    'bye',
    (eventData) async {
      print(eventData.name);
      print(eventData.payload);
      await Future.delayed(Duration(seconds: 1));
      zConsumer.disconnect;
    },
  );
}