SpringBoot 使用 @Scheduled 定时任务突然不执行了

淡淡的烟草味﹌ 2022-10-08 14:23 629阅读 0赞

转载自：[【SpringBoot】为什么我的定时任务不执行？ - Java教程 - 找一找教程网 (zyiz.net)][SpringBoot_ - Java_ - _ _zyiz.net]

## 叙述 ##

在 SpringBoot 中可以通过 **`@Scheduled`**  注解来定义一个定时任务, 但是有时候你可能会发现有的定时任务到时间了却没有执行，但是又不是每次都不执行，这是怎么回事？

下面这段代码定义了一个每隔十秒钟执行一次的定时任务:

@Component
    public class ScheduledTaskDemo {
        private static final Logger logger = LoggerFactory.getLogger(ScheduledTaskDemo.class);
     
        @Scheduled(cron = "0/10 * * * * *")
        public void execute() {
            logger.info("Scheduled task is running... ...");
        }
    }

此时启动 SpringBoot 应用, 可以在控制台看到这个定时任务每隔10秒钟打印一条log

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhlbmd5dTg5MTIzMQ_size_16_color_FFFFFF_t_70][]

但是, 一切还没结束，如果没有相关log显示, 检查是否在入口类或者 Configuration 类上添加了`@EnableScheduling `注解

在上面的相关代码中, 我们使用cron表达式来指定定时任务的执行时间点, 即从0秒开始, 每隔10秒钟执行一次, 现在我们再加一个定时任务:

@Component
    public class SecondScheduledTaskDemo {
        private static final Logger logger = LoggerFactory.getLogger(ScheduledTaskDemo.class);
     
        @Scheduled(cron = "0/10 * * * * *")
        public void second() {
            logger.info("Second scheduled task is starting... ...");
            logger.info("Second scheduled task is ending... ...");
        }
     
    }

现在再启动SpringBoot应用, 再看log:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhlbmd5dTg5MTIzMQ_size_16_color_FFFFFF_t_70 1][]

注意log中定时任务执行的时间点, 第二个定时任务原本应该每隔10秒钟执行一次, 但是从23:12:20到23:13:55, 本该执行4次, 确只执行了2次.

难道是cron表达式不对?

No.

为了找到原因, 我们从** **`@Scheduled `注解的源码开始找:

*
     * <p>Processing of {@code @Scheduled} annotations is performed by
     * registering a {@link ScheduledAnnotationBeanPostProcessor}. This can be
     * done manually or, more conveniently, through the {@code <task:annotation-driven/>}
     * element or @{@link EnableScheduling} annotation.
     *

划重点, 每一个有 `@Scheduled `注解的方法都会被注册为一个**`ScheduledAnnotationBeanPostProcessor`**, 再接着往下看**`ScheduledAnnotationBeanPostProcessor`**:

/**
         * Set the {@link org.springframework.scheduling.TaskScheduler} that will invoke
         * the scheduled methods, or a {@link java.util.concurrent.ScheduledExecutorService}
         * to be wrapped as a TaskScheduler.
         * <p>If not specified, default scheduler resolution will apply: searching for a
         * unique {@link TaskScheduler} bean in the context, or for a {@link TaskScheduler}
         * bean named "taskScheduler" otherwise; the same lookup will also be performed for
         * a {@link ScheduledExecutorService} bean. If neither of the two is resolvable,
         * a local single-threaded default scheduler will be created within the registrar.
         * @see #DEFAULT_TASK_SCHEDULER_BEAN_NAME
         */
        public void setScheduler(Object scheduler) {
            this.scheduler = scheduler;
        }

重点来了, 注意这句话:

![20210622000055811.png][]

这句话意味着, 如果我们不主动配置我们需要的 **`TaskScheduler`**, **SpringBoot 会默认使用一个单线程的scheduler来处理我们用** `@Scheduled `注解实现的定时任务, 到此我们刚才的问题就可以理解了:

23:12:20, 第一个定时任务在线程pool-1-thread-1开始执行, 由于我们没有配置scheduler, 目前这个线程池pool-1里只有一个线程, 在打印了starting日志之后, 这个线程开始sleep;第二个定时任务也准备执行, 但是线程池已经没有多余线程了, 只能等待.

23:12:30, 第一个定时任务还在sleep, 第二个定时任务还在等待.

23:12:35, 第一个定时任务sleep结束, 打印ending日志并结束, 此时线程池空闲, 第二个定时任务从等待状态直接开始执行, 执行结束之后, 线程池空闲.

23:12:40, 线程池空闲, 第一个定时任务执行, 打印starting日志, 开始sleep.

![20210622000222545.png][]

搞清楚这个流程之后, 解决这个问题就很简单了.

根据刚才注释的描述, 我们只需要提供一个满足我们需要的 **`TaskScheduler `**并注册到context中就可以了.

@Configuration
    public class ScheduledTaskConfiguration implements SchedulingConfigurer {
     
        /**
         * Callback allowing a {@link TaskScheduler
         * TaskScheduler} and specific {@link Task Task}
         * instances to be registered against the given the {@link ScheduledTaskRegistrar}
         *
         * @param taskRegistrar the registrar to be configured.
         */
        @Override
        public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
            final ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
            taskScheduler.setPoolSize(2);
            taskScheduler.initialize();
            taskRegistrar.setTaskScheduler(taskScheduler);
        }
    }

上面的代码提供了一个线程池大小为2的taskScheduler, 现在再启动下SpringBoot看看效果.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhlbmd5dTg5MTIzMQ_size_16_color_FFFFFF_t_70 2][]

可以看到, 当线程池里有两个线程的时候, 这两个定时任务各自按照预定的时间进行触发, 互不影响了.

[SpringBoot_ - Java_ - _ _zyiz.net]: http://www.zyiz.net/tech/detail-116467.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhlbmd5dTg5MTIzMQ_size_16_color_FFFFFF_t_70]: /images/20221005/b6cd5559129f438d86ae95454f3a0205.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhlbmd5dTg5MTIzMQ_size_16_color_FFFFFF_t_70 1]: /images/20221005/5884cf31900f4f3b85caad73a6b524c7.png
[20210622000055811.png]: /images/20221005/328659118f864ff5b4344c47a2b160e9.png
[20210622000222545.png]: /images/20221005/b38c5eabac44416ca303eb5316eb61be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhlbmd5dTg5MTIzMQ_size_16_color_FFFFFF_t_70 2]: /images/20221005/f64540833e4546ed978ca8059982b777.png