@Scheduled 定时任务总结
@Scheduled
作用：spring定时器(定时执行一次或定时轮询执行一段代码)
使用场景：注解在方法上
参数说明：常用参数
一、@Scheduled 参数说明
1、Long fixedDelay：定时任务每隔多久执行一次，单位是毫秒，上一次任务结束后开始计算下次执行的时间。
例子：@Scheduled(fixedDelay = 1000 * 10) //10秒发送一次
······················scheduled1开始执行·······················2018-07-27 14:00:00
······················scheduled1结束执行·······················2018-07-27 14:00:05
······················scheduled2开始执行·······················2018-07-27 14:00:15
······················scheduled2结束执行·······················2018-07-27 14:00:20
······················scheduled3开始执行·······················2018-07-27 14:00:30
······················scheduled3结束执行·······················2018-07-27 14:00:35
2、Long fixedRate：与fixedDelay一样表示定时任务的执行时间间隔，不同的是fixedRate的不会受到上一次任务结束时间的影响
例子：@Scheduled(fixedRate = 1000 * 10) //10秒发送一次
······················scheduled1开始执行·······················2018-07-27 14:00:00
······················scheduled1结束执行·······················2018-07-27 14:00:05
······················scheduled2开始执行·······················2018-07-27 14:00:10
······················scheduled2结束执行·······················2018-07-27 14:00:15
······················scheduled3开始执行·······················2018-07-27 14:00:20
······················scheduled3结束执行·······················2018-07-27 14:00:25
Long initialDelay：项目启动后不马上执行定时器，根据initialDelay的值延时执行。
3 、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 * * ?
二、拓展
1.定时器的参数有两种写法是用cron表达式，或者使用fixedDelay、fixedRate等参数直接配置
需要注意的是 使用cron表达式的方法，在项目首次启动后不会直接运行，而是等到执行周期才会执行
而使用第二种方式的定时器方法，在项目启动成功后会马上开始执行一次，再按照时间周期执行。
测试说明：
使用第一种配置方式，项目启动后方法不会执行，而是等到执行周期到了才会执行方法
使用第二种参数方式的方法，项目启动成功后马上执行了一次
2.定时器默认为单线程，所以如果项目中使用多个定时器要配置线程池
原理：
ScheduledAnnotationBeanPostProcessor的postProcessAfterInitialization方法将@Scheduled的方法包装为指定的task添加到ScheduledTaskRegistrar中
ScheduledAnnotationBeanPostProcessor会监听Spring的容器初始化事件，在Spring容器初始化完成后进行TaskScheduler实现类实例的查找，若发现有SchedulingConfigurer的实现类实例，则跳过3
查找TaskScheduler的实现类实例默认是通过类型查找，若有多个实现则会查找名字为"taskScheduler"的实现Bean，若没有找到则在 ScheduledTaskRegistrar调度任务的时候会创建一个newSingleThreadScheduledExecutor，将TaskScheduler的实现类实例设置到ScheduledTaskRegistrar属性中
ScheduledTaskRegistrar的scheduleTasks方法触发任务调度
真正调度任务的类是TaskScheduler实现类中的ScheduledExecutorService，由J.U.C提供
注意这里的@EnableScheduling，使用它来开启定时器注解
@Configuration
@EnableScheduling
public class SchedulingConfig implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.setScheduler(taskExecutor());
}
@Bean(destroyMethod="shutdown")
public Executor taskExecutor() {
return Executors.newScheduledThreadPool(5 ,new ThreadFactory() {
private final AtomicLong counter = new AtomicLong();
@Override
public Thread newThread(Runnable r) {
Thread thread = new Thread(r);
thread.setName("test-scheduler-" + counter.incrementAndGet());
return thread;
}
});
}
}
@Configuration
public class SchedulerConfig implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.setTaskScheduler(threadPoolTaskScheduler());
}
@Bean(destroyMethod = "shutdown")
public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
scheduler.setThreadNamePrefix("poolmary&mark");
scheduler.setPoolSize(50);
return scheduler;
}
}
三 、springboot如何使用
首先，在项目启动类上添加 @EnableScheduling 注解，开启对定时任务的支持
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@EnableScheduling
public class DemoSpringBootScheduledApplication {
public static void main(String[] args) {
SpringApplication.run(DemoSpringBootScheduledApplication.class, args);
}
}
其次，编写定时任务类和方法，定时任务类通过 Spring IOC 加载，使用 @Component 注解（当然也可以使用 @Controller 和 @Service 等其他与 @Component 作用相同的注解），定时方法使用 @Scheduled 注解。
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
@Component
public class ScheduledTask {
@Scheduled(fixedRate = 3000)
public void scheduledTask() {
System.out.println("Task executed at " + LocalDateTime.now());
}
}
注意以上代码使用了 @Scheduled 的 fixedRate 属性，fixedRate 是 long 类型，表示任务执行的间隔毫秒数，以上代码中的定时任务每 3 秒执行一次。
