目录
序言
使用SpringBoot创建定时任务非常简单，目前主要有以下三种创建方式：
- 一、基于注解(@Scheduled)
- 二、基于接口（SchedulingConfigurer），实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务。
- 三、基于注解设定多线程定时任务
一、静态：基于注解
基于注解@Scheduled实现，默认为单线程，开启多个任务时，任务的执行时机会受上一个任务执行时间的影响。
最基本的配置方法，而且这样配置定时任务是单线程串行执行的，也就是说每次只能有一个定时任务可以执行，可以试着声明两个方法，在方法内写一个死循环，会发现一直卡在一个任务上不动，另一个也没有执行。
实现一：
1、启动类
添加@EnableScheduling开启对定时任务的支持
@EnableScheduling
@SpringBootApplication
public class TestScheduledApplication extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(this.getClass());
}
public static void main(String[] args) {
new SpringApplicationBuilder(TestScheduledApplication.class).web(true).run(args);
}
}2、配置执行定时任务的类
添加@Component扫描本类，在方法上添加@Scheduled注解声明定时任务，配置时间周期
@Component
public class TestTask1 {
private static final Logger logger = LogManager.getLogger();
// 间隔1秒执行一次
@Scheduled(cron = "0/1 * * * * ?")
public void method1() {
logger.info("——————————method1 start——————————");
logger.info("——————————method1 end——————————");
}
}实现二：
除了上面在启动类开启定时任务外，也可以单独在定时任务的类上开启定时任务，代码如下：
@Configuration //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling // 2.开启定时任务
public class SaticScheduleTask {
//3.添加定时任务
@Scheduled(cron = "0/5 * * * * ?")
//或直接指定时间间隔，例如：5秒
//@Scheduled(fixedRate=5000)
private void configureTasks() {
System.err.println("执行静态定时任务时间: " + 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）
- 年份（1970－2099）
其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?。
@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 * * ?有些子表达式能包含一些范围或列表
例如：子表达式（天（星期））可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”
“*”字符代表所有可能的值
因此，“*”在子表达式（月）里表示每个月的含义，“*”在子表达式（天（星期））表示星期的每一天。
“/”字符用来指定数值的增量
例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟。
在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样。
“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值
当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”
“L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写
但是它在两个子表达式里的含义是不同的。
在天（月）子表达式中，“L”表示一个月的最后一天
在天（星期）自表达式中，“L”表示一个星期的最后一天，也就是SAT
如果在“L”前有具体的内容，它就具有其他的含义了
例如：“6L”表示这个月的倒数第６天，“ＦＲＩＬ”表示这个月的最一个星期五
注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题
| 字段 | 允许值 | 允许的特殊字符 | ||
秒 | 0-59 | , - * / | ||
分 | 0-59 | , - * / | ||
小时 | 0-23 | , - * / | ||
日期 | 1-31 | , - * ? / L W C | ||
月份 | 1-12 或者 JAN-DEC | , - * / | ||
星期 | 1-7 或者 SUN-SAT | , - * ? / L C # | ||
年（可选） | 留空, 1970-2099 | , - * / |
大家可以在这个网站进行GUI式设置
https://www.bejson.com/othertools/cron/
显然，使用@Scheduled 注解很方便，但缺点是当我们调整了执行周期的时候，需要重启应用才能生效，这多少有些不方便。为了达到实时生效的效果，可以使用接口来完成定时任务。
二、动态：基于接口
基于接口（SchedulingConfigurer）
1、导入依赖包：
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<version>2.0.4.RELEASE</version>
</parent>
<dependencies>
<dependency><!--添加Web依赖 -->
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency><!--添加MySql依赖 -->
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency><!--添加Mybatis依赖 配置mybatis的一些初始化的东西-->
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.1</version>
</dependency>
<dependency><!-- 添加mybatis依赖 -->
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
<scope>compile</scope>
</dependency>
</dependencies>2、添加数据库记录：
开启本地数据库mysql，随便打开查询窗口，然后执行脚本内容，如下：
DROP DATABASE IF EXISTS `socks`;
CREATE DATABASE `socks`;
USE `SOCKS`;
DROP TABLE IF EXISTS `cron`;
CREATE TABLE `cron` (
`cron_id` varchar(30) NOT NULL PRIMARY KEY,
`cron` varchar(30) NOT NULL
);
INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');
然后在项目中的application.yml 添加数据源：
spring:
datasource:
url: jdbc:mysql://localhost:3306/socks
username: root
password: 1234563、创建定时器
数据库准备好数据之后，我们编写定时任务，注意这里添加的是TriggerTask，目的是循环读取我们在数据库设置好的执行周期，以及执行相关定时任务的内容。
具体代码如下：
@Configuration //1.主要用于标记配置类，兼备Component的效果。
@EnableScheduling // 2.开启定时任务
public class DynamicScheduleTask implements SchedulingConfigurer {
@Mapper
public interface CronMapper {
@Select("select cron from cron limit 1")
public String getCron();
}
@Autowired //注入mapper
@SuppressWarnings("all")
CronMapper cronMapper;
/**
* 执行定时任务.
*/
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.addTriggerTask(
//1.添加任务内容(Runnable)
() -> System.out.println("执行动态定时任务: " + LocalDateTime.now().toLocalTime()),
//2.设置执行周期(Trigger)
triggerContext -> {
//2.1 从数据库获取执行周期
String cron = cronMapper.getCron();
//2.2 合法性校验.
if (StringUtils.isEmpty(cron)) {
// Omitted Code ..
}
//2.3 返回执行周期(Date)
return new CronTrigger(cron).nextExecutionTime(triggerContext);
}
);
}
}注意： 如果在数据库修改时格式出现错误，则定时任务会停止，即使重新修改正确；此时只能重新启动项目才能恢复。
三、多线程定时任务
基于注解设定多线程定时任务
配置线程池执行定时任务
因为有时候需要执行的定时任务会很多，如果是串行执行会带来一些问题，比如一个很耗时的任务阻塞住了，一些需要短周期循环执行的任务也会卡住，所以可以配置一个线程池来并行执行定时任务
1、配置线程池
添加@EnableAsync开启对异步的支持
@Configuration
@EnableAsync
public class ExecutorConfig {
@Bean
public Executor executor1() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setThreadNamePrefix("test-schedule2-");
executor.setMaxPoolSize(20);
executor.setCorePoolSize(15);
executor.setQueueCapacity(0);
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
}2、配置定时任务异步执行
添加@Async注解，表示该定时任务是异步执行的，因为上面线程池配置了名字，所以可以看到打印的日志是该线程池中的线程在执行任务，如果没有配置线程池的话会默认使用SimpleAsyncTaskExecutor，这个异步执行器每次都会开启一个子线程执行，性能消耗比较大，所以最好是自己配置线程池
@Async
@Scheduled(cron = "0/1 * * * * ?")
public void method1() {
logger.info("——————————method1 start——————————");
logger.info("——————————method1 end——————————");
}配置多个线程池分别执行不同的定时任务
因为有些定时任务是比较重要的，有些则是不太重要的，想把定时任务分别放到不同的线程池中，也是可以实现的。
1、配置多个线程池
分别配置两个线程池
@Configuration
@EnableAsync
public class ExecutorConfig1 {
@Bean
public Executor executor1() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setThreadNamePrefix("test-schedule1-");
executor.setMaxPoolSize(20);
executor.setCorePoolSize(15);
executor.setQueueCapacity(0);
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
@Bean
public Executor executor2() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setThreadNamePrefix("test-schedule2-");
executor.setMaxPoolSize(20);
executor.setCorePoolSize(15);
executor.setQueueCapacity(0);
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
}2、定时任务显示指定调用线程池
因为上面在配置类里面初始化了两个线程池，所以会有两个线程池分别叫executor1和executor1被生成放到容器中，因为@Bean注解生成的对象默认就是和方法名相同的名字，而@Async注解是可以指定使用哪个线程池的。这样就可以在不同的线程池中执行不同的定时任务了
// 间隔1秒执行一次
@Async("executor1")
@Scheduled(cron = "0/1 * * * * ?")
public void method1() {
logger.info("——————————method1 start——————————");
logger.info("——————————method1 end——————————");
}
// 间隔1秒执行一次
@Scheduled(cron = "0/1 * * * * ?")
@Async("executor2")
public void method2() {
logger.info("——————————method2 start——————————");
logger.info("——————————method2 end——————————");
}注意：
- 没有配置自己的线程池时，会默认使用SimpleAsyncTaskExecutor。
- 如果项目中只配置了一个线程池，那么不需要显示指定使用这个线程池，spring也会自动使用用户配置的线程池，但是如果配置了多个就必须要显示指定，否则还是会使用默认的。
- 如果想要指定使用哪个线程池，可以使用@Async("executor2")显示指定。
- 由于开启了多线程，任务的执行时间也不受其本身执行时间的限制，所以需要注意可能会出现重复操作导致数据异常。
扫一扫
250
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
