SpringBoot中使用@Scheduled提供定时任务
依赖
添加web依赖即可
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
开启定时任务
@SpringBootApplication
@EnableScheduling //表示开启定时任务
public class SpringScheduleApplication {
public static void main(String[] args) {
SpringApplication.run(SpringScheduleApplication.class, args);
}
}
编写定时任务
@Component
public class MySchedule {
@Scheduled(fixedDelay = 5000)//代表上一次执行完毕 5秒后在执行
public void fixedDelay() {
System.out.println("上一次执行完毕:"+ new Date());
}
@Scheduled(fixedRate = 2000)//上一次开始执行时间点之后2秒再执行
public void rateDelay() {
System.out.println("上一次开始执行时间点之后:"+ new Date());
}
@Scheduled(initialDelay = 2000,fixedDelay = 5000)//第一次延迟启动2秒在执行,再按每次执行完后5秒执行
public void initialDelay() {
System.out.println("延迟启动:"+ new Date());
}
@Scheduled(cron = "0 * * * * ?")//cron表达式 表示每分钟执行一次
public void cornDelay() {
System.out.println("cron:"+ new Date());
}
}
关于@Scheduled
的参数
参数详解
cron
该参数接收一个cron表达式
,cron表达式
是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义。
cron表达式语法
[秒] [分] [小时] [日] [月] [周] [年]
注:[年]不是必须的域,可以省略[年],则一共6个域
序号 | 说明 | 必填 | 允许填写的值 | 允许的通配符 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | , - * / |
2 | 分 | 是 | 0-59 | , - * / |
3 | 时 | 是 | 0-23 | , - * / |
4 | 日 | 是 | 1-31 | , - * ? / L W |
5 | 月 | 是 | 1-12 / JAN-DEC | , - * / |
6 | 周 | 是 | 1-7 or SUN-SAT | , - * ? / L # |
7 | 年 | 否 | 1970-2099 | , - * / |
通配符说明:
*
表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。?
表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作,但不关心是周几,所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?-
表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。,
表示指定多个值,例如在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发/
用于递增触发。如在秒上面设置”5/15” 表示从5秒开始,每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始,每隔三天触发一次。L
表示最后的意思。在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六,相当于”7”或”SAT”。如果在”L”前加上数字,则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”W
表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”,表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,”W”前只能设置具体的数字,不允许区间”-“)。#
序号(表示每月的第几个周几),例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六,则不会触发该配置(用在母亲节和父亲节再合适不过了) ;小提示:’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发;周字段的设置,若使用英文字母是不区分大小写的,即MON与mon相同。
示例
每隔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 * * ?
zone
时区,接收一个java.util.TimeZone#ID
。cron表达式
会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai
。该字段我们一般留空。
fixedDelay
上一次执行完毕时间点之后多长时间再执行。如:
@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行
fixedRate
上一次开始执行时间点之后多长时间再执行。如:
@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行
initialDelay
第一次延迟多长时间后再执行。如:
@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次
XXXXXString
与 相应的 XXXXX 具有相同的功能,只是支持占位符
如:
@Scheduled(fixedDelayString = "${time.fixedDelay}")
@Schedules注解的作用
可以实现多种规则作用与同一任务
如:
@Schedules({
@Scheduled(cron="25 43 15 * * ? "),
@Scheduled(cron="10 43 15 * * ? "),
@Scheduled(cron="40 43 15 * * ? "),
})
自定义定时任务线程池
在Spring中,你可以通过配置来自定义Scheduled注解使用的线程池。以下是如何配置自定义线程池的步骤和示例代码:
创建一个配置类,使用@Configuration注解标注它,并使用@EnableScheduling开启调度功能。
创建一个线程池的Bean,使用ThreadPoolTaskScheduler。
使用@SchedulingConfigurer接口来配置调度器使用自定义线程池。
下面是一个配置自定义Scheduled线程池的示例代码:
@Configuration
@EnableScheduling
public class SchedulerConfig implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.setScheduler(taskExecutor());
}
@Bean(destroyMethod="shutdown")
public ThreadPoolTaskScheduler taskExecutor() {
ThreadPoolTaskScheduler executor = new ThreadPoolTaskScheduler();
executor.setPoolSize(10); // 设置线程池大小
executor.setThreadNamePrefix("my-scheduled-task-"); // 设置线程名前缀
executor.initialize();
return executor;
}
}
在这个配置中,我们定义了一个名为taskExecutor的Bean,它创建了一个ThreadPoolTaskScheduler实例,并设置了线程池的大小和线程名前缀。然后在configureTasks方法中,我们通过调用setScheduler将这个自定义的线程池应用到调度器中。
这样,所有使用@Scheduled注解的方法都会在这个自定义线程池中执行,而不是使用默认的线程池。