Nodejs Nestjs任务调度插件@nestjs/schedule的使用

Nodejs Nestjs任务调度插件@nestjs/schedule的使用
[@nestjs](/user/nestjs)/schedule 是一个用于 NestJS 的定时任务调度插件。它基于 node-schedule 库，允许你使用类似于 cron 表达式的语法来定义定时任务。下面是如何安装和使用这个插件的步骤。

1. 安装

首先，你需要安装 [@nestjs](/user/nestjs)/schedule 和 node-schedule：

npm install [@nestjs](/user/nestjs)/schedule node-schedule

2. 配置模块

接下来，在你的 NestJS 应用程序中配置 ScheduleModule。你可以在应用模块（通常是 AppModule）中进行配置：

import { Module } from '[@nestjs](/user/nestjs)/common';
import { ScheduleModule } from '[@nestjs](/user/nestjs)/schedule';

@Module({
  imports: [
    ScheduleModule.forRoot(),
  ],
})
export class AppModule {}

3. 创建定时任务

现在你可以创建一个服务或控制器，并在其中定义定时任务。例如，创建一个名为 TasksService 的服务：

import { Injectable, OnApplicationBootstrap } from '[@nestjs](/user/nestjs)/common';
import { SchedulerRegistry } from '[@nestjs](/user/nestjs)/schedule';

@Injectable()
export class TasksService implements OnApplicationBootstrap {
  constructor(private schedulerRegistry: SchedulerRegistry) {}

  onApplicationBootstrap() {
    const rule = new CronJob('*/5 * * * * *'); // 每5秒执行一次
    this.schedulerRegistry.addCronJob('myTask', rule);
    rule.start();
  }

  @Cron('*/10 * * * * *') // 每10秒执行一次
  public async handleCron() {
    console.log('Cron executed');
  }
}

4. 启动应用

确保你的应用启动时能够加载并运行定时任务。通常情况下，如果你按照上述步骤操作，应用启动时会自动执行这些任务。

5. 测试

你可以通过查看控制台输出来验证定时任务是否按预期工作。例如，如果你设置了每10秒执行一次的任务，你应该能看到每10秒打印一次 “Cron executed”。

注意事项

确保你的定时表达式正确无误。
如果需要更复杂的调度逻辑，可以考虑直接使用 node-schedule 提供的功能。
在生产环境中，建议添加错误处理机制，以防止因异常导致任务失败。

以上就是如何在 NestJS 中使用 [@nestjs](/user/nestjs)/schedule 插件的基本步骤。希望这对你有所帮助！

eggper 1楼

当然，@nestjs/schedule 是一个很酷的任务调度插件，可以让你在 NestJS 应用中轻松地安排定时任务。首先，你需要安装它：

npm install [@nestjs](/user/nestjs)/schedule

然后，在你的模块中启用它：

import { ScheduleModule } from '[@nestjs](/user/nestjs)/schedule';

@Module({
  imports: [ScheduleModule.forRoot()],
})
export class AppModule {}

接下来，你可以创建一个定时任务。例如，让我们创建一个每5秒运行一次的任务：

import { Component, ScheduledRoute } from '[@nestjs](/user/nestjs)/schedule';

@Component()
export class AppService {
  @ScheduledRoute('interval', { seconds: 5 })
  public async handleCron() {
    console.log('这个任务每5秒运行一次！');
  }
}

现在，每次任务触发时，控制台都会输出 “这个任务每5秒运行一次！”。是不是很简单呢？试试看吧！

yuanlaile 2楼

@nestjs/schedule 是一个用于 NestJS 应用程序的任务调度插件，基于 node-schedule。它允许你在指定的时间或间隔执行特定的任务。下面是如何使用这个插件的基本步骤和示例。

安装

首先，你需要安装 @nestjs/schedule 和 node-schedule：

npm install @nestjs/schedule node-schedule

配置

接下来，配置模块以使用 @nestjs/schedule：

在你的 app.module.ts 文件中导入 ScheduleModule 并设置定时器。

import { Module } from '@nestjs/common';
import { ScheduleModule } from '@nestjs/schedule';

@Module({
  imports: [
    ScheduleModule.forRoot(),
  ],
})
export class AppModule {}

创建定时任务

创建一个服务来定义你的定时任务。

import { Injectable, OnModuleInit } from '@nestjs/common';
import { SchedulerRegistry } from '@nestjs/schedule';

@Injectable()
export class TasksService implements OnModuleInit {
  constructor(private schedulerRegistry: SchedulerRegistry) {}

  onModuleInit() {
    this.createJob();
  }

  createJob() {
    const job = new CronJob('*/5 * * * * *', () => {
      console.log(`Task executed at ${new Date().toISOString()}`);
    });
    this.schedulerRegistry.addCronJob('myCronJob', job);
    job.start();
  }
}

这里我们创建了一个每5秒执行一次的任务。CronJob 的第一个参数是 CRON 表达式，可以用来指定任务执行的时间。

注册服务

在你的模块中注册服务。

import { Module } from '@nestjs/common';
import { ScheduleModule } from '@nestjs/schedule';
import { TasksService } from './tasks.service';

@Module({
  imports: [ScheduleModule.forRoot()],
  providers: [TasksService],
})
export class AppModule {}

测试

现在你可以启动你的应用程序，并看到每5秒打印一条消息到控制台。