Flutter数据队列管理插件data_queue的使用

DataQueue

这个类是构建数据访问功能的基础。它管理事件队列（添加的数据）和命令队列（添加的命令）。你可以使用add和addAll方法添加数据。通过传递给execute方法的命令可以访问数据。

基本用法：

final dataQueue = DataQueue<String>();
dataQueue.add('test'); // 在dataQueue中现在有一个事件 - 'test'。
final next = await dataQueue.execute(NextCommand()); // 结果 = 'test'

QueueWorker

QueueWorker 类提供了命令，并且比 DataQueue 更简单地进行数据操作。基本用法如下：

final worker = QueueWorker(DataQueue<String>());
worker.add('test'); // 在事件队列中现在有一个事件 - 'test'。
worker.addAll([
  'test2',
  'test3'
]); // 在事件队列中现在有三个事件 - 'test', 'test2', 'test3'。
final next = await worker.next; // 结果 = 'test'
final take = await worker.take(2); // 结果 = ['test2', 'test3']
final count = await worker.enumerate; // 计数 = 0，事件队列为空。

Commands

所有的命令都是基于 CommandBase 接口实现的。你可以创建自己的命令。继承该类并编写 handle 方法。

可用命令：

• NextCommand - 该命令消费队列中的下一个事件。
• TakeCommand - 该命令消费队列中的接下来的指定数量的事件。
• SkipCommand - 该命令跳过队列中的接下来的指定数量的事件。
• CountCommand - 该命令计算队列中的所有事件。
• CloneCommand - 该命令取队列中的一个事件而不消费它。
• AllCommand - 该命令从队列中取出所有事件。

终止

你可以通过调用 terminate 方法来终止命令的执行。队列中的所有命令都将完成并抛出 TerminatedException。TerminatedException 包含一个命令及其可选的命令数据。

示例代码

以下是一个完整的示例代码，演示了如何使用 QueueWorker 和各种命令：

import 'package:data_queue/data_queue.dart';

Future<void> main() async {
  final worker = QueueWorker(DataQueue<String>());
  
  // 添加数据到队列
  worker.add('test'); // 在事件队列中现在有一个事件 - 'test'。
  worker.addAll([
    'test2',
    'test3'
  ]); // 在事件队列中现在有三个事件 - 'test', 'test2', 'test3'。

  // 获取并移除下一个事件
  final next = await worker.next; 
  print('下一个事件: $next'); // 输出: 下一个事件: test
  
  // 获取并移除接下来的两个事件
  final take = await worker.take(2);
  print('移除的事件: $take'); // 输出: 移除的事件: [test2, test3]
  
  // 检查队列是否为空
  final count = await worker.enumerate;
  print('当前队列中的事件数量: $count'); // 输出: 当前队列中的事件数量: 0
}