在很多的时候,我们会遇到一些需要编写定时任务来完成自动操作的场景,例如在某个时间点上开启某个活动,或者是在指定时间点去执行某些具体的任务来控制逻辑的可执行操作等等问题。在Spring Boot中为我们提供了执行定时任务相关的操作,下面我们就来看一下在Spring Boot如何设置一个定时任务,并且当定时任务过多的时候出现阻塞的情况我们如何来解决。
如何去定义一个定时任务
第一步、我们需要创建一个Spring Boot的项目。并且在项目中添加一个定时任务的配置类。
@Configuration
@EnableScheduling
public class ScheduleConfig {
@Scheduled(cron = "0/5 * * * * ?")
private void testTask(){
System.out.println("执行定时任务 "+System.currentTimeMillis());
}
}
通过上面这个配置我们就可以开启一个Spring Boot的定时任务操作。运行项目之后我们会在控制台看到如下的输出结果。
@EnableScheduling分析
我们会看到上面的配置之所以起作用,是因为有@EnableScheduling注解来进行标注。那么我们就来分析一下@EnableScheduling源码
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(SchedulingConfiguration.class)
@Documented
public @interface EnableScheduling {
}
会看到在源码中引入了一个SchedulingConfiguration配置类。
@Configuration(proxyBeanMethods = false)
@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的前置处理器。在这个前置处理器的构造方法中我们找到了ScheduledTaskRegistrar一个类,而这个类就是我们执行定时任务的关键,其中有如下的方法值得我们去注意。
protected void scheduleTasks() {
if (this.taskScheduler == null) {
this.localExecutor = Executors.newSingleThreadScheduledExecutor();
this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
}
if (this.triggerTasks != null) {
for (TriggerTask task : this.triggerTasks) {
addScheduledTask(scheduleTriggerTask(task));
}
}
if (this.cronTasks != null) {
for (CronTask task : this.cronTasks) {
addScheduledTask(scheduleCronTask(task));
}
}
if (this.fixedRateTasks != null) {
for (IntervalTask task : this.fixedRateTasks) {
addScheduledTask(scheduleFixedRateTask(task));
}
}
if (this.fixedDelayTasks != null) {
for (IntervalTask task : this.fixedDelayTasks) {
addScheduledTask(scheduleFixedDelayTask(task));
}
}
}
会看到如果taskScheduler为空的时候,这里创建了一个单线程的线程池
Executors.newSingleThreadScheduledExecutor()。也就是说在Spring Boot提供的默认的线程执行方案中是通过单线程来执行的。所以就会出现线程阻塞的问题。那么在Spring Boot中如何配置多线程定时任务呢?
通过SchedulingConfigurer配置定时任务
在Spring Boot中提供了SchedulingConfigurer类来对ScheduledTaskRegistrar类中的配置进行重新配置,所以我们可以通过如下的方式来改变定时任务线程池的相关配置。如下我们通过SchedulingConfigurer类修改了定时任务线程池的类型。
@Configuration
public class MyScheduleConfig implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
}
}
结合@Async注解来开启异步进行定时任务的优化
在之前的文章中我们介绍了通过@Async注解来提升接口效率,这里我们还可以通过这个注解来实现对于定时任务的异步调用。在使用这个注解之前我们需要先对线程池进行一个配置。
@Configuration
@EnableScheduling
public class ScheduleConfig {
@Scheduled(cron = "0/5 * * * * ?")
@Async
public void testTask(){
System.out.println("执行定时任务 "+System.currentTimeMillis());
}
@Bean
public ThreadPoolTaskExecutor taskExecutor(){
ThreadPoolTaskExecutor poolTaskExecutor = new ThreadPoolTaskExecutor();
// 设置核心线程数
poolTaskExecutor.setCorePoolSize(4);
// 设置最大线程数
poolTaskExecutor.setMaxPoolSize(6);
// 设置线程活跃时间
poolTaskExecutor.setKeepAliveSeconds(120);
// 设置线程容量
poolTaskExecutor.setQueueCapacity(40);
// 设置线程池拒绝策略
poolTaskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
// 设置所有线程执行完成再关闭线程池
poolTaskExecutor.setWaitForTasksToCompleteOnShutdown(true);
return poolTaskExecutor;
}
}
总结
当然还有很多的执行定时任务的实现方式,但是万变不离其宗,所有的线程阻塞问题其解决办法都离不开异步和多线程,而对于异步和多线程来讲又离不开线程池和IO。所以说无论是怎样解决线程阻塞问题,我们只需要关注需要解决的核心问题是扩展线程池,还是异步就都可以得到解决。最后希望大家多多关注博主还会有更多的干货带给大家。