SpringBoot(十二) 定时任务

定时任务非常简单,主要有两种创建方式:一、基于注解(@Scheduled) 二、基于接口(SchedulingConfigurer)。 前者相信大家都很熟悉,但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务,这时候基于接口的定时任务就大派用场了。

在线Cron表达式生成器

在线Cron表达式生成器

静态定时任务(基于注解)

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

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

创建定时器

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/**
* @author Ray
* @date 2018/7/27 0027
*/
@Configuration // 标记配置类
@EnableScheduling // 开启定时任务
public class SimpleScheduledConfig {

/**
* 添加定时任务
*/
@Scheduled(cron = "0/5 * * * * ?") // 0/5表示每5秒
private void configureTasks(){
System.out.println("执行定时任务: " + LocalDateTime.now());
}
}

缺点

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

动态定时任务(基于接口)

为了演示效果,这里选用 Mysql 和 Mybatis 来查询和调整定时任务的执行周期,然后观察定时任务的执行情况。

添加依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<!--依赖管理 -->
<dependencies>
<dependency><!--添加Web依赖 -->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency><!--添加Mybatis依赖 -->
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>

<dependency><!--添加MySql依赖 -->
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency><!--添加Test依赖 -->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

脚本初始化

1
2
3
4
5
6
7
8
9
DROP DATABASE IF EXISTS `socks`;
CREATE DATABASE `socks`;
USE `SOCKS`;
DROP TABLE IF EXISTS `cron`;
CREATE TABLE `cron` (
`cron_id` varchar(30),
`cron` varchar(30)
);
INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');

application.yml

添加数据源,SpringBoot 默认使用 hikari 连接池

1
2
3
4
5
spring:
datasource:
url: jdbc:mysql://localhost:3306/socks
username: root
password: root

创建定时器

注意:这里添加的是 TriggerTask ,目的是循环读取我们在数据库设置好的执行周期,以及执行相关定时任务的内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/**
* @author Ray
* @date 2018/7/27 0027
*/
@Configuration
@EnableScheduling
public class CompleteScheduleConfig implements SchedulingConfigurer {

@Mapper
public interface CronMapper{
@Select("select cron from cron limit 1")
String getCron();
}

@Autowired
@SuppressWarnings("all")
CronMapper cronMapper;

/**
* 执行定期任务
*/
@Override
public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
scheduledTaskRegistrar.addTriggerTask(
//1.添加任务内容(Runnable)
() -> System.out.println("执行定时任务2: " + LocalDateTime.now().toLocalTime()),
//2.设置执行周期(Trigger)
triggerContext -> {
//2.1 从数据库获取执行周期
String cron = cronMapper.getCron();
//2.2 合法性校验.
if(StringUtils.isEmpty(cron)){

}
//2.3 返回执行周期(Date)
return new CronTrigger(cron).nextExecutionTime(triggerContext);
}
);
}
}

动态修改执行周期

启动应用后,查看控制台,打印时间是我们预期的每5秒一次:

然后打开Navicat ,将执行周期修改为每1秒执行一次,如图:

查看控制台,发现执行周期已经改变,并且不需要我们重启应用,十分方便。如图:

cron 属性说明

这是一个时间表达式,可以通过简单的配置就能完成各种时间的配置,我们通过CRON表达式几乎可以完成任意的时间搭配

时间 表达式 范围
Seconds , - * / 0-59
Minutes , - * / 0-59
Hours , - * / 0-23
DayofMonth , - * / ? L W C 0-31
Month , - * / 1-12或JAN-DEC
DayofWeek , - * / ? L C # 1-7或SUN-SAT
Year , - * / 1970-2099

举例说明

-------------- 本文结束  感谢您的阅读 --------------