【Nest教程】Nest项目增加定时任务

青年码农

发布于 2021-02-03 11:15:45

4.8K0

发布于 2021-02-03 11:15:45

文章被收录于专栏：青年码农青年码农

定时任务对于项目来说，也是必不可少的，今天就来说一说在Nest项目中集成定时任务

Nest框架有实现定时任务的库@nestjs/schedule，官方教程参照：

https://docs.nestjs.com/techniques/task-scheduling

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],
})

运行项目