Spring Boot 使用 Task 来实现定时任务

╰半橙微兮° 2022-03-28 06:06 258阅读 0赞

Github代码：[https://github.com/jeikerxiao/spring-boot2][https_github.com_jeikerxiao_spring-boot2]

spring-boot-task项目。

## 单线程方式 ##

### 定时任务 ###

使用三种参数方式，新建三个定时任务。

在下面的定时任务中，在方法上使用`@Scheduled`注解来设置任务的执行时间，并且使用三种属性配置方式：

*  cron：通过表达式来配置任务执行时间
 *  fixedRate：指定两次任务执行的时间间隔(毫秒)，此时间间隔指的是，前一个任务开始与下一个任务开始的间隔
 *  fixedDelay：指定两次任务执行的时间间隔(毫秒)，此时间间隔指的是，前一次任务结束与下一个任务开始的间隔

网上找来一张图解释三个配置的关系：  
![task][]

> 小工具在线cron表达式生成：[http://qqe2.com/cron/index][http_qqe2.com_cron_index]

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

## 定时任务代码 ##

@Slf4j
    @Component
    public class ScheduledService { 
    
        /** * cron：通过表达式来配置任务执行时间 */
        @Scheduled(cron = "0/5 * * * * *")
        public void scheduled() { 
            log.info("==>{} 使用cron。", System.currentTimeMillis());
        }
    
        /** * fixedRate：指定两次任务执行的时间间隔(毫秒)， * 此时间间隔指的是，前一个任务开始与下一个任务开始的间隔 */
        @Scheduled(fixedRate = 5000)
        public void scheduled1() { 
            log.info("==>{} 使用fixedRate。", System.currentTimeMillis());
        }
    
        /** * fixedDelay：指定两次任务执行的时间间隔(毫秒)， * 此时间间隔指的是，前一次任务结束与下一个任务开始的间隔 * 此属性可以配合 initialDelay， 定义该任务延迟执行时间。 */
        @Scheduled(fixedDelay = 5000)
        public void scheduled2() { 
            log.info("==>{} 使用fixedDelay。", System.currentTimeMillis());
        }
    }

### 定时任务开启 ###

在主类`SpringBootTaskApplication`上使用`@EnableScheduling`注解开启对定时任务的支持，然后启动项目。

@SpringBootApplication
    @EnableScheduling // 开启Scheduling
    public class SpringBootTaskApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(SpringBootTaskApplication.class, args);
        }
    }

### 日志输出 ###

发现输出都是在同一线程中执行：

2019-01-08 17:24:58.207  [   scheduling-1] c.jeiker.task.service.ScheduledService   : ==>1546939498207 使用fixedRate。
    2019-01-08 17:24:58.208  [   scheduling-1] c.jeiker.task.service.ScheduledService   : ==>1546939498208 使用fixedDelay。
    2019-01-08 17:25:00.004  [   scheduling-1] c.jeiker.task.service.ScheduledService   : ==>1546939500004 使用cron。
    2019-01-08 17:25:03.208  [   scheduling-1] c.jeiker.task.service.ScheduledService   : ==>1546939503208 使用fixedRate。
    2019-01-08 17:25:03.209  [   scheduling-1] c.jeiker.task.service.ScheduledService   : ==>1546939503209 使用fixedDelay。
    2019-01-08 17:25:05.002  [   scheduling-1] c.jeiker.task.service.ScheduledService   : ==>1546939505002 使用cron。

## 多线程方式 ##

### 多线程配置 ###

@Configuration：表明该类是一个配置类  
@EnableAsync：开启异步事件的支持

@Configuration
    @EnableAsync
    public class AsyncConfig { 
    
        /** * 此处成员变量应该使用@Value从配置中读取 */
        private int corePoolSize = 10;
        private int maxPoolSize = 200;
        private int queueCapacity = 10;
    
        @Bean
        public Executor taskExecutor() { 
            ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
            executor.setCorePoolSize(corePoolSize);
            executor.setMaxPoolSize(maxPoolSize);
            executor.setQueueCapacity(queueCapacity);
            executor.initialize();
            return executor;
        }
    }

然后在定时任务的类或者方法上添加`@Async` 。最后重启项目，每一个任务都是在不同的线程中.

### 异步注解 ###

@Slf4j
    @Component
    public class ScheduledService { 
    
        @Async
        @Scheduled(cron = "0/5 * * * * *")
        public void scheduled() { 
            log.info("==>{} 使用cron。", System.currentTimeMillis());
        }
    
        @Async
        @Scheduled(fixedRate = 5000)
        public void scheduled1() { 
            log.info("==>{} 使用fixedRate。", System.currentTimeMillis());
        }
    
        @Async
        @Scheduled(fixedDelay = 5000)
        public void scheduled2() { 
            log.info("==>{} 使用fixedDelay。", System.currentTimeMillis());
        }
    }

### 日志输出 ###

发现输出是在不同线程中执行：

2019-01-08 18:20:50.006  [ taskExecutor-6] c.jeiker.task.service.ScheduledService   : ==>1546942850006 使用cron。
    2019-01-08 18:20:53.714  [ taskExecutor-7] c.jeiker.task.service.ScheduledService   : ==>1546942853714 使用fixedRate。
    2019-01-08 18:20:53.716  [ taskExecutor-8] c.jeiker.task.service.ScheduledService   : ==>1546942853716 使用fixedDelay。
    2019-01-08 18:20:55.003  [ taskExecutor-9] c.jeiker.task.service.ScheduledService   : ==>1546942855003 使用cron。
    2019-01-08 18:20:58.711  [taskExecutor-10] c.jeiker.task.service.ScheduledService   : ==>1546942858711 使用fixedRate。
    2019-01-08 18:20:58.717  [ taskExecutor-1] c.jeiker.task.service.ScheduledService   : ==>1546942858717 使用fixedDelay。
    2019-01-08 18:21:00.005  [ taskExecutor-2] c.jeiker.task.service.ScheduledService   : ==>1546942860005 使用cron。
    2019-01-08 18:21:03.711  [ taskExecutor-3] c.jeiker.task.service.ScheduledService   : ==>1546942863711 使用fixedRate。
    2019-01-08 18:21:03.719  [ taskExecutor-4] c.jeiker.task.service.ScheduledService   : ==>1546942863719 使用fixedDelay。
    2019-01-08 18:21:05.003  [ taskExecutor-5] c.jeiker.task.service.ScheduledService   : ==>1546942865003 使用cron。
    2019-01-08 18:21:08.714  [ taskExecutor-6] c.jeiker.task.service.ScheduledService   : ==>1546942868714 使用fixedRate。
    2019-01-08 18:21:08.721  [ taskExecutor-7] c.jeiker.task.service.ScheduledService   : ==>1546942868721 使用fixedDelay。

[https_github.com_jeikerxiao_spring-boot2]: https://github.com/jeikerxiao/spring-boot2
[task]: /images/20220328/28433cb5e7f24a649613b2acae827c75.png
[http_qqe2.com_cron_index]: http://qqe2.com/cron/index