SpringBoot —— 多线程定时任务的实现（注解配置、task:annotation-driven配置）

ゝ一纸荒年。 2023-10-05 21:50 39阅读 0赞

#### 文章目录 ####

*  前言
 *  一、cron表达式
 *  二、注解配置
 *   *  1.Scheduled
     *  2.使用注解实现定时任务
 *  三、xml配置实现
 *   *  1.线程池配置
     *  2.任务配置
     *  3.引入外部xml
 *  总结

## 前言 ##

项目常常用到定时任务，在某个特定的时间，程序会自主触发去执行一些机械重复的工作，例如定时发送邮件、定时释放数据库资源、定时票据核销等。

## 一、cron表达式 ##

[了解cron表达式][cron]

对于cron表达式，其结构是: 从左到右（用空格隔开）：秒 分 小时 月份中的日期 月份 星期中的日期 年份

## 二、注解配置 ##

### 1.Scheduled ###

1.@Scheduled(cron = “0 10 \* \* \* ?”)  
cron表达式就不多说了

2.@Scheduled(fixedDelay = 10000)  
fixedDelay 的执行规则是上一个任务结束后到下个任务开始的间隔时间为设定时间，单位是毫秒（例：@Scheduled(fixedDelay = 10000)代表间隔10秒执行一次）

3.@Scheduled(fixedRate= 10000)  
fixedRate表示上个任务开始到下个任务开始之间的间隔时间，单位也是毫秒。

4.@Scheduled(initialDelay= 10000)  
这个代表第一次运行前延迟一段时间后执行，单位也是毫秒

### 2.使用注解实现定时任务 ###

首先，启动类上加上`@EnableScheduling`

新建定时任务测试类：

@Component
    @Slf4j
    public class TaskDemo {
        
    
        @Scheduled(cron = "*/1 * * * * ?")
        public void task1() {
        
            log.info("task1:每1秒执行一次 " +
                    new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        }
    
        @Scheduled(cron = "*/2 * * * * ?")
        public void task2() {
        
            try {
        
                log.info("task2:每2秒执行一次 " +
                        new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
                Thread.sleep(2000);
            } catch (InterruptedException e) {
        
                e.printStackTrace();
            }
        }
    }

执行程序：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]  
当有多个方法使用@Scheduled注解时，就会创建多个定时任务到任务列表中，当其中一个任务没执行完时，其它任务在阻塞队列当中等待，因此，所有的任务都是按照顺序执行的。

这时需要用到`@Async`实现多线程

@Component
    @Slf4j
    @EnableAsync
    public class TaskDemo {
        
    
        @Async
        @Scheduled(cron = "*/1 * * * * ?")
        public void task1() {
        
            log.info("task1:每1秒执行一次 " +
                    new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        }
    
        @Async
        @Scheduled(cron = "*/2 * * * * ?")
        public void task2() {
        
            try {
        
                log.info("task2:每2秒执行一次 " +
                        new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
                Thread.sleep(2000);
            } catch (InterruptedException e) {
        
                e.printStackTrace();
            }
        }
    }

运行结果：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16]

## 三、xml配置实现 ##

### 1.线程池配置 ###

新建springmvc-servlet.xml进行配置

<bean id="taskExecutor" class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
    		 
    	<property name="corePoolSize" value="5" />
    	  
    	<property name="maxPoolSize" value="50" />
    	
    	<property name="queueCapacity" value="1000" />
    	
    	<property name="keepAliveSeconds" value="60" />
    </bean>

### 2.任务配置 ###

spring中使用task:annotation-driven标签作为定时器的启动开关，自动扫描程序中带注解的定时器。

<task:scheduler id="scheduler" pool-size="5"/>
    <task:annotation-driven scheduler="scheduler" executor="taskExecutor" proxy-target-class="true"/>
    <task:scheduled-tasks scheduler="scheduler">
        <task:scheduled ref="taskDemo" method="task1" cron="*/1 * * * * ?"/>
        <task:scheduled ref="taskDemo" method="task2" cron="*/2 * * * * ?"/>
    </task:scheduled-tasks>

### 3.引入外部xml ###

贴出完整的xml

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:task="http://www.springframework.org/schema/task"
           xmlns:context="http://www.springframework.org/schema/context"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
               http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
               http://www.springframework.org/schema/task
               http://www.springframework.org/schema/task/spring-task-4.1.xsd
               http://www.springframework.org/schema/context
               http://www.springframework.org/schema/context/spring-context-3.2.xsd">
    
        <context:component-scan base-package="com.local.dev.root.devroot.common.task"/>
    
        
        <bean id="taskExecutor" class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
            
            <property name="corePoolSize" value="5"/>
            
            <property name="maxPoolSize" value="50"/>
            
            <property name="queueCapacity" value="1000"/>
            
            <property name="keepAliveSeconds" value="60"/>
        </bean>
        
        
        
        
        <task:scheduler id="scheduler" pool-size="5"/>
        <task:annotation-driven scheduler="scheduler" executor="taskExecutor" proxy-target-class="true"/>
    
        <task:scheduled-tasks scheduler="scheduler">
            <task:scheduled ref="taskDemo" method="task1" cron="*/1 * * * * ?"/>
            <task:scheduled ref="taskDemo" method="task2" cron="*/2 * * * * ?"/>
        </task:scheduled-tasks>
    
    
    </beans>

在启动类加上`@ImportResource("classpath:spring-servlet.xml")`

执行程序：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 1]

## 总结 ##

以上就是今天要讲的内容，本文仅仅简单介绍了定时器的使用，注解实现很简单，但是项目中推荐使用xml配置的方式。

[配置参考][Link 1]

[«][Link 2] 上一章：[SpringBoot —— 实现邮件、短信的发送功能][Link 2]  
[»][Link 3] 下一章：[SpringBoot ——统一异常处理][Link 3]

[cron]: https://baike.baidu.com/item/cron/10952601?fr=aladdin
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]: https://img-blog.csdnimg.cn/49c75a75e601455da2a1621103b109ba.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/7b4c588dae3b4dc18393e953603afc80.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/4ec4580758524820ab15534925462083.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[Link 1]: https://blog.csdn.net/qq_34383510/article/details/117324723
[Link 2]: https://blog.csdn.net/qq_34383510/article/details/120415580
[Link 3]: https://blog.csdn.net/qq_34383510/article/details/120492504