Flutter定时任务管理插件mongo_cron的使用

MongoCron 是一个基于 MongoDB 的定时任务调度器，适用于 Dart 开发者。它允许你使用 cron 表达式来安排任务，并将这些任务持久化到 MongoDB 中。

特性

• 使用 cron 表达式来调度任务（如果你不熟悉 cron 表达式，可以使用 Cronitor 来帮助理解）
• 将任务持久化到 MongoDB
• 提供各种 cron 事件的回调（启动、停止、空闲、错误）

处理速度

当越来越多的文档被添加到集合中时，处理速度可能会降低。我们可以通过创建以下索引来保持速度：

await _collection.createIndex(key: 'name', unique: true);
await _collection.createIndex(keys: {'sleepUntil': 1, 'name': 1});

使用方法

你可以查看 示例代码 获取完整的示例。

import 'package:mongo_cron/mongo_cron.dart';
import 'package:mongo_dart/mongo_dart.dart';

void main() async {
  // 连接到本地 MongoDB 数据库
  final db = await Db.create('mongodb://localhost:27017/your_database');
  await db.open();

  // 配置 MongoCron 实例
  final config = MongoCronConfig(
    database: db,
    onStart: (MongoCron cron) async {
      print('MongoCron started');
    },
    onStop: (MongoCron cron) async {
      print('MongoCron stopped');
    },
    onIdle: (MongoCron cron) async {
      print('MongoCron is idle');
    },
    onError: (dynamic error, MongoCron cron) async {
      print('Error occurred: $error');
      if (!db.isConnected) {
        print('MongoDB disconnected—reconnecting...');
        await db.close();
        await db.open();
        print('MongoDB reconnected');
      }
    },
    onJobStart: (Job job) async {
      print(
          '${DateTime.now().toIso8601String()} Job started: ${job.name} #${job.id}');
    },
    onJobComplete: (Job job) async {
      print(
          '${DateTime.now().toIso8601String()} Job complete: ${job.name} #${job.id}');
    },
  );

  // 创建并配置 MongoCron 实例
  final mongoCron = MongoCron(config);

  // 添加一个任务
  await mongoCron.addJob(
    cronExpression: '*/5 * * * *', // 每 5 分钟执行一次
    name: 'job1',
    handler: (Job job) async {
      print('Executing job ${job.id} with data: ${job.data}');
    },
    jobData: {'message': 'Hello, World!'}, // 传递给任务的数据
  );

  // 启动 Cron
  await mongoCron.start();

  // 在运行过程中可以添加更多任务
  await mongoCron.addJob(
    cronExpression: '* * * * *', // 每分钟执行一次
    name: 'job2',
    handler: (Job job) async {
      print('Second job');
    },
  );

  // 运行一段时间
  await Future.delayed(const Duration(seconds: 30));

  // 停止 Cron
  await mongoCron.stop();
  await db.close();
}

代码解释

1. 连接到 MongoDB 数据库：

   final db = await Db.create('mongodb://localhost:27017/your_database');
   await db.open();
   

   这里我们创建并打开了一个 MongoDB 数据库实例。

2. 配置 MongoCron 实例：

   final config = MongoCronConfig(
     database: db,
     onStart: (MongoCron cron) async {
       print('MongoCron started');
     },
     onStop: (MongoCron cron) async {
       print('MongoCron stopped');
     },
     onIdle: (MongoCron cron) async {
       print('MongoCron is idle');
     },
     onError: (dynamic error, MongoCron cron) async {
       print('Error occurred: $error');
       if (!db.isConnected) {
         print('MongoDB disconnected—reconnecting...');
         await db.close();
         await db.open();
         print('MongoDB reconnected');
       }
     },
     onJobStart: (Job job) async {
       print(
           '${DateTime.now().toIso8601String()} Job started: ${job.name} #${job.id}');
     },
     onJobComplete: (Job job) async {
       print(
           '${DateTime.now().toIso8601String()} Job complete: ${job.name} #${job.id}');
     },
   );
   

   这里我们配置了 MongoCron 实例，定义了启动、停止、空闲和错误时的回调函数。

3. 创建并配置 MongoCron 实例：

   final mongoCron = MongoCron(config);
   

4. 添加任务：

   await mongoCron.addJob(
     cronExpression: '*/5 * * * *', // 每 5 分钟执行一次
     name: 'job1',
     handler: (Job job) async {
       print('Executing job ${job.id} with data: ${job.data}');
     },
     jobData: {'message': 'Hello, World!'}, // 传递给任务的数据
   );
   

   我们添加了一个任务，并设置了 cron 表达式、任务名称和处理函数。

5. 启动 Cron：

   await mongoCron.start();
   

6. 在运行过程中添加更多任务：

   await mongoCron.addJob(
     cronExpression: '* * * * *', // 每分钟执行一次
     name: 'job2',
     handler: (Job job) async {
       print('Second job');
     },
   );
   

7. 运行一段时间后停止 Cron：

   await Future.delayed(const Duration(seconds: 30));
   await mongoCron.stop();
   await db.close();