原帖

启动

npm install --save @nestjs/schedule

// app.module.ts
import { ScheduleModule } from "@nestjs/schedule";
@Module({
  imports: [ScheduleModule.forRoot()],
  controllers: [AppController],
  providers: [AppService, TaskService],
})
export class AppModule {}

// TaskService.ts
import { Cron, CronExpression } from "@nestjs/schedule";
@Injectable()
export class TaskService {
  @Cron(CronExpression.EVERY_5_SECONDS)
  handleCron() {
    console.log("[task execute]");
  }
}

还有 <font style="color:rgb(37, 41, 51);">@Interval</font> 指定任务的执行间隔；<font style="color:rgb(37, 41, 51);">@Timeout</font> 指定多长时间后执行一次

@Interval(3000)
handleCron() {
  console.log('[task execute]', this.aaaService.findAll());
}

@Timeout('task3', 3000)
task3() {
    console.log('task3');
}

使用 <font style="color:rgb(37, 41, 51);">SchedulerRegistery</font> 来对定时任务做增删改查。

新增 cron 任务得先安装 <font style="color:rgb(37, 41, 51);">npm install --save cron</font>

export class AppModule implements OnApplicationBootstrap {
  @Inject(SchedulerRegistry)
  private schedulerRegistry: SchedulerRegistry;

  onApplicationBootstrap() {
    const crons = this.schedulerRegistry.getCronJobs();
    crons.forEach((item, key) => {
      item.stop();
      this.schedulerRegistry.deleteCronJob(key);
    });

    const intervals = this.schedulerRegistry.getIntervals();
    intervals.forEach((item) => {
      const interval = this.schedulerRegistry.getInterval(item);
      clearInterval(interval);

      this.schedulerRegistry.deleteInterval(item);
    });

    const timeouts = this.schedulerRegistry.getTimeouts();
    timeouts.forEach((item) => {
      const timeout = this.schedulerRegistry.getTimeout(item);
      clearTimeout(timeout);

      this.schedulerRegistry.deleteTimeout(item);
    });

    console.log(this.schedulerRegistry.getCronJobs());
    console.log(this.schedulerRegistry.getIntervals());
    console.log(this.schedulerRegistry.getTimeouts());

    const job = new CronJob(`0/5 * * * * *`, () => {
      console.log("cron job");
    });

    this.schedulerRegistry.addCronJob("job1", job);
    job.start();

    const interval = setInterval(() => {
      console.log("interval job");
    }, 3000);
    this.schedulerRegistry.addInterval("job2", interval);

    const timeout = setTimeout(() => {
      console.log("timeout job");
    }, 5000);
    this.schedulerRegistry.addTimeout("job3", timeout);
  }
}

cron 定义

nest 使用得定时系统是基于 Unix-like 操作系统中用于定时执行任务的工具 **cron**, 完全可以叫 chatgpt 帮助你来定义, （跟 jenkins 的还是有区别的，jenkins 还支持 H 符号来分散负载）

其中年是可选的，所以一般都是 6 个。格式：秒 分 小时 日期 月份 星期 <年> ，每个字段都可以写* ，比如秒写 *就代表每秒都会触发，日期写 * 就代表每天都会触发。

但当你指定了<font style="color:rgb(37, 41, 51);">具体的日期</font>的时候，由于不知道是星期几，如果写*表示那天都会执行，自然会冲突，所以当指定了具体的日期的时候，<font style="color:rgb(37, 41, 51);">星期得写?</font>，相反星期确定时，日期就应该写 ? 啦

# 每月 10 号的 13:12:07
7 12 13 10 * ?
# 从 20 到 30 的每分钟每个第 0 秒都会执行
0 20-30 * * * *
# 每小时的第 5 和 第 10 分钟的第 0 秒执行定时任务
0 5,10 * * * *
# 从第 5 分钟开始，每隔 10 分钟触发一次
0 5/10 * * * *

# L 是 last，L 用在星期的位置就是星期六
* * * ? * L
# L 用在日期的位置就是每月最后一天
* * * L * ?
# W 代表工作日 workday，只能用在日期位置，代表从周一到周五
* * * W * ?
# 当你指定 2W 的时候，代表每月的第而个工作日：
* * * 2W * ?
# LW 可以在指定日期时连用，代表每月最后一个工作日：
* * * LW * ?
# 星期的位置还可以用 4#3 表示每个月第 3 周的星期三：
* * * ? * 4#3
# 每个月的第二周的星期天就是这样
* * * ? * 1#2

更多