SpringBoot执行定时任务

SpringBoot执行定时任务

1、在启动类中加入@EnableScheduling来开启定时任务。

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class DemoApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(DemoApplication.class);
    }
    
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

2、创建定时任务类

package com.example.demo;

import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import lombok.extern.slf4j.Slf4j;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Slf4j
@Component
//@Async //可加在类或方法，开启异步事件的支持
public class SchedulerTask {
    
    Logger log = LoggerFactory.getLogger(SchedulerTask.class);
    
    //cron表达式：每隔5秒执行一次
    @Scheduled(cron = "0/5 * * * * *")
    public void scheduled(){
        log.info("使用cron: {}");
    }
    //上一次 启动时间点之后每5秒执行一次
    //如果任务时长超过 fixedRate不会启动多个任务实例，只不过会在上次任务执行完后立即启动下一轮
    //除非这个类或 Job 方法用 @Async 注解了，使得任务不在 TaskScheduler 线程池中执行，而是每次创建新线程来执行。
    @Scheduled(fixedRate = 5000)
    public void scheduled1() {
        log.info("使用fixedRate {}");
    }
    //上一次 结束时间点之后 每5秒执行一次
    @Scheduled(fixedDelay = 5000)
    public void scheduled2() {
        log.info("使用fixedDelay {}");
    }
    //第一次延迟 10秒执行，之后按照fixedRate的规则每6秒执行
    @Scheduled(initialDelay = 10000,fixedRate = 6000)
    public void scheduled3() {
        log.info("使用initialDelay {}");
    }
}

控制台输出如下：

2018-10-26 12:17:45.001 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用cron: {}
2018-10-26 12:17:48.640 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用fixedRate {}
2018-10-26 12:17:48.640 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用fixedDelay {}
2018-10-26 12:17:50.001 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用cron: {}
2018-10-26 12:17:53.640 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用fixedRate {}
2018-10-26 12:17:53.640 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用initialDelay {}
2018-10-26 12:17:53.641 INFO 100760 --- [ool-20-thread-1] com.example.demo.SchedulerTask : 使用fixedDelay {}

可见这几个定时任务都使同一个线程串行执行，如图中ool-20-thread-1所示。

3、多线程定时任务
（1）新建一个AsyncConfig配置类类

package com.example.demo;

import java.util.concurrent.Executor;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

@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;
    }
}

（2）在定时任务的类或者方法上添加@Async，如

@Slf4j
@Component
@Async
public class SchedulerTask 

控制台输出如下，使用多个线程：
2018-10-26 12:16:20.001 INFO 100760 --- [ taskExecutor-4] com.example.demo.SchedulerTask : 使用cron: {}
2018-10-26 12:16:20.792 INFO 100760 --- [ taskExecutor-2] com.example.demo.SchedulerTask : 使用initialDelay {}
2018-10-26 12:16:22.792 INFO 100760 --- [ taskExecutor-3] com.example.demo.SchedulerTask : 使用fixedRate {}
2018-10-26 12:16:22.836 INFO 100760 --- [ taskExecutor-6] com.example.demo.SchedulerTask : 使用fixedDelay {}
2018-10-26 12:16:25.001 INFO 100760 --- [ taskExecutor-5] com.example.demo.SchedulerTask : 使用cron: {}
2018-10-26 12:16:26.792 INFO 100760 --- [ taskExecutor-7] com.example.demo.SchedulerTask : 使用initialDelay {}

附1，

Slf4j需要在pom.xml中添加配置

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
          </dependency>

附2，

cron表达式：
Seconds Minutes Hours DayofMonth Month DayofWeek Year或 
Seconds Minutes Hours DayofMonth Month DayofWeek
每一个域都使用数字，但还可以出现如下特殊字符，它们的含义是： 
(1)*：表示匹配该域的任意值，假如在Minutes域使用*, 即表示每分钟都会触发事件。
(2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值，但实际不会。因为DayofMonth和 DayofWeek会相互影响。例如想在每月的20日触发调度，不管20日到底是星期几，则只能使用如下写法： 13 13 15 20 * ?, 其中最后一位只能用？，而不能使用*，如果使用*表示不管星期几都会触发，实际上并不是这样。 
(3)-:表示范围，例如在Minutes域使用5-20，表示从5分到20分钟每分钟触发一次 
(4)/：表示起始时间开始触发，然后每隔固定时间触发一次，例如在Minutes域使用5/20,则意味着5分钟触发一次，而25，45等分别触发一次. 
(5),:表示列出枚举值值。例如：在Minutes域使用5,20，则意味着在5和20分每分钟触发一次。 
(6)L:表示最后，只能出现在DayofWeek和DayofMonth域，如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。 
(7)W: 表示有效工作日(周一到周五),只能出现在DayofMonth域，系统将在离指定日期的最近的有效工作日触发事件。例如：在DayofMonth使用5W，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日(周一)触发；如果5日在星期一 到星期五中的一天，则就在5日触发。另外一点，W的最近寻找不会跨过月份 
(8)LW:这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。 
(9)#:用于确定每个月第几个星期几，只能出现在DayofMonth域。例如在4#2，表示某月的
星期三。
例子：
每隔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表达式生成：http://qqe2.com/cron/index