SpringBoot--异步任务、定时任务、@Scheduled参数详解

矫情吗；* 2021-08-25 01:29 523阅读 0赞

#### 异步任务 ####

异步任务场景非常常见，比如我们发送邮件或者处理数据时，不希望阻塞线程，影响用户体验，所以就需要异步任务。

模拟上述场景：

@RestController
    public class AsynController { 
    
        @Autowired
        AsyncService asyncService;
    
        @GetMapping("/hello")
        public String hello(){ 
            asyncService.hello();
            return "success";
        }
    }

@Service
    public class AsyncService { 
    
        public void hello(){ 
            try { 
                Thread.sleep(3000);
            } catch (InterruptedException e) { 
                e.printStackTrace();
            }
            System.out.println("数据处理中...");
        }
    }

启动项目，访问localhost:8080/hello,页面在3秒之后才返回success，严重影响用户体验，需要使用异步任务。

spring为我们提供了一个注解 @Async：

*  该注解标注在方法上，告诉spring这是一个异步方法
 *  需要在主启动类上使用@EnableAsync开启异步注解功能

@Service
    public class AsyncService { 
    
        @Async
        public void hello(){ 
            try { 
                Thread.sleep(3000);
            } catch (InterruptedException e) { 
                e.printStackTrace();
            }
            System.out.println("数据处理中...");
        }
    }

@EnableAsync
    @SpringBootApplication
    public class DemoApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(DemoApplication.class, args);
        }
    
    }

运行修改后的项目，此时页面会立即返回，3秒后控制台打印：

数据处理中...

### 定时任务 ###

定时任务是企业级开发中最常见的功能之一，如定时统计订单数、数据库备份、定时发送短信和邮件、定时统计博客访客等，简单的定时任务可以直接通过Spring中的@Scheduled注解来实现，复杂的定时任务则可以通过集成Quartz来实现。

== 开启定时任务：==

在项目启动类上添加@EnableScheduling注解开启定时任务：

@EnableScheduling
    @EnableAsync
    @SpringBootApplication
    public class DemoApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(DemoApplication.class, args);
        }
    
    }

配置定时任务：

@Component
    public class MySchedule { 
    
        //当前任务执行结束1秒后开启下一次任务
        @Scheduled(fixedDelay = 1000)
        public void fixedDelay(){ 
            System.out.println("fixedDelay:" + new Date());
        }
    
        //当前任务开始2秒后，开启下一次定时任务
        @Scheduled(fixedRate = 2000)
        public void fixedRate(){ 
            System.out.println("fixedRate:" + new Date());
        }
    
        //initialDelay表示首次执行的延迟时间
        @Scheduled(initialDelay = 1000, fixedRate = 2000)
        public void initialDelay(){ 
            System.out.println("initialDelay:" + new Date());
        }
    
        //cron表达式：表示该定时任务每分钟执行1次
        @Scheduled(cron = "0 * * * * ?")
        public void cron(){ 
            System.out.println("cron:" + new Date());
        }
    }

启动项目，控制台打印：

1 fixedRate:Thu Feb 06 23:35:11 CST 2020   # 执行开始2秒后，开启了任务5
    2 fixedDelay:Thu Feb 06 23:35:11 CST 2020  # 执行完毕1秒开启了任务4
    3 initialDelay:Thu Feb 06 23:35:12 CST 2020  # 第一次执行延迟了1秒，开启执行2秒后，启动了任务7
    4 fixedDelay:Thu Feb 06 23:35:12 CST 2020  # 执行结束1秒后开启了任务6
    5 fixedRate:Thu Feb 06 23:35:13 CST 2020  # 执行开始2秒后，开启任务9
    6 fixedDelay:Thu Feb 06 23:35:13 CST 2020 # 执行完毕1秒后，开启任务8，非第一次执行，所以不延迟
    7 initialDelay:Thu Feb 06 23:35:14 CST 2020
    8 fixedDelay:Thu Feb 06 23:35:14 CST 2020
    9 fixedRate:Thu Feb 06 23:35:15 CST 2020

### @Scheduled参数详解 ###

#### 1. cron： ####

该参数接收一个cron表达式，cron表达式是一个字符串，字符串以5或6个空格隔开，分开共6或7个域，每一个域代表一个含义。

**cron表达式语法：**

[秒] [分] [小时] [日] [月] [周] [年]
    
    
    注：[年]不是必须的域，可以省略[年]，则一共6个域

<table> 
 <thead> 
  <tr> 
   <th align="left">序号</th> 
   <th align="left">说明</th> 
   <th align="left">必填</th> 
   <th align="left">允许填写的值</th> 
   <th align="left">允许的通配符</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">1</td> 
   <td align="left">秒</td> 
   <td align="left">是</td> 
   <td align="left">0-59</td> 
   <td align="left">，- * /</td> 
  </tr> 
  <tr> 
   <td align="left">2</td> 
   <td align="left">分</td> 
   <td align="left">是</td> 
   <td align="left">0-59</td> 
   <td align="left">，- * /</td> 
  </tr> 
  <tr> 
   <td align="left">3</td> 
   <td align="left">时</td> 
   <td align="left">是</td> 
   <td align="left">0-23</td> 
   <td align="left">，- * /</td> 
  </tr> 
  <tr> 
   <td align="left">4</td> 
   <td align="left">日</td> 
   <td align="left">是</td> 
   <td align="left">1-31</td> 
   <td align="left">，- * ？/ L W</td> 
  </tr> 
  <tr> 
   <td align="left">5</td> 
   <td align="left">月</td> 
   <td align="left">是</td> 
   <td align="left">1-12/JAN-DEC</td> 
   <td align="left">，- * /</td> 
  </tr> 
  <tr> 
   <td align="left">6</td> 
   <td align="left">周</td> 
   <td align="left">是</td> 
   <td align="left">1-7 or SUN-SAT</td> 
   <td align="left">，- * ？/ L #</td> 
  </tr> 
  <tr> 
   <td align="left">7</td> 
   <td align="left">年</td> 
   <td align="left">否</td> 
   <td align="left">1970-2099</td> 
   <td align="left">，- * /</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th align="left">特殊字符</th> 
   <th align="left">代表含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">，</td> 
   <td align="left">枚举</td> 
  </tr> 
  <tr> 
   <td align="left">-</td> 
   <td align="left">区间</td> 
  </tr> 
  <tr> 
   <td align="left">*</td> 
   <td align="left">任意</td> 
  </tr> 
  <tr> 
   <td align="left">/</td> 
   <td align="left">步长</td> 
  </tr> 
  <tr> 
   <td align="left">？</td> 
   <td align="left">日/星期冲突匹配</td> 
  </tr> 
  <tr> 
   <td align="left">L</td> 
   <td align="left">最后</td> 
  </tr> 
  <tr> 
   <td align="left">W</td> 
   <td align="left">工作日</td> 
  </tr> 
  <tr> 
   <td align="left">C</td> 
   <td align="left">和calendar联系后计算过的值</td> 
  </tr> 
  <tr> 
   <td align="left">#</td> 
   <td align="left">星期，4#2，第2个星期四</td> 
  </tr> 
 </tbody> 
</table>

说明：

*  **\*** 表示所有值。  
    例如:在分的字段上设置 \*,表示每一分钟都会触发。
 *  **?** 表示不指定值。  
    使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的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相同。

示例：

每隔5秒执行一次：*/5 * * * * ?
    
    每隔1分钟执行一次：0 */1 * * * ?
    
    每天23点执行一次：0 0 23 * * ?
    
    每天凌晨1点执行一次：0 0 1 * * ?
    
    每月1号凌晨1点执行一次：0 0 1 1 * ?
    
    每月最后一天23点执行一次：0 0 23 L * ?
    
    每周星期天凌晨1点实行一次：0 0 1 ? * L
    
    在26分、29分、33分执行一次：0 26,29,33 * * * ?
    
    每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?

cron表达式使用占位符：

另外，cron属性接收的cron表达式支持占位符。eg：  
配置文件：

time:
      cron: */5 * * * * *
      interval: 5

每5秒执行一次：

@Scheduled(cron="${time.cron}")
        void testPlaceholder1() {
            System.out.println("Execute at " + System.currentTimeMillis());
        }
    
        @Scheduled(cron="*/${time.interval} * * * * *")
        void testPlaceholder2() {
            System.out.println("Execute at " + System.currentTimeMillis());
        }

#### 2. zone： ####

时区，接收一个java.util.TimeZone\#ID。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

#### 3. fixedDelay： ####

上一次执行完毕时间点之后多长时间再执行。如：

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行

#### 4. fixedDelayString: ####

与 3. fixedDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。如：

@Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行

占位符的使用(配置文件中有配置：time.fixedDelay=5000)：

@Scheduled(fixedDelayString = "${time.fixedDelay}")
        void testFixedDelayString() { 
            System.out.println("Execute at " + System.currentTimeMillis());
        }

#### 5. fixedRate: ####

上一次开始执行时间点之后多长时间再执行。如：

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行

#### 6. fixedRateString: ####

与 5. fixedRate 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

#### 7. initialDelay: ####

第一次延迟多长时间后再执行。如：

@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次

#### 8. initialDelayString: ####

与 7. initialDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

[在线Cron表达式生成器][Cron]

[Cron]: http://cron.qqe2.com