[Nestjs] 集成定时器以及使用方法

简介: 在后台开发中,我们经常遇到定时的需求,比如每天早上八点推送日志,推送待办,推送天气预报等。接下来简单介绍Nestjs集成定时器的简单使用方法!

在后台开发中,我们经常遇到定时的需求,比如每天早上八点推送日志,推送待办,推送天气预报等。接下来简单介绍Nestjs集成定时器的简单使用方法!


在 NestJS 中集成定时器可以使用 @nestjs/schedule 模块,它提供了一种简单而强大的方式来执行定时任务。下面是集成定时器的步骤:


安装 @nestjs/schedule 模块:使用 npm 或者 yarn 安装 @nestjs/schedule 模块。

npm install --save @nestjs/schedule

配置模块:在你的 NestJS 应用的根模块(通常是 app.module.ts)中导入 ScheduleModule 并添加到 imports 数组中。

import { Module } from '@nestjs/common';
import { ScheduleModule } from '@nestjs/schedule';
import { AppController } from './app.controller';
import { AppService } from './app.service';
@Module({
  imports: [ScheduleModule.forRoot()],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}


创建定时任务:在任何一个可注入类(比如服务)中创建定时任务。首先,使用 @Injectable() 装饰器将该类标记为可注入。然后,使用 @Cron() 装饰器来指定定时任务的执行时间。可以使用 Cron 表达式或者预定义的字符串(如 '0 * * * *' 表示每小时的整点)。

import { Injectable } from '@nestjs/common';
import { Cron } from '@nestjs/schedule';
@Injectable()
export class MyTaskService {
  @Cron('0 * * * *') // 每小时的整点执行
  handleCron() {
    console.log('定时任务每小时执行一次');
  }
}

使用定时任务:在需要使用定时任务的地方,比如控制器或者其他服务中,将定时任务的类注入进来,并调用其方法。

import { Controller, Get } from '@nestjs/common';
import { MyTaskService } from './my-task.service';
@Controller('cats')
export class CatsController {
  constructor(private readonly myTaskService: MyTaskService) {}
  @Get()
  findAll(): string {
    this.myTaskService.handleCron(); // 执行定时任务方法
    return 'This action returns all cats';
  }
}


这时我们启动服务,定时器就会正常触发了!


更多跟定时器相关的API请查阅官方文档

相关文章
|
2月前
Nest.js 实战 (十二):优雅地使用事件发布/订阅模块 Event Emitter
这篇文章介绍了在Nest.js构建应用时,如何通过事件/发布-订阅模式使应用程序更健壮、灵活、易于扩展,并简化服务间通信。文章主要围绕@nestjs/event-emitter模块展开,这是一个基于eventemitter2库的社区模块,提供了事件发布/订阅功能,使得实现事件驱动架构变得简单。文章还介绍了如何使用该模块,包括安装依赖、初始化模块、注册EventEmitterModule、使用装饰器简化监听等。最后总结,集成@nestjs/event-emitter模块可以提升应用程序的事件驱动能力,构建出更为松耦合、易扩展且高度灵活的系统架构,是构建现代、响应迅速且具有高度解耦特性的Nest.
|
12月前
|
前端开发
使用concurrently模块-同时启动react项目和mock模拟接口
使用concurrently模块-同时启动react项目和mock模拟接口
77 0
|
前端开发 JavaScript
dva的简单使用流程
dva的简单使用流程
86 0
|
6月前
|
Web App开发 JavaScript 前端开发
Express 框架的特点、使用方法以及相关的常用功能和中间件
Express 框架的特点、使用方法以及相关的常用功能和中间件
320 1
|
6月前
|
关系型数据库 MySQL API
如何使用hook?
如何使用hook?
42 0
|
6月前
|
C++
[项目配置] 配置Qt函数库和ui界面库的封装并调用的项目(二)
[项目配置] 配置Qt函数库和ui界面库的封装并调用的项目
102 0
|
6月前
|
算法 关系型数据库 编译器
[项目配置] 配置Qt函数库和ui界面库的封装并调用的项目(一)
[项目配置] 配置Qt函数库和ui界面库的封装并调用的项目
186 0
|
移动开发 开发框架 JavaScript
什么是组件,以及前端各种框架组件的使用方法
什么是组件,以及前端各种框架组件的使用方法
430 1
React+Hook+ts+antDesign实现伪定时调用接口功能
React+Hook+ts+antDesign实现伪定时调用接口功能
73 0
|
Linux C++ Windows
基于Asio库的定时器,封装实现好用的定时任务
基于Asio库的定时器,封装实现好用的定时任务