Flutter任务队列管理插件queue_it的使用

Flutter任务队列管理插件queue_it的使用

QueueIt简介

QueueIt 是一个用于简化Flutter和Dart应用程序中队列管理和处理的插件。它提供了以下功能：

• 队列管理：轻松添加、移除和处理队列中的项目。
• 事件监听：监听队列更新并接收快照。
• 并发控制：控制同时处理的项目数量。
• 自动重试：自动重试失败的项目。

使用示例

基本用法

以下是一个基本的示例，展示了如何使用QueueIt来管理一个简单的整数队列：

import 'package:queue_it/queue_it.dart';

void main() {
  // 创建一个QueueIt实例，设置并发数为1，重试次数为3
  final queue = QueueIt<int>(
    parallel: 1, // 并发处理的项目数量
    retries: 3, // 每个项目的最大重试次数
    itemHandler: (item) async {
      print('Handling item: ${item.id}'); // 打印正在处理的项目ID
      // 模拟处理时间
      await Future.delayed(Duration(seconds: 1));
    },
  )
    ..onUpdate.listen((snapshot) {
      // 监听队列更新事件
      print('Queue updated: ${snapshot.event.name}');
    });

  // 向队列中添加一些项目
  queue.add(1);
  queue.add(2);
  queue.add(3);

  // 开始处理队列
  queue.start();

  // 在队列开始处理后，可以继续添加更多项目
  queue.add(4);
  queue.add(5);
}

在Flutter项目中使用

在Flutter项目中，你可以使用QueueItWidget来监听队列的变化并重建你的小部件树。以下是一个示例：

import 'package:flutter/material.dart';
import 'package:queue_it/queue_it.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('QueueIt Example')),
        body: QueueItWidget<int>(
          queue: _queue,
          builder: (context, snapshot) {
            // 每次队列更新时调用此构建器
            final items = _queue.items().toList();
            return ListView.builder(
              itemCount: items.length,
              itemBuilder: (context, index) {
                final item = items[index];
                return ListTile(
                  title: Text('Item status: ${item.status.name}'),
                );
              },
            );
          },
        ),
      ),
    );
  }
}

// 定义一个全局的QueueIt实例
final _queue = QueueIt<int>(
  parallel: 3, // 并发处理的项目数量
  retries: 3, // 每个项目的最大重试次数
  useFriendlyIds: true, // 使用友好的ID（可选）
  itemHandler: (item) async {
    print('Handling item: ${item.id}'); // 打印正在处理的项目ID
    // 模拟处理时间
    await Future.delayed(Duration(seconds: 1));
  },
)
..onUpdate.listen((snapshot) {
  if (snapshot.eventItem != null) {
    print(snapshot.eventItem!.summaryTableLine); // 打印事件项的摘要
  } else {
    print(snapshot.event.name); // 打印事件名称
  }
});

// 向队列中添加一些项目
void addItemsToQueue() {
  _queue.add(1);
  _queue.add(2);
  _queue.add(3);
  _queue.start(); // 开始处理队列

  // 在队列开始处理后，可以继续添加更多项目
  _queue.add(4);
  _queue.add(5);
}

更多功能

• 并发控制：通过设置parallel参数，可以控制同时处理的项目数量。例如，设置parallel: 3表示最多同时处理3个项目。
• 自动重试：通过设置retries参数，可以指定每个项目失败后的最大重试次数。例如，设置retries: 3表示每个项目最多重试3次。
• 事件监听：通过onUpdate监听器，可以实时获取队列的状态变化，并根据需要进行处理。

许可证

QueueIt 采用 MIT License 许可证发布。

完整示例Demo

为了更好地理解QueueIt的使用，以下是一个完整的Flutter应用示例，展示了如何创建、管理并展示队列中的项目状态：

import 'package:flutter/material.dart';
import 'package:queue_it/queue_it.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('QueueIt Demo')),
        body: QueueItDemo(),
      ),
    );
  }
}

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

class _QueueItDemoState extends State<QueueItDemo> {
  final _queue = QueueIt<int>(
    parallel: 3, // 并发处理的项目数量
    retries: 3, // 每个项目的最大重试次数
    useFriendlyIds: true, // 使用友好的ID（可选）
    itemHandler: (item) async {
      print('Handling item: ${item.id}'); // 打印正在处理的项目ID
      // 模拟处理时间
      await Future.delayed(Duration(seconds: 1));
    },
  );

  [@override](/user/override)
  void initState() {
    super.initState();
    // 添加一些初始项目到队列
    _queue.add(1);
    _queue.add(2);
    _queue.add(3);
    _queue.start(); // 开始处理队列
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Column(
      children: [
        ElevatedButton(
          onPressed: () {
            // 点击按钮时向队列中添加新项目
            setState(() {
              _queue.add(_queue.items().length + 1);
            });
          },
          child: Text('Add Item to Queue'),
        ),
        Expanded(
          child: QueueItWidget<int>(
            queue: _queue,
            builder: (context, snapshot) {
              final items = _queue.items().toList();
              return ListView.builder(
                itemCount: items.length,
                itemBuilder: (context, index) {
                  final item = items[index];
                  return ListTile(
                    title: Text('Item ID: ${item.id}, Status: ${item.status.name}'),
                  );
                },
              );
            },
          ),
        ),
      ],
    );
  }
}