Spring Task定时任务框架的使用

一、介绍

Spring Task是Spring框架提供的任务调度工具，是一个定时任务框架，可以按照约定的时间自动执行某个代码逻辑。

二、入门案例

package com.sky.task;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.util.Date;

@Component
public class MyTask {

    /**
     * 定时任务 每隔5秒触发一次
     */
    @Scheduled(cron = "0/5 * * * * ?")
    public void executeTask() {
        System.out.println("定时任务开始执行：" + new Date());
    }
}

 控制台输出如下所示：

 三、cron表达式

1.介绍

cron表达式其实就是一个字符串，通过cron表达式可以定义任务触发的时间

 2.构成规则

cron表达式分为6或7个域，由空格分隔开，每个域代表不同的含义

每个域的含义分别为：秒、分钟、小时、日、月、周、年(可选)

这里给出一个例子帮助理解：

2022年10月12日上午9点整 对应的cron表达式为：0 0 9 12 10 ? 2022

注意："日"对应的域和"周"对应的域不能同时定义，当定义其中一个时，另一个就要定义为"?"

3.cron表达式在线生成器

由于cron表达式中还有其他的特殊字符表示不同含义，记忆起来比较麻烦，所以推荐使用网站自动生成，这里给出一个在线生成网站：

cron表达式在线生成器

网站打开后如下图所示：

同时这个网站还给出了一些常用的cron表达式，如下图所示：

四、在Spring Boot项目中的使用步骤

1.导入Maven坐标

由于SpringTask框架非常的小，其相关的API全部集成在了spring-context包里，而当我们引入spring-boot-starter依赖时，spring-context依赖就已经被传递进来了，所以我们无需导入新的Maven坐标。依赖关系如下图所示

2.开启任务调度

在启动类上添加@EnableScheduling开启任务调度，如下图所示

3.自定义定时任务类

定义一个类编写自己的业务逻辑，这里定义一个MyTask类，每隔5秒输出一次日志

package com.sky.task;

import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.util.Date;

@Component
@Slf4j
public class MyTask {

    /**
     * 定时任务 每隔5秒触发一次
     */
    @Scheduled(cron = "0/5 * * * * ?")
    public void executeTask() {
        log.info("定时任务开始执行：" + new Date());
        /**
         * 具体的业务逻辑代码
         */
    }
}