定时任务是一种很常见的应用场景,springboot中的定时任务完全用的spring的那一套,用起来比较简单,需要注意的是线程池配置的那一块
使用 @EnableScheduling 注解就可以开启定时任务
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Import(SchedulingConfiguration.class) @Documented public @interface EnableScheduling { }
这个注解引用了 SchedulingConfiguration.class 类
@Configuration @Role(BeanDefinition.ROLE_INFRASTRUCTURE) public class SchedulingConfiguration { @Bean(name = TaskManagementConfigUtils.SCHEDULED_ANNOTATION_PROCESSOR_BEAN_NAME) @Role(BeanDefinition.ROLE_INFRASTRUCTURE) public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() { return new ScheduledAnnotationBeanPostProcessor(); } }
这个配置类也很简单,主要定义了 ScheduledAnnotationBeanPostProcessor 类型的ben,这个类的作用就是把标志了
@Scheduled(fixedDelay = 1*1000) 注解的方法收集起来,封装成一个个定时任务,再构造用于执行任务的线程池
@Component public class ScheduleOneTest { private static final Logger LOGGER = LoggerFactory.getLogger(ScheduleOneTest.class); @Scheduled(fixedDelay = 1*1000) public void doWork(){ LOGGER.info("任务一正在执行"); try { Thread.sleep( 5 * 60 * 1000); } catch (InterruptedException e) { e.printStackTrace(); } LOGGER.info("任务一执行结束"); }
需要注意的是,默认情况下,spring只构造了包含一个线程的线程池
ScheduledTaskRegistrar类 if (this.taskScheduler == null) { this.localExecutor = Executors.newSingleThreadScheduledExecutor(); this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor); }
所以如果我们有多个任务需要执行,实际上是不能并发执行的,因为只有一个工作线程
@Component public class ScheduleTwoTest { private static final Logger LOGGER = LoggerFactory.getLogger(ScheduleTwoTest.class); @Scheduled(fixedDelay = 1*1000) public void doWork(){ LOGGER.info("任务二正在执行"); try { Thread.sleep( 5 * 60 * 1000); } catch (InterruptedException e) { e.printStackTrace(); } LOGGER.info("任务二执行结束"); } }
像上面这样,两个一样的任务,同时只能执行一个,必须等一个执行完,另一个才会执行,那么我们如何为spring的定时任务提供包含多个线程的线程池呢?
@Configuration public class ScheduleConfig implements SchedulingConfigurer { @Override public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { // taskRegistrar.setTaskScheduler(poolTaskScheduler()); taskRegistrar.setScheduler(threadPoolTaskScheduler()); } @Bean(name = "taskScheduler", destroyMethod = "shutdown") public ScheduledThreadPoolExecutor threadPoolTaskScheduler(){ // ThreadPoolTaskScheduler poolTaskScheduler = new ThreadPoolTaskScheduler(); // poolTaskScheduler.setPoolSize(Runtime.getRuntime().availableProcessors() * 5); // return poolTaskScheduler; return new ScheduledThreadPoolExecutor(Runtime.getRuntime().availableProcessors() * 5); } }
看上面代码,实现 SchedulingConfigurer 接口,重写 configureTasks 方法,上面注释掉的代码和没注释掉的功能是一样的,需要注意的是,线程池的bean名称需要设置为 taskScheduler
public void setScheduler(Object scheduler) { Assert.notNull(scheduler, "Scheduler object must not be null"); if (scheduler instanceof TaskScheduler) { this.taskScheduler = (TaskScheduler) scheduler; } else if (scheduler instanceof ScheduledExecutorService) { this.taskScheduler = new ConcurrentTaskScheduler(((ScheduledExecutorService) scheduler)); } else { throw new IllegalArgumentException("Unsupported scheduler type: " + scheduler.getClass()); } }
这样就可以为spring的定时任务提供指定线程个数的线程池了,至于定时任务的用法,挺简单的,请参考其他资料
cron表达式详解:
一个cron表达式有至少6个(也可能7个)有空格分隔的时间元素。
按顺序依次为
1 秒(0~59)
2 分钟(0~59)
3 小时(0~23)
4 天(0~31)
5 月(0~11)
6 星期(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
7.年份(1970-2099)
其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?.
0 0 10,14,16 * * ? 每天上午10点,下午2点,4点
0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
0 0 12 ? * WED 表示每个星期三中午12点
"0 0 12 * * ?" 每天中午12点触发
"0 15 10 ? * *" 每天上午10:15触发
"0 15 10 * * ?" 每天上午10:15触发
"0 15 10 * * ? *" 每天上午10:15触发
"0 15 10 * * ? 2005" 2005年的每天上午10:15触发
"0 * 14 * * ?" 在每天下午2点到下午2:59期间的每1分钟触发
"0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发
"0 0/5 14,18 * * ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
"0 0-5 14 * * ?" 在每天下午2点到下午2:05期间的每1分钟触发
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发
"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发
"0 15 10 15 * ?" 每月15日上午10:15触发
"0 15 10 L * ?" 每月最后一日的上午10:15触发
"0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发
有些子表达式能包含一些范围或列表
例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”
“*”字符代表所有可能的值
“/”字符用来指定数值的增量
例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样
“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”
“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写
如果在“L”前有具体的内容,它就具有其他的含义了。例如:“6L”表示这个月的倒数第6天
注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题
W 字符代表着平日(Mon-Fri),并且仅能用于日域中。它用来指定离指定日的最近的一个平日。大部分的商业处理都是基于工作周的,所以 W 字符可能是非常重要的。
例如,日域中的 15W 意味着 "离该月15号的最近一个平日。" 假如15号是星期六,那么 trigger 会在14号(星期五)触发,因为星期四比星期一离15号更近。
C:代表“Calendar”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
字段 允许值 允许的特殊字符
秒 0-59 , - * /
分 0-59 , - * /
小时 0-23 , - * /
日期 1-31 , - * ? / L W C
月份 1-12 或者 JAN-DEC , - * /
星期 1-7 或者 SUN-SAT , - * ? / L C #
年(可选) 留空, 1970-2099 , - * /