spring动态定时任务配置 spring动态添加定时任务

转载

架构设计师 2024-03-15 08:25:40

文章标签 spring动态定时任务配置 java mybatis 定时任务 spring 文章分类 架构后端开发

序言：创建定时任务非常简单，主要有两种创建方式：

基于注解(@Scheduled)
基于接口（SchedulingConfigurer）

前者相信大家都很熟悉，但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务，这时候基于接口的定时任务就大派用场了。

一、静态定时任务（基于注解）

基于注解来创建定时任务非常简单，只需几行代码便可完成。

@Scheduled 除了支持灵活的参数表达式cron之外，还支持简单的延时操作，例如 fixedDelay ，fixedRate 填写相应的毫秒数即可。

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;

import java.time.LocalDateTime;

@Configuration //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling // 2.开启定时任务，如果在XXXApplication类中添加了此注解这里可以不写
public class SimpleSchedule{
    //3.添加定时任务
    @Scheduled(cron = "0/2 * * * * ?")
    private void schedules() {
        System.err.println("执行定时任务1: " + LocalDateTime.now());
    }
}

Cron表达式参数分别表示：
秒（0~59） 例如0/5表示每5秒
分（0~59）
时（0~23）
月的某天（0~31） 需计算
月（0~11）
周几（ 可填1-7 或 SUN/MON/TUE/WED/THU/FRI/SAT）
second（秒），minute（分），hour（时），day of month（月），month,day of week（周几）
0 * * * * MON-FRI  周一到周五每一分钟启动一次
* * * * * MON-FRI  周一到周五每一分钟每一秒启动一次

启动应用，可以看到控制台的信息如下：

spring动态定时任务配置 spring动态添加定时任务_java

使用Scheduled 确实很方便，但缺点是当我们调整了执行周期的时候，需要重启应用才能生效，这多少有些不方便。为了达到实时生效的效果，可以使用接口来完成定时任务。

二、动态定时任务（基于接口）

这里选用 Mysql数据库和 Mybatis 来查询和调整定时任务的执行周期，然后观察定时任务的执行情况。

1.添加数据库记录

这里我已经在数据库中创建了一个表，内容和结构如下：

spring动态定时任务配置 spring动态添加定时任务_java_02

2.创建定时器

数据库准备好数据之后，我们编写定时任务，注意这里添加的是TriggerTask，目的是循环读取我们在数据库设置好的执行周期，以及执行相关定时任务的内容。具体代码如下：

import com.exam.service.ExamCronService;
import org.apache.commons.lang.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;

import java.time.LocalDateTime;

@Configuration //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling // 2.开启定时任务，如果在XXXApplication类中添加了此注解这里可以不写
public class CompleteSchedule implements SchedulingConfigurer {
    @Autowired
    ExamCronService examCronService; //注入从数据库查询cron的service

    /**
     * 执行定时任务.
     */
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.addTriggerTask(
                //1.添加任务内容(Runnable)
                () -> CompleteSchedule.startSchedule(),
                //2.设置执行周期(Trigger)
                triggerContext -> {
                    //2.1 从数据库获取执行周期
                    String cron = examCronService.LookExamCron(1);
                    //2.2 合法性校验.
                    if (StringUtils.isEmpty(cron)) {
                        // Omitted Code ..
                    }
                    //2.3 返回执行周期(Date)
                    return new CronTrigger(cron).nextExecutionTime(triggerContext);
                }
        );
    }
    public static void startSchedule(){
        System.out.println("执行动态定时任务: " + LocalDateTime.now().toLocalTime());
    }
}