如何确保NestJS中的Cron任务仅单实例执行并支持超时终止？

要实现任务未完成时禁止启动下一次和超时强制终止的需求，你可以通过手动维护任务状态结合超时控制来实现，@nestjs/schedule本身没有提供现成装饰器，以下是完整的实现方案：

核心实现思路 #

1. 互斥执行：用一个布尔变量跟踪任务是否在运行，每次Cron触发时先检查该状态，避免重叠执行。
2. 超时终止：利用Promise.race让业务任务和超时定时器竞争，超时后通过AbortController发送终止信号（需业务任务支持取消）。
3. 状态安全：通过try-finally确保无论任务结果如何，都会重置运行状态，避免后续任务被阻塞。

完整代码示例 #

import { Injectable, Logger } from '@nestjs/common';
import { Cron } from '@nestjs/schedule';

@Injectable()
export class SchedulingService {
  private readonly logger = new Logger(SchedulingService.name);
  private isTaskRunning = false;
  private readonly TASK_TIMEOUT = 10000; // 自定义超时时间：10秒

  constructor(private readonly testService: TestService) {}

  @Cron('*/10 * * * * *', { name: 'schedulerTest' })
  async schedulerTest() {
    // 检查任务是否正在执行，是则跳过本次触发
    if (this.isTaskRunning) {
      this.logger.debug('上一次任务尚未完成，跳过本次执行');
      return;
    }

    this.isTaskRunning = true;
    try {
      // 执行带超时控制的任务
      await this.runWithTimeout(
        (signal) => this.testService.testFunc(signal),
        this.TASK_TIMEOUT,
      );
      this.logger.debug('任务执行完成');
    } catch (error) {
      this.logger.error('任务执行失败或超时', error.stack);
    } finally {
      // 无论成功/失败/超时，都重置任务状态
      this.isTaskRunning = false;
    }
  }

  /**
   * 封装带超时控制的任务执行逻辑
   * @param task 异步任务，可接收AbortSignal用于取消操作
   * @param timeoutMs 超时时间（毫秒）
   */
  private async runWithTimeout<T>(
    task: (signal?: AbortSignal) => Promise<T>,
    timeoutMs: number,
  ): Promise<T> {
    const abortController = new AbortController();
    let timeoutId: NodeJS.Timeout;

    // 超时Promise：到达时间后终止任务并抛出错误
    const timeoutPromise = new Promise<never>((_, reject) => {
      timeoutId = setTimeout(() => {
        abortController.abort();
        reject(new Error(`任务执行超时，已终止（超时时间：${timeoutMs}ms）`));
      }, timeoutMs);
    });

    try {
      // 让业务任务和超时Promise竞争
      return await Promise.race([task(abortController.signal), timeoutPromise]);
    } finally {
      // 清理超时定时器
      clearTimeout(timeoutId);
    }
  }
}

// 示例业务服务：支持通过AbortSignal终止任务
@Injectable()
export class TestService {
  async testFunc(signal?: AbortSignal) {
    // 模拟耗时业务操作（实际可替换为HTTP请求、数据库查询等）
    return new Promise((resolve, reject) => {
      const taskTimer = setTimeout(resolve, 15000); // 模拟15秒的长任务，会触发超时

      // 如果收到终止信号，清理定时器并抛出错误
      signal?.addEventListener('abort', () => {
        clearTimeout(taskTimer);
        reject(new Error('任务被超时终止'));
      });
    });
  }
}

关键细节说明 #

• 互斥逻辑：isTaskRunning标志位确保同一时间只有一个任务实例在运行，避免Cron触发间隔小于任务执行时间时的重叠问题。
• 超时终止：AbortController是Node.js和浏览器标准的取消API，大部分现代库（如fetch、部分数据库驱动）都支持通过该信号终止异步操作；如果你的业务任务不支持取消，超时后任务会在后台继续执行，但Cron任务会标记为完成，此时需注意后台任务的资源占用问题。
• 日志与异常处理：通过Logger记录任务状态，方便排查问题；try-finally块确保状态重置逻辑一定会执行，不会出现任务永久阻塞的情况。

内容的提问来源于stack exchange，提问作者Максим