Spring Boot动态设置定时任务

本文介绍: Spr in g Bo o t 动态设置定时任务

spring boot 项目实现定时任务，最简单的一种就是基于注解@Sch e d ul e的方式，在启动类上添加@EnableSch e d ul in g注解进行标注，就可实现。但是，这个方式有个缺点，那就是执行周期写死在代码里，无法动态改变，想要改变只能修改代码再重新部署启动。为了能够动态的设置定时任务，为此在网上搜索学习后，特此记录。

第一个小demo：

1、新建一个 springboot 项目，导入依赖

    &lt;dependencies&gt;
		&lt;dependency&gt;
			&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
			<artifactId&gt;spring-boot-starter-web</artifactId&gt;
		</dependency&gt;
		<dependency&gt;
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
	</dependencies>

2、在启动类上添加@EnableSch edul ing注解

@EnableScheduling	//开启定时任务
@SpringBootApplication
public class TaskDemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(TaskDemoApplication.class, args);
		System.out.println("(*^▽^*)启动成功!!!(〃'▽'〃)");
	}

}

3、配置 yml，只定义了一个端口号（端口号随意，没有被占用就行）

server:
  port: 8099

4、创建定时任务执行时间的配置文件：task–config.ini（这一步也可以直接省略，在yml中配置），设置 cron 表达式

printTime.cron=0/10 * * * * ?

5、定时任务执行类

/**
 * 定时任务执行类
 */
@Data
@Slf4j
@Component
@PropertySource("classpath:/task-config.ini")
public class ScheduleTask implements SchedulingConfigurer {

    //方式一：
    //----------方式一从这开始----------
    @Value("${printTime.cron}")
    private String cron;

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //动态使用cron表达式设置循环间隔
        taskRegistrar.addTriggerTask(new Runnable() {
            @Override
            public void run() {
                String s = "任务循环执行中。。。。。。";
                log.info("Current time: {}", LocalDateTime.now() + "---->" + s);
            }
        }, new Trigger() {
            @Override
            public Date nextExecutionTime(TriggerContext triggerContext) {
                //使用CronTrigger触发器，可动态修改cron表达式来操作循环规则
                CronTrigger cronTrigger = new CronTrigger(cron);
                Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
                return nextExecutionTime;
            }
        });

    }
    //----------方式一到这结束----------
}

6、编写一个接口，可以通过接口动态修改定时任务的执行时间

@Slf4j
@RestController
@RequestMapping("/")
public class TaskController {

    private final ScheduleTask scheduleTask;

    @Autowired
    public TaskController(ScheduleTask scheduleTask) {
        this.scheduleTask = scheduleTask;
    }

    //方式一
    @GetMapping("/updateCron")
    public String updateCron(String cron){
        log.info("new cron :{}",cron);
        scheduleTask.setCron(cron);
        return "ok";
    }

    //方式二
//    @GetMapping("/updateTimer")
//    public String updateTimer(Long timer){
//        log.info("new timer :{}",timer);
//        scheduleTask.setTimer(timer);
//        return "ok";
//    }
}

7、启动项目，查看执行结果（每10秒执行一次）

8、通过访问接口，传入请求参数cron表达式，设置定时任务时间为每15秒执行一次

查看结果

搞定！

cron表达式参考配置：

*/5 * * * * ? 每隔5秒执行一次
 0 */1 * * * ? 每隔1分钟执行一次
 0 0 5-15 * * ? 每天5-15点整点触发
 0 0/3 * * * ? 每三分钟触发一次
 0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发 
 0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发
 0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
 0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
 0 0 10,14,16 * * ? 每天上午10点，下午2点，4点 
 
 0 0 12 ? * WED 表示每个星期三中午12点
 0 0 17 ? * TUES,THUR,SAT 每周二、四、六下午五点
 0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发 
 0 15 10 ? * MON-FRI 周一至周五的上午10:15触发
 0 0 23 L * ? 每月最后一天23点执行一次
 0 15 10 L * ? 每月最后一日的上午10:15触发 
 0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发 
 0 15 10 * * ? 2005 2005年的每天上午10:15触发 
 0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发 
 0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发


"30 * * * * ?" 每半分钟触发任务
"30 10 * * * ?" 每小时的10分30秒触发任务
"30 10 1 * * ?" 每天1点10分30秒触发任务
"30 10 1 20 * ?" 每月20号1点10分30秒触发任务
"30 10 1 20 10 ? *" 每年10月20号1点10分30秒触发任务
"30 10 1 20 10 ? 2011" 2011年10月20号1点10分30秒触发任务
"30 10 1 ? 10 * 2011" 2011年10月每天1点10分30秒触发任务
"30 10 1 ? 10 SUN 2011" 2011年10月每周日1点10分30秒触发任务
"15,30,45 * * * * ?" 每15秒，30秒，45秒时触发任务
"15-45 * * * * ?" 15到45秒内，每秒都触发任务
"15/5 * * * * ?" 每分钟的每15秒开始触发，每隔5秒触发一次
"15-30/5 * * * * ?" 每分钟的15秒到30秒之间开始触发，每隔5秒触发一次
"0 0/3 * * * ?" 每小时的第0分0秒开始，每三分钟触发一次
"0 15 10 ? * MON-FRI" 星期一到星期五的10点15分0秒触发任务
"0 15 10 L * ?" 每个月最后一天的10点15分0秒触发任务
"0 15 10 LW * ?" 每个月最后一个工作日的10点15分0秒触发任务
"0 15 10 ? * 5L" 每个月最后一个星期四的10点15分0秒触发任务
"0 15 10 ? * 5#3" 每个月第三周的星期四的10点15分0秒触发任务

也可直接面向百度！

除了上面的借助cron表达式的方法，还有另一种触发器，区别于CronTrigger触发器，该触发器可随意设置循环间隔时间，不像cron表达式只能定义小于等于间隔59秒。

第二个小demo（在原有的基础上进行操作）：

1、定时任务执行类

/**
 * 定时任务执行类
 */
@Data
@Slf4j
@Component
@PropertySource("classpath:/task-config.ini")
public class ScheduleTask implements SchedulingConfigurer {

    @Value("${printTime.cron}")
    private String cron;

    //方式一：
    //----------方式一从这开始----------
    /*@Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //动态使用cron表达式设置循环间隔
        taskRegistrar.addTriggerTask(new Runnable() {
            @Override
            public void run() {
                String s = "任务循环执行中。。。。。。";
                log.info("Current time: {}", LocalDateTime.now() + "---->" + s);
            }
        }, new Trigger() {
            @Override
            public Date nextExecutionTime(TriggerContext triggerContext) {
                //使用CronTrigger触发器，可动态修改cron表达式来操作循环规则
                CronTrigger cronTrigger = new CronTrigger(cron);
                Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
                return nextExecutionTime;
            }
        });
    }*/
    //----------方式一到这结束----------


    //方式二：
    //----------方式二从这开始----------
    private Long timer = 10000L;

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //动态使用cron表达式设置循环间隔
        taskRegistrar.addTriggerTask(new Runnable() {
            @Override
            public void run() {
                String s = "任务循环执行中。。。。。。";
                log.info("Current time: {}", LocalDateTime.now() + "---->" + s);
            }
        }, new Trigger() {
            @Override
            public Date nextExecutionTime(TriggerContext triggerContext) {
                //使用CronTrigger触发器，可动态修改cron表达式来操作循环规则
//                CronTrigger cronTrigger = new CronTrigger(cron);
//                Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);

                //使用不同的触发器，为设置循环时间的关键，区别于CronTrigger触发器，该触发器可随意设置循环间隔时间，单位为毫秒
                PeriodicTrigger periodicTrigger = new PeriodicTrigger(timer);
                Date nextExecutionTime = periodicTrigger.nextExecutionTime(triggerContext);
                return nextExecutionTime;
            }
        });

    }
    //----------方式二到这结束----------
}

2、增加一个修改时间的接口

@Slf4j
@RestController
@RequestMapping("/")
public class TaskController {

    private final ScheduleTask scheduleTask;

    @Autowired
    public TaskController(ScheduleTask scheduleTask) {
        this.scheduleTask = scheduleTask;
    }

    //方式一
//    @GetMapping("/updateCron")
//    public String updateCron(String cron){
//        log.info("new cron :{}",cron);
//        scheduleTask.setCron(cron);
//        return "ok";
//    }

    //方式二
    @GetMapping("/updateTimer")
    public String updateTimer(Long timer){
        log.info("new timer :{}",timer);
        scheduleTask.setTimer(timer);
        return "ok";
    }
}