腳本之家服務器常用軟件

快捷導航

SpringBoot中實現(xiàn)定時任務的4種方式詳解

更新時間：2023年11月14日 09:46:35 作者：huayang183

這篇文章主要介紹了SpringBoot中實現(xiàn)定時任務的4種方式詳解,在Springboot中定時任務是一項經(jīng)常能用到的功能,實現(xiàn)定時任務的方式有很多,今天來介紹常用的幾種,需要的朋友可以參考下

實現(xiàn)定時任務的方法

Timer：這是java自帶的java.util.Timer類，這個類允許你調(diào)度一個java.util.TimerTask任務。使用這種方式可以讓你的程序按照某一個頻度執(zhí)行，但不能在指定時間運行。一般用的較少。
ScheduledExecutorService：也jdk自帶的一個類；是基于線程池設計的定時任務類,每個調(diào)度任務都會分配到線程池中的一個線程去執(zhí)行,也就是說,任務是并發(fā)執(zhí)行,互不影響。
Spring Task：Spring3.0以后自帶的task，可以將它看成一個輕量級的Quartz，而且使用起來比Quartz簡單許多。
Quartz：這是一個功能比較強大的的調(diào)度器，可以讓你的程序在指定時間執(zhí)行，也可以按照某一個頻度執(zhí)行，配置起來稍顯復雜。

使用Timer

這個目前在項目中用的較少，直接貼demo代碼。具體的介紹可以查看api

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();
       //安排指定的任務在指定的時間開始進行重復的固定延遲執(zhí)行。這里是每3秒執(zhí)行一次
       timer.schedule(timerTask,10,3000);
   }
}

使用ScheduledExecutorService

該方法跟Timer類似，直接看demo：

public class TestScheduledExecutorService {
   public static void main(String[] args) {
       ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();
       // 參數(shù)：1、任務體 2、首次執(zhí)行的延時時間
       //      3、任務執(zhí)行間隔 4、間隔時間單位
       service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, TimeUnit.SECONDS);
   }
}

使用Spring Task

簡單的定時任務

在SpringBoot項目中，我們可以很優(yōu)雅的使用注解來實現(xiàn)定時任務，首先創(chuàng)建項目，導入依賴：

<dependencies>
 
 <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 
 <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter</artifactId>
 </dependency>
 
 <dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <optional>true</optional>
 </dependency>
 
 <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-test</artifactId>
   <scope>test</scope>
 </dependency>
 
</dependencies>

創(chuàng)建任務類：

@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注解開啟對定時任務的支持，然后啟動項目

推薦：Spring快速開啟計劃?？梢钥吹饺齻€定時任務都已經(jīng)執(zhí)行，并且使同一個線程中串行執(zhí)行，如果只有一個定時任務，這樣做肯定沒問題，當定時任務增多，如果一個任務卡死，會導致其他任務也無法執(zhí)行。關注Java技術棧微信公眾號，在后臺回復關鍵字：spring，可以獲取更多棧長整理的 Spring 系列技術干貨。

多線程執(zhí)行

在傳統(tǒng)的Spring項目中，我們可以在xml配置文件添加task的配置，而在SpringBoot項目中一般使用config配置類的方式添加配置，所以新建一個AsyncConfig類。

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

@Configuration：表明該類是一個配置類

@EnableAsync：開啟異步事件的支持

然后在定時任務的類或者方法上添加@Async 。最后重啟項目，每一個任務都是在不同的線程中。

執(zhí)行時間的配置

在上面的定時任務中，我們在方法上使用@Scheduled注解來設置任務的執(zhí)行時間，并且使用三種屬性配置方式：

fixedRate：定義一個按一定頻率執(zhí)行的定時任務

fixedDelay：定義一個按一定頻率執(zhí)行的定時任務，與上面不同的是，改屬性可以配合initialDelay，定義該任務延遲執(zhí)行時間。

cron：通過表達式來配置任務執(zhí)行時間

cron表達式詳解

一個cron表達式有至少6個（也可能7個）有空格分隔的時間元素。按順序依次為：

秒（0~59）
分鐘（0~59）
小時（0~23）
天（0~31）
月（0~11）
星期（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，F(xiàn)RI，SAT）
年份（1970－2099）

其中每個元素可以是一個值(如6),一個連續(xù)區(qū)間(9-12),一個間隔時間(8-18/4)(/表示每隔4小時),一個列表(1,3,5),通配符。由于”月份中的日期”和”星期中的日期”這兩個元素互斥的,必須要對其中一個設置。推薦：Spring快速開啟計劃。

配置實例：

每隔5秒執(zhí)行一次：/5 * ?
每隔1分鐘執(zhí)行一次：0 /1 ?
0 0 10,14,16 ? 每天上午10點，下午2點，4點
0 0/30 9-17 ? 朝九晚五工作時間內(nèi)每半小時
0 0 12 ? * WED 表示每個星期三中午12點
“0 0 12 ?” 每天中午12點觸發(fā)
“0 15 10 ? “ 每天上午10:15觸發(fā)
“0 15 10 ?” 每天上午10:15觸發(fā)
“0 15 10 ? *” 每天上午10:15觸發(fā)
“0 15 10 ? 2005” 2005年的每天上午10:15觸發(fā)
“0 14 * ?” 在每天下午2點到下午2:59期間的每1分鐘觸發(fā)
“0 0/5 14 ?” 在每天下午2點到下午2:55期間的每5分鐘觸發(fā)
“0 0/5 14,18 ?” 在每天下午2點到2:55期間和下午6點到6:55期間的每5分鐘觸發(fā)
“0 0-5 14 ?” 在每天下午2點到下午2:05期間的每1分鐘觸發(fā)
“0 10,44 14 ? 3 WED” 每年三月的星期三的下午2:10和2:44觸發(fā)
“0 15 10 ? * MON-FRI” 周一至周五的上午10:15觸發(fā)
“0 15 10 15 * ?” 每月15日上午10:15觸發(fā)
“0 15 10 L * ?” 每月最后一日的上午10:15觸發(fā)
“0 15 10 ? * 6L” 每月的最后一個星期五上午10:15觸發(fā)
“0 15 10 ? * 6L 2002-2005” 2002年至2005年的每月的最后一個星期五上午10:15觸發(fā)
“0 15 10 ? * 6#3” 每月的第三個星期五上午10:15觸發(fā)

有些子表達式能包含一些范圍或列表

例如：子表達式（天（星期））可以為 “MON-FRI”，“MON，WED，F(xiàn)RI”，“MON-WED,SAT”

“*”字符代表所有可能的值 “/”字符用來指定數(shù)值的增量

例如：在子表達式（分鐘）里的“0/15”表示從第0分鐘開始，每15分鐘在子表達式（分鐘）里的“3/20”表示從第3分鐘開始，每20分鐘（它和“3，23，43”）的含義一樣

“？”字符僅被用于天（月）和天（星期）兩個子表達式，表示不指定值當2個子表達式其中之一被指定了值以后，為了避免沖突，需要將另一個子表達式的值設為“？”

“L” 字符僅被用于天（月）和天（星期）兩個子表達式，它是單詞“last”的縮寫如果在“L”前有具體的內(nèi)容，它就具有其他的含義了。

例如：“6L”表示這個月的倒數(shù)第６天注意：在使用“L”參數(shù)時，不要指定列表或范圍，因為這會導致問題

W 字符代表著平日(Mon-Fri)，并且僅能用于日域中。它用來指定離指定日的最近的一個平日。大部分的商業(yè)處理都是基于工作周的，所以 W 字符可能是非常重要的。

例如，日域中的 15W 意味著 “離該月15號的最近一個平日。” 假如15號是星期六，那么 trigger 會在14號(星期五)觸發(fā)，因為星期四比星期一離15號更近。

C：代表“Calendar”的意思。它的意思是計劃所關聯(lián)的日期，如果日期沒有被關聯(lián)，則相當于日歷中所有日期。

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

整合Quartz

添加依賴

如果SpringBoot版本是2.0.0以后的，則在spring-boot-starter中已經(jīng)包含了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>

這里我使用SpringBoot版本是2.0.0.BUILD-SNAPSHOT ，該版本開始集成了Quartz，所以事實現(xiàn)起來很方便。其它好像比較麻煩，這里就不介紹，以后有時間再詳細深入了解Quartz。

創(chuàng)建任務類TestQuartz，該類主要是繼承了QuartzJobBean

public class TestQuartz extends QuartzJobBean {
 
    /**
     * 執(zhí)行定時任務
     * @param jobExecutionContext
     * @throws JobExecutionException
     */
 
    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
 
        System.out.println("quartz task "+new Date());
 
    }
 
}

創(chuàng)建配置類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();
    }
}

啟動項目

上面都是簡單的介紹了關于SpringBoot定時任務的處理，直接使用SpringTask注解的方式應該是最方便的，而使用Quartz從2.0開始也變得很方便。對于這兩種方式，應該說各有長處吧，按需選擇。另外關于Quartz的詳細內(nèi)容可以查看官方文檔