Spring Boot创建定时任务

定时任务

Spring Boot使用定时任务

1.启动类添加注解@EnableScheduling开启定时任务

@SpringBootApplication
@EnableScheduling
public class SuodadaApplication {

    public static void main(String[] args) {
        SpringApplication.run(SuodadaApplication.class, args);
    }

}

2.方法中设置定时任务

@Service
public class TaskServiceImpl implements TaskService {
    @Override
    @Scheduled(cron = "*/3 * * * * ?")
    public void test1() {
        System.out.println("3秒输出一次");
    }
}

3.如果想要启动项目就执行一次定时任务,需要重写run方法

/**
 * 初始化启动进程
 */
@Component
public class InitPushAllSubscribeConfig implements ApplicationRunner {

    @Resource
    private TaskService taskService;

    /**
     * 重写启动方法
     * @param args
     */
    @Override
    public void run(ApplicationArguments args){
        //测试一,初始化的时候就执行定时任务
        taskService.test1();
    }
}

单线程定时任务

定时任务是单线程执行的,一次只能有一个线程执行定时任务

@Component
public class TaskTest1{
    private static SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");//设置日期格式

    @Scheduled(cron = "*/3 * * * * ?")
    public void test1() throws InterruptedException {
        System.out.println(df.format(new Date()));
        System.out.println(Thread.currentThread().getName()+":每隔3秒执行一次");
        //休息10秒
        Thread.sleep(10000);
        System.out.println();
        System.out.println(df.format(new Date()));
    }

    @Scheduled(cron = "*/5 * * * * ?")
    public void test2() throws InterruptedException {
        System.out.println(df.format(new Date()));
        System.out.println(Thread.currentThread().getName()+":每隔5秒执行一次");
        Thread.sleep(10000);
        System.out.println(df.format(new Date()));
    }

}

结果

2022-03-11 11:41:33
scheduling-1:每隔3秒执行一次

2022-03-11 11:41:43
2022-03-11 11:41:43
scheduling-1:每隔5秒执行一次
2022-03-11 11:41:53
2022-03-11 11:41:53
scheduling-1:每隔3秒执行一次

通过结果可以看出,在11:41:33的时候,执行了test1方法,然后等待10秒,期间不能执行test2方法,等test1的线程执行完成后,才能执行test2方法

线程的名字都是scheduling-1

配置多线程执行定时任务

新建一个配置类

package com.suodada.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
/**
 * Created by sjh8801 on 2022/3/11 11:15
 */
@Configuration
@EnableAsync
@EnableScheduling
@Slf4j
public class ExecutorConfig implements SchedulingConfigurer, AsyncConfigurer {

    /**
     * 定时任务使用的线程池
     * @return
     */
    @Bean(destroyMethod = "shutdown", name = "taskScheduler")
    public ThreadPoolTaskScheduler taskScheduler(){
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(10);
        scheduler.setThreadNamePrefix("task-");
        scheduler.setAwaitTerminationSeconds(600);
        scheduler.setWaitForTasksToCompleteOnShutdown(true);
        return scheduler;
    }

    /**
     * 异步任务执行线程池
     * @return
     */
    @Bean(name = "asyncExecutor")
    public ThreadPoolTaskExecutor asyncExecutor() {
        //核心线程池大小
        executor.setCorePoolSize(10);
        //队列容量
        executor.setQueueCapacity(1000);
        //线程空闲时间
        executor.setKeepAliveSeconds(600);
        //最大线程池数量
        executor.setMaxPoolSize(20);
        //线程命名前缀
        executor.setThreadNamePrefix("taskExecutor-");
        //拒绝策略
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.initialize();
        return executor;
    }

    @Override
    public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
        ThreadPoolTaskScheduler taskScheduler = taskScheduler();
        scheduledTaskRegistrar.setTaskScheduler(taskScheduler);
    }

    @Override
    public Executor getAsyncExecutor() {
        return asyncExecutor();
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return (throwable, method, objects) -> {
            log.error("异步任务执行出现异常, message {}, emthod {}, params {}", throwable, method, objects);
        };
    }

}

结果

2022-03-11 11:43:18
task-1:每隔3秒执行一次
2022-03-11 11:43:20
task-2:每隔5秒执行一次

2022-03-11 11:43:28
2022-03-11 11:43:30
task-1:每隔3秒执行一次
2022-03-11 11:43:30
2022-03-11 11:43:35
task-3:每隔5秒执行一次

通过结果可以看出,多线程配置生效,随机分配线程执行定时任务

常用的表达式

0 0 10,14,16 * * ?	每天上午10点，下午2点，4点每天上午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 * * ? 2019	2019年的每天上午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 2018-2019	2018年至2019年的每月的最后一个星期五上午10:15触发
0 15 10 ? * 6#3	每月的第三个星期五上午10:15触发
*/5 * * * * ?	每隔5秒执行一次

特殊字符

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

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

字段	允许的值	允许的特殊字符
秒	0-59	, - * /
分	0-59	, - * /
时	0-23	, - * /
日期	1-31	, - * ? / L W C
月份	1-12或JAN-DEC	, - * /
星期	1-7或SUN-SAT	, - * ? / L C #
年(可选)	留空,1970-2099	, - * /