从0开始搭建一个生产级SpringBoot2.0.X项目（十一）SpringBoot 定时任务@Scheduled

前言

最近有个想法想整理一个内容比较完整springboot项目初始化Demo。

定时任务是一项经常遇见的需求。Spring Boot提供了@Scheduled注解，直接作用于方法上，标记为定时任务，并在预定的时间间隔内执行。

一、 @Scheduled&@EnableScheduling 注解开发定时器

1.1、需要定时执行的方法上加上@Scheduled注解

1.2、使用@EnableScheduling开启定时任务的执行，此时spring容器才可以识别@Scheduled标注的方法，然后自动定时执行。

1.3、Cron 表达式由 6个（不要年）或者7 个字段和一个由空格分隔的可选字段组成。各字段分别说明如下：

[秒] [分] [小时] [日] [月] [周] [年]

通配符说明:

• * 表示所有值。例如:在分的字段上设置 *,表示每一分钟都会触发。

• ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的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相同。

1.4、举例说明
例1：每隔5秒执行一次：*/5 * * * * ?

例2：每隔5分执行一次：0 */5 * * * ?
在26分、29分、33分执行一次：0 26,29,33 * * * ?

例3：每天半夜12点30分执行一次：0 30 0 * * ? （注意日期域为0不是24）
每天凌晨1点执行一次：0 0 1 * * ?
每天上午10：15执行一次： 0 15 10 ? * * 或 0 15 10 * * ? 或 0 15 10 * * ? *
每天中午十二点执行一次：0 0 12 * * ?
每天14点到14：55分，每5分钟执行一次：0 0/5 14 * * ?
每天14点到14：55分，和18点到18点55分，每5分钟执行一次：0 0/5 14,18 * * ?

例4：每月1号凌晨1点执行一次：0 0 1 1 * ?
每月15号的10点15分执行一次：0 15 10 15 * ?
每月的最后一天的10：15执行一次：0 15 10 L * ?

例5：每月最后一天23点执行一次：0 0 23 L * ?

例6：每周星期天凌晨1点执行一次：0 0 1 ? * L
三月的每周三的14：10和14：44执行一次：0 10,44 14 ? 3 WED
每个周一、周二、周三、周四、周五的10：15执行一次：0 15 10 ? * MON-FRI
每月最后一个周五的10：15执行一次：0 15 10 ? * 6L

例7：2024年的每天早上10：15执行一次: 0 15 10 * * ? 2024

package com.murg.bootdemo.scheduled;

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;

@Component
@EnableScheduling
public class ScheduledTest {
    //每一秒执行一次打印当前执行线程名
    @Scheduled(cron = "0/1 * * * * ? ")
    public void testTask1() throws InterruptedException {
        Thread thread = Thread.currentThread();
        String threadName = thread.getName();
        System.out.println("testTask1 开始执行");
        System.out.println(threadName + "-->" + "testTask1-->" + LocalDateTime.now());
    }
    //每两秒执行一次打印当前执行线程名

    @Scheduled(cron = "0/2 * * * * ? ")
    public void testTask2() {
        Thread thread = Thread.currentThread();
        String threadName = thread.getName();
        System.out.println(threadName + "-->" + "testTask2-->" + LocalDateTime.now());
    }
}

重启服务控制台打印线程名字，两个定时任务正常执行分别间隔为1秒和两秒。

此时发现有个问题就是每个线程名都是scheduling-1，说明两个定时任务是同一个线程执行的

二、单线程定时任务可能发生的问题

上述测试可见，Spring Boot提供的@Scheduled注解默认是以单线程方式执行。在多个定时任务场景时可能会按顺序执行定时任务，出现定时任务阻塞问题。

修改testTask1()方法增加休眠等待1小时，重启服务测试。

    @Scheduled(cron = "0/1 * * * * ? ")
    public void testTask1() throws InterruptedException {
        Thread thread = Thread.currentThread();
        String threadName = thread.getName();
        System.out.println("testTask1 开始执行");
        System.out.println(threadName + "-->" + "testTask1-->" + LocalDateTime.now());
        //延时等待一小时
        TimeUnit.HOURS.sleep(1);
    }

testTask1执行一次之后开始休眠，同时testTask2也不再执行开始阻塞。所以针对多个定时任务情景下我们需要@Scheduled配置成多线程环境下执行。

三、自定义线程池多线程执行

创建ScheduleConfig类，自定义线程池当做参数传给Scheduled。

package com.murg.bootdemo.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import java.util.concurrent.Executors;

@Configuration
public class ScheduleConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        // ScheduledExecutorService线程池的方法，
        //Executors.newScheduledThreadPool(2);创建一个大小为2的线程池：
        taskRegistrar.setScheduler(Executors.newScheduledThreadPool(2));
    }
}

再次启动项目查看输出日志，testTask2不阻塞，正常执行每两秒一次打印