玩转SpringBoot之定时任务
玩转SpringBoot之定时任务
使用SpringBoot创建定时任务非常简单，目前主要有以下三种创建方式：
- 一、基于注解 (@Scheduled)
- 二、基于接口（SchedulingConfigurer） 前者相信大家都很熟悉，但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务，这时候基于接口的定时任务就派上用场了。
- 三、基于注解设定多线程定时任务
一、静态：基于注解
基于注解
@Scheduled默认为单线程，开启多个任务时，任务的执行时机会受上一个任务执行时间的影响。(串行)
1、创建定时器
使用SpringBoot基于注解来创建定时任务非常简单，只需几行代码便可完成。 代码如下：
/**
* @author : look-word
* 2022-09-28 10:47
* @Configuration 1.主要用于标记配置类，兼备Component的效果。
* @EnableScheduling 2.开启定时任务
**/
@Configuration
@EnableScheduling
@Slf4j
public class StaticScheduleTask {
/**
* @Scheduled-cron : 指定定时任务的执行时间
* 或直接指定时间间隔，例如：5秒
* @Scheduled(fixedRate=5000)
*/
@Scheduled(cron = "0/5 * * * * ?")
private void configureTask() {
log.info("执行静态定时任务时间: {}", 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）
@Scheduled：除了支持灵活的参数表达式cron之外，还支持简单的延时操作，例如 fixedDelay ，fixedRate 填写相应的毫秒数即可。
Cron示例
每隔5秒执行一次：*/5 * * * * ?
每隔1分钟执行一次：0 */1 * * * ?
每天23点执行一次：0 0 23 * * ?
每天凌晨1点执行一次：0 0 1 * * ?
每月1号凌晨1点执行一次：0 0 1 1 * ?
每月最后一天23点执行一次：0 0 23 L * ?
每周星期天凌晨1点实行一次：0 0 1 ? * L
在26分、29分、33分执行一次：0 26,29,33 * * * ?
每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?
2、启动测试
启动应用，可以看到控制台打印出如下信息：
显然，使用@Scheduled 注解很方便，但缺点是当我们调整了执行周期的时候，需要
重启应用才能生效，这多少有些不方便。为了达到实时生效的效果，可以使用接口来完成定时任务。
二、动态：基于接口
基于接口（SchedulingConfigurer）
1、导入依赖
<parent>
<artifactId>spring-boot-parent</artifactId>
<groupId>org.springframework.boot</groupId>
<version>2.5.0</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
2、编写Cron配置文件
路径：/resources/task-config.ini
printTime.cron=*/10 * * * * ?
3、配置定时器
这里没有使用Lambda表达式。会得大佬可以自行修改。需要照顾初学者
/**
* 定时任务
*
* @author : look-word
* 2022-09-27 22:57
* @PropertySource 标记属性来源
* @EnableScheduling 开启定时任务
**/
@Data
@Slf4j
@Component
@PropertySource("classpath:/task-config.ini")
@EnableScheduling
public class ScheduleTask implements SchedulingConfigurer {
/**
* 获取PropertySource 读取的内容并注入到属性中
*/
@Value("${printTime.cron}")
private String cron;
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// 动态使用cron表达式设置循环间隔
taskRegistrar.addTriggerTask(new Runnable() {
@Override
public void run() {
log.info("Current time: {}", LocalDateTime.now());
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// 使用CronTrigger触发器，可动态修改cron表达式来操作循环规则
CronTrigger cronTrigger = new CronTrigger(cron);
Date nextExecutionTime = cronTrigger.nextExecutionTime(triggerContext);
return nextExecutionTime;
}
});
}
}
4、启动测试
启动应用后，查看控制台，打印时间是我们预期的每10秒一次：
我们需要的是让这个Cron时间，可以动态更新。提供下面几种思路：
- 编写Controller，动态传入参数，更新定时器执行时间。
- 在数据库中存储定Cron，每次执行从数据库获取。
- 在微服务项目，用Nacos动态更新配置文件的内容
下文将使用第一种Controller的方式，实现Cron的更新。
/**
*
* @author jiejie
* @date 2022/09/27
*/
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
@Resource
private ScheduleTask scheduleTask;
@GetMapping("/updateCron")
public String updateCron(String cron) {
log.info("new cron :{}", cron);
scheduleTask.setCron(cron);
return "ok";
}
}
然后启动访问：http://localhost:8080/test/updateCron?cron=*/1 * * * * ?
注意： 如果在修改时格式出现错误，则定时任务会停止，即使重新修改正确；此时只能重新启动项目才能恢复。
三、多线程定时任务
1、创建多线程定时任务
任务一：间隔1秒执行一次
任务二：间隔2秒执行一次
这里也可以使用Cron格式指定
/**
* 多线程调度任务
*
* @author jiejie
* @EnableScheduling 开启定时任务
* @EnableAsync 开启多线程
* @Component 标记为Spring容器所管理的bean
*/
@Component
@EnableScheduling
@EnableAsync
@Slf4j
public class MultiThreadScheduleTask {
/**
* fixedDelay = 间隔1秒
*/
@Scheduled(fixedDelay = 1000)
@Async
public void first() throws InterruptedException {
log.info("第一个定时任务开始时间 :{} \t线程 : {}",
LocalDateTime.now().toLocalTime(),
Thread.currentThread().getName());
Thread.sleep(1000L * 10);
}
@Async
@Scheduled(fixedDelay = 2000)
public void second() {
log.info("第二个定时任务开始时间 :{} \t线程 : {}",
LocalDateTime.now().toLocalTime(),
Thread.currentThread().getName());
}
}
注： 这里的@Async注解很关键
2、启动测试
启动应用后，查看控制台：
从控制台可以看出，第一个定时任务和第二个定时任务互不影响；
并且，由于开启了多线程，第一个任务的执行时间也不受其本身执行时间的限制，所以需要注意可能会出现重复操作导致数据异常。
