1 安装
首先安装依赖库
$ npm install --save @nestjs/schedule $ npm install --save-dev @types/cron
复制
yarn安装也可以,我项目上使用的是yarn,如果npm安装完成项目运行报错,可以用yarn在重新安装一遍
2 添加到app.module
import { Module } from '@nestjs/common'; import { ScheduleModule } from '@nestjs/schedule'; @Module({ imports: [ ScheduleModule.forRoot() ], }) export class AppModule {}
复制
3 使用
这里只演示,具体使用请根据项目,src下新建schedule文件夹,文件夹内新建tasks.service.ts,
import { Injectable, Logger } from '@nestjs/common'; import { Cron, Interval, Timeout } from '@nestjs/schedule'; @Injectable() export class TasksService { private readonly logger = new Logger(TasksService.name); constructor(private readonly exampleService: ExampleService) {} @Cron('45 * * * * *') handleCron() { this.logger.debug('该方法将在45秒标记处每分钟运行一次'); } @Interval(10000) handleInterval() { this.logger.debug('2'); } @Timeout(5000) handleTimeout() { this.logger.debug('3'); } @Interval(10000) sendEmail() { this.logger.debug('3'); } }
复制
在app.module providers中添加
import { Module } from '@nestjs/common'; import { TasksService } from './schedule/tasks.service'; @Module({ providers: [AppService, TasksService], })
复制
运行项目
定时任务已启动
4 其他模式
还有一些其他模式,
- * * * * * *:每一秒
- 45 * * * * *:每分钟,在45秒
- * 10 * * * *:每小时一次,十分钟开始
- 0 */30 9-17 * * *:上午九时至下午五时,每三十分钟一次
- 0 30 11 * * 1-5:星期一至星期五上午11:30