NestJS定时任务：自动化提醒，助你实现目标

前端

2023-07-23 08:12:35

创建和管理定时任务以提高效率

在快节奏的数字世界中，高效性和达成率至关重要。定时任务 提供了自动化任务和优化流程的强大工具。本文将指导您在您的应用程序中实现定时任务，以提醒您未完成的任务，并提高您实现长期目标的可能性。

什么是定时任务？

定时任务是预先安排在特定时间或按特定时间间隔执行的任务。您可以将它们视为您的应用程序中的“私人助理”，负责执行您没有时间或容易忘记的重复性任务。

如何使用定时任务？

定时任务的用途广泛，包括：

发送电子邮件提醒
备份数据
清理日志
处理付款
触发警报

使用 Bull.js 管理定时任务

在本文中，我们将使用 Bull.js ，这是一个用于轻松创建和管理定时任务的流行 Node.js 库。

安装 Bull.js

使用以下命令安装 Bull.js：

npm install --save bull

创建 Tasks 服务

创建一个名为 TasksService 的服务，负责管理您的定时任务：

import { Injectable } from '@nestjs/common';
import { Queue } from 'bull';

@Injectable()
export class TasksService {
  private readonly queue: Queue;

  constructor() {
    this.queue = new Queue('tasks', {
      redis: {
        host: 'localhost',
        port: 6379,
      },
    });
  }

  async createTask(name: string, cron: string, data?: any): Promise<Job> {
    return await this.queue.add(name, data, {
      cron,
      repeat: {
        every: cron,
      },
    });
  }

  async cancelTask(id: string): Promise<void> {
    await this.queue.getJob(id).remove();
  }
}

创建定时任务

使用 TasksService 创建定时任务：

// tasks.controller.ts

import { Controller, Post, Body } from '@nestjs/common';
import { TasksService } from './tasks.service';
import { CreateTaskDto } from './dto/create-task.dto';

@Controller('tasks')
export class TasksController {
  constructor(private readonly tasksService: TasksService) {}

  @Post()
  async createTask(@Body() body: CreateTaskDto): Promise<Job> {
    return await this.tasksService.createTask(body.name, body.cron, body.data);
  }
}

取消定时任务

使用 TasksService 取消定时任务：

// tasks.service.ts

import { Injectable } from '@nestjs/common';
import { Queue } from 'bull';

@Injectable()
export class TasksService {
  private readonly queue: Queue;

  constructor() {
    this.queue = new Queue('tasks', {
      redis: {
        host: 'localhost',
        port: 6379,
      },
    });
  }

  async cancelTask(id: string): Promise<void> {
    await this.queue.getJob(id).remove();
  }
}