nestjs开发小技巧——任务调度-灵析社区

养乐多一瓶

任务调度

在NestJS 中，调度（scheduling）是一种用于安排和执行任务的机制。它基于 cron 表达式，允许你按照给定的时间间隔或者特定日期时间来执行代码逻辑。

调度在许多应用场景中都非常有用，例如：

执行定时任务：使用调度功能，你可以按照设定的时间间隔自动执行一些任务，比如每隔一段时间清理数据库、导出报表、发送定期邮件等。这样可以减少手动干预，提高系统的自动化程度。
执行周期性任务：有时候我们需要定期执行一些任务，比如每天、每周或每月执行一次。调度功能可以帮助你基于日期和时间规则设定这些任务，并按照规定时间自动触发执行。
处理后台任务：通常，一些任务需要在后台运行，而不是在请求-响应循环中直接处理。调度功能可以帮助你创建后台任务，将它们添加到调度器中，然后在特定时间条件下自动触发执行。

开始使用

在 NestJS 中，可以使用 ScheduleMoudle模块来实现调度功能。该模块提供了一组装饰器和类，用于定义调度任务（schedule tasks）和调度器（schedulers）

项目所需依赖

pnpm i @nestjs/schedule
pnpm i @types/cron --save-dev

先在根模块中注册好schedule的静态方法

接着创建一个服务，里面来调我们的服务

可以看到它是在每分钟的第50秒开始调用，而且是每两秒调用一次

cron

我们来看看cron模式字符串的中的每个位置代表的含义

在 cron 模式字符串中，每个位置表示不同的时间单位和范围。字符串由空格分隔为 6 个字段，每个字段都表示特定时间单位的取值范围。以下是每个位置的含义：

秒（Seconds）：表示每分钟的秒数，取值范围是 0 到 59
分钟（Minutes）：表示每小时的分钟数，取值范围是 0 到 59
小时（Hours）：表示每天的小时数，取值范围是 0 到 23
日期（Day of month）：表示每月的日期数，取值范围是 1 到 31（但某些月份日期数可能会有所不同）
月份（Month）：表示一年中的月份，取值范围是 1 到 12，或者使用对应的缩写字符串来表示月份（如：JAN 表示一月，FEB 表示二月）
星期几（Day of week）：表示一周中的天数，取值范围是 0 到 7，其中 0 和 7 都表示周日，1 表示周一，以此类推。你也可以使用对应的缩写字符串来表示天数（如：SUN 表示周日，MON 表示周一）

此外，还可以在每个位置中使用特殊字符来表示不同的含义：

星号（*）：匹配该位置的任意值。例如，在分钟位置使用 * 表示每分钟都触发。
逗号（,）：用于指定多个取值。例如，表示取值为 1、3 和 5 的情况。1,3,5
连字符（-）：用于指定一个范围。例如，表示取值范围为 10 到 15。10-15
步长（/）：用于指定一个间隔值。例如，表示每隔 5 个单位触发一次。*/5

第一个位置可以不写,那么他就会按照后面设置的时间执行

举几个简单的例子

`cron模式`	执行时间
`* * * * * *`	每秒钟都执行
`45 * * * * *`	每1分钟的第 45 秒执行
`0 10 * * * *`	每小时的在第 10 分钟执行
`0 /30 9-17 * *`	每隔 30 分钟，在上午 9 点到下午 5 点之间的每个小时都触发
`0 30 11 * * 1-5`	周一至周五上午11：30

大家也可以去 Crontab.guru - The cron schedule expression editor 该网站上去练习体会一下

注意一下,这里只有5个数,第一个秒被省略了,做的时候注意一下

除此之外,nestjs还有它特有的调度的写法 CronExpression,其实也就是nestjs内置好了的写法，如果不想用cron标准方式的话可以用这种

这个意思就是每十秒调一次

Interval

nestjs特有的任务调度的方法, 声明方法以（定期）指定的间隔运行，在方法定义前面加上修饰器。将间隔值（以毫秒为单位的数字）传递给装饰器

比如我们这样就是每秒钟执行

总结

时间间隔以及CronExpression是nestjs有的, 调度在docker,k8s,操作系统中都有，遵循的是cron标准写法，所以推荐用cron字符串模式，不能满足条件的时候再用其他方式

项目实践

我前一篇文章写的那个项目就用到了定时任务，背景是这样，我在上传图片的时候因为我的图片是优先于我的用户先创建的，所以我给file的这个表里面的外键userId是为null, 在后面创建用户的时候，会再判断，然后更新userId, 但是有的图片，比如我上传了，但是我没有去创建用户，但是我这个图片已经传到文件服务器了，这个时候就出现了脏数据了，我们就需要定时清理这些脏数据。

 @Cron('0 0 0 * * *')
 async clearEmptyUserIdFiles(){
    const fileRecordToDelete = await this.prisma.file.findMany({
      where: {
        userId: null
      }
    })
    await this.prisma.$transaction(async(prisma) => {
       await Promise.all([
        fileRecordToDelete.map(record => {
          this.minioClient.removeObject(this.configService.get('bucket').name, record.fileName)
        }),
        prisma.file.deleteMany({
          where: {
            userId: null
          }
        })
         
       ])
    })
  }

在我的文件服务里面，我会每天00:00来清理那些userId为null的文件，因为要清理的不仅是是数据库里面也有minio里面的，所以我用了事务来保证提交的一致性。

阅读量：1016

点赞量：0

收藏量:0