如何在NestJS Cron定时任务中添加计数器实现限次执行？

方案1：静态声明Cron任务（@Cron()装饰器场景） #

这是最常用的场景，直接通过装饰器声明的定时任务可以通过实例计数+SchedulerRegistry销毁任务实现次数限制：

import { Injectable } from '@nestjs/common';
import { Cron, CronExpression, SchedulerRegistry } from '@nestjs/schedule';
import { CronJob } from 'cron';

@Injectable()
export class TaskService {
  // 执行次数计数器
  private executeCount = 0;
  // 最大允许执行次数
  private readonly MAX_EXECUTE_TIMES = 3;

  constructor(private schedulerRegistry: SchedulerRegistry) {}

  // 必须给任务设置唯一name属性，方便后续查找删除
  @Cron(CronExpression.EVERY_10_SECONDS, {
    name: 'limit_count_cron'
  })
  handleLimitedCronTask() {
    this.executeCount++;
    console.log(`定时任务执行第 ${this.executeCount} 次`);

    // 达到次数上限后停止并删除任务
    if (this.executeCount >= this.MAX_EXECUTE_TIMES) {
      const cronJob: CronJob = this.schedulerRegistry.getCronJob('limit_count_cron');
      cronJob.stop();
      this.schedulerRegistry.deleteCronJob('limit_count_cron');
      console.log(`定时任务已达到最大执行次数${this.MAX_EXECUTE_TIMES}次，已停止`);
    }
  }
}

注意事项：

• 计数器必须定义为类的实例属性，不能定义在方法内部，否则每次执行都会重置计数
• 必须给@Cron装饰器的任务设置全局唯一的name属性，否则无法通过SchedulerRegistry定位到对应任务

方案2：动态创建Cron任务场景 #

如果是运行时动态生成的定时任务，可以在创建任务时直接绑定计数逻辑：

import { Injectable } from '@nestjs/common';
import { SchedulerRegistry } from '@nestjs/schedule';
import { CronJob } from 'cron';

@Injectable()
export class DynamicTaskService {
  constructor(private schedulerRegistry: SchedulerRegistry) {}

  createLimitedCronTask(taskName: string, maxExecuteTimes: number, cronExpression: string) {
    let executeCount = 0;
    const job = new CronJob(cronExpression, () => {
      executeCount++;
      console.log(`动态定时任务${taskName}执行第 ${executeCount} 次`);

      if (executeCount >= maxExecuteTimes) {
        job.stop();
        this.schedulerRegistry.deleteCronJob(taskName);
        console.log(`动态定时任务${taskName}已达到最大执行次数${maxExecuteTimes}次，已停止`);
      }
    });

    this.schedulerRegistry.addCronJob(taskName, job);
    job.start();
  }
}

扩展说明 #

• 上述方案的计数器默认是内存存储，服务重启后会重置计数。如果需要重启后仍保留计数，可将计数存入Redis、MySQL等持久化存储，每次执行任务前先读取当前计数再做判断
• 如果你使用的是@Interval()或@Timeout()装饰器的定时任务，只需要把上述代码中的Cron相关API替换为SchedulerRegistry对应的getInterval()/deleteInterval()、getTimeout()/deleteTimeout()即可，逻辑完全一致
• 任务销毁时优先调用stop()方法停止触发，再从注册中心删除，避免出现残留触发的问题

内容的提问来源于stack exchange，提问作者Amin Alizadeh