码恋 码恋

ALL YOUR SMILES, ALL MY LIFE.

目录
Spring boot定时任务
/    

Spring boot定时任务

实现方式

项目中比较常用的定时任务实现方式有两种:

  • Spring Task:Spring3.0以后自带的task,可以将它看成一个轻量级的Quartz,而且使用起来比Quartz简单许多。

  • Quartz:这是一个功能比较强大的的调度器,可以让你的程序在指定时间执 行,也可以按照某一个频度执行,配置起来稍显复杂。

Spring Task

  1. 在Spring Boot的主类中加入@EnableScheduling注解,启用定时任务的配置

    @SpringBootApplication  
    @EnableScheduling  
    public class Application {  
    ​  
     public static void main(String[] args) {  
     SpringApplication.run(Application.class, args);  
     }  
    ​  
    }
    
  2. 使用@Scheduled注解,创建定时任务实现类

    @Component  
    public class ScheduledTasks {  
    ​  
     private static final SimpleDateFormat sdf = new SimpleDateFormat("HH:mm:ss");  
    ​  
     @Scheduled(fixedRate = 5000)  
     public void reportCurrentTime() {  
     System.out.println("当前时间:" + sdf.format(new Date()));  
     }  
    ​  
    }
    

[注意]  当没有增加任何的额外配置时,多个定时任务在同一个线程内串行执行,当有一个任务卡死时,其他的定时任务也不能执行。所以在实际应用时,还需要加入更多的配置,实现多个任务在不同的线程内执行,互不干扰。

多线程配置

@Configuration  
@EnableAsync  
public class AsyncConfig {  
 /**  
 * 使用@Value从properties配置中读取  
 */  
 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注解,就实现了多线程定时任务。

执行时间的配置

在上面的定时任务中,我们在方法上使用@Scheduled注解来设置任务的执行时间,并且使用三种属性配置方式:

  1. fixedRate:定义一个按一定频率执行的定时任务

  2. fixedDelay:定义一个按一定频率执行的定时任务,与上面不同的是,改属性可以配合initialDelay, 定义该任务延迟执行时间。

  3. cron:通过表达式来配置任务执行时间

cron表达式详解

一个cron表达式有至少6个(也可能7个)有空格分隔的时间元素。按顺序依次为:

  • 秒(0~59)

  • 分钟(0~59)

  • 3 小时(0~23)

  • 4 天(0~31)

  • 5 月(0~11)

  • 6 星期(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)

  • 年份(1970-2099)

其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于”月份中的日期”和”星期中的日期”这两个元素互斥的,必须要对其中一个设置。配置实例:

  • 每隔5秒执行一次:/5 * ?

  • 每隔1分钟执行一次:0 /1 ?

  • 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触发

有些子表达式能包含一些范围或列表

例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”

“*”字符代表所有可能的值 “/”字符用来指定数值的增量

例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟 在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样

“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值 当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”

“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写 如果在“L”前有具体的内容,它就具有其他的含义了。

例如:“6L”表示这个月的倒数第6天 注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题

W 字符代表着平日(Mon-Fri),并且仅能用于日域中。它用来指定离指定日的最近的一个平日。大部分的商业处理都是基于工作周的,所以 W 字符可能是非常重要的。

例如,日域中的 15W 意味着 “离该月15号的最近一个平日。” 假如15号是星期六,那么 trigger 会在14号(星期五)触发,因为星期四比星期一离15号更近。

C:代表“Calendar”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。

例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。

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

在线cron表达式生成:http://qqe2.com/cron/index

Quartz

如果SpringBoot版本是2.0.0以后的,则在spring-boot-starter中已经包含了quart的依赖,则可以直接使用spring-boot-starter-quartz依赖:

<dependency>  
 <groupId>org.springframework.boot</groupId>  
 <artifactId>spring-boot-starter-quartz</artifactId>  
</dependency>

如果是1.5.9则要使用以下添加依赖:

<dependency>  
 <groupId>org.quartz-scheduler</groupId>  
 <artifactId>quartz</artifactId>  
 <version>2.3.0</version>  
</dependency>  
<dependency>  
 <groupId>org.springframework</groupId>  
 <artifactId>spring-context-support</artifactId>  
</dependency>
  • 创建任务类QuartzImpl,继承QuartzJobBean
public class QuartzImpl extends QuartzJobBean {  
 /**  
 * 执行定时任务  
 * @param jobExecutionContext  
 * @throws JobExecutionException  
 */  
 @Override  
 protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {  
 System.out.println("quartz task "+new Date());  
 }  
}
  • 创建配置类QuartzConfig
@Configuration  
public class QuartzConfig {  
 @Bean  
 public JobDetail teatQuartzDetail(){  
 return JobBuilder.newJob(TestQuartz.class).withIdentity("testQuartz").storeDurably().build();  
 }  
​  
 @Bean  
 public Trigger testQuartzTrigger(){  
 SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()  
 .withIntervalInSeconds(10)  //设置时间周期单位秒  
 .repeatForever();  
 return TriggerBuilder.newTrigger().forJob(teatQuartzDetail())  
 .withIdentity("testQuartz")  
 .withSchedule(scheduleBuilder)  
 .build();  
 }  
}

这样,就整合了Quartz。


标题:Spring boot定时任务
作者:wangning1018
地址:https://aysaml.com/articles/2019/05/05/1557030350612.html