SpringBoot 定时任务实现方式

定时任务实现的几种方式:

Timer:是java自带的java.util.Timer类,这个类容许你调度一个java.util.TimerTask任务。使用这种方式可让你的程序按照某一个频度执行,但不能在指定时间运行。通常用的较少。
ScheduledExecutorService:是jdk自带的一个类,基于线程池设计的定时任务类,每一个调度任务都会分配到线程池中的一个线程去执行,也就是说任务是并发执行,互不影响。
Spring Task:Spring3.0之后自带的task,能够将它当作一个轻量级的Quartz,并且使用起来比Quartz简单许多。
Quartz:是一个功能比较强大的的调度器,可让你的程序在指定时间执行,也能够按照某一个频度执行,配置起来稍显复杂。java

 

一、使用Timer,目前在项目中用的较少,示例以下git

public class TestTimer { public static void main(String[] args) { TimerTask timerTask = new TimerTask() { @Override public void run() { System.out.println("task run:"+ new Date()); } }; Timer timer = new Timer(); //安排指定的任务在指定的时间开始进行重复的固定延迟执行。这里是每3秒执行一次
    timer.schedule(timerTask,10,3000); } 

 

二、使用ScheduledExecutorServicegithub

public class TestScheduledExecutorService { public static void main(String[] args) { ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();    // 参数:一、任务体 二、首次执行的延时时间 三、任务执行间隔 四、间隔时间单位
       service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService " + new Date()), 0, 3, TimeUnit.SECONDS); } } 

 

三、使用Spring Taskspring


3.1 简单的定时任务springboot

建立任务类:多线程

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

在主类上使用@EnableScheduling注解开启对定时任务的支持,这种方式是在同一个线程中串行执行,适合单个线程任务处理,当定时任务增多,若是一个任务卡死,会致使其余任务也没法执行。并发

3.2 多线程执行
在传统的Spring项目中,咱们能够在xml配置文件添加task的配置,而在SpringBoot项目中通常使用config配置类的方式添加配置,因此新建一个AsyncConfig类异步

@Configuration @EnableAsync public class AsyncConfig {   //线程池配置参数(可经过配置文件读取)
  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;   } }

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

而后在定时任务的类或者方法上添加@Async 便支持每个任务都是在不一样的线程中spring-boot

 

附注:定时执行时间的配置

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

fixedRate:定义一个按必定频率执行的定时任务
fixedDelay:定义一个按必定频率执行的定时任务,与上面不一样的是,改属性能够配合initialDelay, 定义该任务延迟执行时间。
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秒执行一次:0/5 * * * * ?
每隔1分钟执行一次:0 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>

建立任务类TestQuartz,该类主要是继承了QuartzJobBean

public class TestQuartz 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的详细内容能够查看官方文档:http://www.quartz-scheduler.org/documentation/

源码参照:Github

相关文章
相关标签/搜索