Spring Boot實現定時任務新解,你是否能get到?

2020-12-11 探險家之指路明燈

在日常的開發過程中經常使用到定時任務，在springMVC的開發中，經常和quartz框架進行集成使用，但在springboot中沒有這麼做，而是使用了java的線程池來實現定時任務。

一、概述

在springboot中使用定時任務非常簡單，只需要簡單的幾步即可完成。

二、詳述

在springboot中要使用定時任務，首先要保證環境是springboot的，這裡使用的是springboot-2.1.2.release版本。在啟動類上加@EnableScheduling註解，如下，

package com.example.demo;import com.example.demo.properties.ApplicationPro;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.boot.context.properties.EnableConfigurationProperties;import org.springframework.scheduling.annotation.EnableScheduling;@SpringBootApplication@EnableConfigurationProperties({ApplicationPro.class})//引入開啟定時任務的註解@EnableSchedulingpublic class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); }}@EnableScheduling註解的作用就是開啟對定時任務的支持，這個註解的作用是開啟定時任務的自動配置。

在使用了@EnableScheduling註解後便可以編寫具體的定時任務的job類，該job類無需繼承或實現任何接口，只要是一個被spring管理的類即可。為了使spring可以管理統一使用@Component註解標識。在定時任務的類中的方法上標識@Scheduled註解便可以定時執行該方法，@Scheduled註解上有幾種不同的屬性，看具體的該註解的定義，

fixedDelay

@Scheduled(fixedDelay=1000)/@Scheduled(fixedDelay="1000")的意思是該方法執行完後每隔1000ms執行一次。看具體的代碼

package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulFixedRelayTest { //@Scheduled(fixedDelay = 5000) public void jobTest(){ try { log.info("使用fixedDelay的定時任務"); Thread.sleep(10*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}看執行結果，

2020-12-09 22:02:47.511 INFO 7368 --- [ main] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 940 ms2020-12-09 22:02:47.681 INFO 7368 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor'2020-12-09 22:02:47.782 INFO 7368 --- [ main] o.s.s.c.ThreadPoolTaskScheduler : Initializing ExecutorService 'taskScheduler'2020-12-09 22:02:47.802 INFO 7368 --- [ scheduling-1] c.e.demo.job.SchedulFixedRelayTest : 使用fixedDelay的定時任務2020-12-09 22:02:47.820 INFO 7368 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''2020-12-09 22:02:47.823 INFO 7368 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.627 seconds (JVM running for 2.51)2020-12-09 22:03:02.819 INFO 7368 --- [ scheduling-1] c.e.demo.job.SchedulFixedRelayTest : 使用fixedDelay的定時任務2020-12-09 22:03:17.834 INFO 7368 --- [ scheduling-1] c.e.demo.job.SchedulFixedRelayTest : 使用fixedDelay的定時任務看上面列印的執行時間，第一次在2020-12-09 22:02:47，由於程序會睡眠10秒，也就是說回在22:02:57執行完，那麼下次執行應該在22:03:02，看第二次列印的時間剛好和上面的一樣，那就證明了，該配置是在方法執行完成後每隔XX秒執行一次。

fixedRate

@Scheduled(fixedRate=1000)/@Scheduled(fixedRate="1000")的意思是該方法執行完後每隔1000ms執行一次，但是如果任務執行的時間超過了配置的時間，則在任務執行完會再次執行。

任務時間小於配置的時間

package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulFixedRateTest { @Scheduled(fixedRate = 5000) public void jobTest(){ try { log.info("使用fixedRate的定時任務"); Thread.sleep(1*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}任務會睡眠1s也就是任務耗時1s，fixedRate配置的是每隔5s，由於任務時間小於配置的時間，所以會每隔5s執行一次，看執行結果，

2020-12-09 22:16:16.156 INFO 2800 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時任務2020-12-09 22:16:16.188 INFO 2800 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''2020-12-09 22:16:16.188 INFO 2800 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.625 seconds (JVM running for 2.462)2020-12-09 22:16:21.178 INFO 2800 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時任務2020-12-09 22:16:26.180 INFO 2800 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時任務看列印的任務時間都是每隔5s執行一次。

任務時間大於配置的時間

看任務的執行時間列印配置的時間的情況，

package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulFixedRateTest { @Scheduled(fixedRate = 5000) public void jobTest(){ try { log.info("使用fixedRate的定時任務"); Thread.sleep(10*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}這裡任務執行10s，配置的時間為5s。看執行結果，

2020-12-09 22:17:44.070 INFO 12952 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時任務2020-12-09 22:17:44.102 INFO 12952 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''2020-12-09 22:17:44.102 INFO 12952 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.626 seconds (JVM running for 2.462)2020-12-09 22:17:54.071 INFO 12952 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時任務2020-12-09 22:18:04.085 INFO 12952 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時任務從上面的結果可以看到任務是每隔10s執行一次，由於任務耗時大於了配置的時長，所以任務執行完以後便會進入下次的執行。

cron

cron表達式共7位，分別是秒、分、小時、日、月、周、年。cron表達式可以從網上找，如下，

https://cron.qqe2.com/

通過cron在線生成，分別設置值，如，0/5 * * * * ? 每隔5s執行一次，

package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulCronTest { @Scheduled(cron = "0/5 * * * * ?") public void jobTest(){ try { log.info("使用cron的定時任務"); Thread.sleep(10*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}每隔5s執行一次，任務耗時10s，看下執行結果，

2020-12-09 22:41:42.718 INFO 17828 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.609 seconds (JVM running for 2.453)2020-12-09 22:41:45.015 INFO 17828 --- [ scheduling-1] com.example.demo.job.SchedulCronTest : 使用cron的定時任務2020-12-09 22:42:00.004 INFO 17828 --- [ scheduling-1] com.example.demo.job.SchedulCronTest : 使用cron的定時任務2020-12-09 22:42:15.000 INFO 17828 --- [ scheduling-1] com.example.demo.job.SchedulCronTest : 使用cron的定時任務可以看到是每隔15s執行一次，也就是如果配置的時間間隔小於任務耗時，那麼在任務執行完後的時間間隔後再執行，在此種情況下和fixDelay的用法一致。

三、總結

本文分析了springboot中定時任務的使用，

首先，使用@EnableScheduling開啟定時任務的自動配置；

其次，任務類必須受spring管理（使用@Component、@Service等註解均可）；

最後，任務方法使用@Scheduled註解標識，該註解有3中不同的屬性配置，fixedDelay、fixedRate、cron；

有不正之處，歡迎指正，感謝！

原文連結：https://www.cnblogs.com/teach/p/14106194.html

如果覺得本文對你有幫助，可以轉發關注支持一下

相關焦點

  • 實戰Spring Boot 2.0系列:單機定時任務的幾種實現
    ScheduledExecutorServiceJDK 自帶的一個類，是基於 線程池設計的定時任務類，每個 調度任務 都會分配到 線程池 中的一個 線程 去執行。} dependencies { classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") }}apply plugin: 'java'
  • 為什麼你的 Spring Task 定時任務沒有定時執行?
    SpringBoot 定時任務的原理相信絕大部分開發者都使用過Spring Boot 為我們提供的定時任務的 Starter 和定時任務的註解。所以我們來主要介紹一下 Spring Boot 實現定時任務的原理，和其相關註解的作用。
  • Spring Boot 採用Sharding-JDBC 實現Mybaits的分庫分表功能
    </groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId>
  • Spring SPI和Spring Boot SPI - 第345篇
    但是有個原則：=後面必須是key的實現類（子類）。（2）在spring.factories文件中可以指定多個key，對於java spi如果多個接口的話，需要配置多個文件。       可以發現這個自動配置註解在另一個工程，而這個工程裡也有個spring.factories文件，如下圖：       我們知道在SpringBoot的目錄下有個spring.factories文件，裡面都是一些接口的具體實現類，可以由SpringFactoriesLoader加載。
  • Spring Boot 單元測試
    Spring Boot中引入單元測試很簡單，添加如下依賴（即spring-boot-starter-test依賴）：<dependency>   <groupId>org.springframework.boot</groupId>
  • 基於Spring Boot 2.2.6實現Rest風格的文件上傳&下載APIs-附源碼
    在本教程中，我將基於Spring 2.2.6版本實現一個基於Restful風格的文件上傳與下載APIs。基於Spring Boot 2.0實戰系列源碼已經Push到Github倉庫：https://github.com/ramostear/springboot2.0-action 。感興趣的朋友歡迎Star/Fork。1.
  • Spring Boot集成JDBCTemplate
    在整個系統中，java應用程式通過JDBC提供的API連接到JDBC Driver，而這些JDBC驅動器的具體實現是由各大資料庫廠家針對JDBC規範而編寫，並提供給使用者。Spring Boot集成添加依賴首先添加依賴：<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc
  • Spring Boot Security 詳解
    </groupId> <artifactId>spring-boot-starter-security</artifactId></dependency><dependency> <groupId>org.springframework.boot</groupId>
  • 【保姆級教程】Spring Boot 單元測試
    Spring Boot中引入單元測試很簡單，添加如下依賴（即spring-boot-starter-test依賴）：<dependency>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-test
  • 2021 最新版 Spring Boot 速記教程
    需要注意的是不同的 starter 是為了解決不同的依賴，所以它們內部的實現可能會有很大的差異，例如 jpa 的 starter 和 Redis 的 starter 可能實現就不一樣，這是因為 starter 的本質在於 synthesize，這是一層在邏輯層面的抽象，也許這種理念有點類似於 Docker，因為它們都是在做一個「包裝」的操作，如果你知道 Docker 是為了解決什麼問題的，也許你可以用
  • Spring Boot 的單元測試和集成測試
    你可在網上找到大量關於這個主題的教程，但很難在一個頁面中找到你需要的所有信息。我經常注意到初級開發人員混淆了單元測試和集成測試的概念，特別是在談到 Spring 生態系統時。我將嘗試講清楚不同註解在不同上下文中的用法。2. 單元測試 vs.
  • Spring Boot 啟動事件和監聽器,太強大了!
    一般來說，我們很少會使用到應用程式事件，但我們也不要忘了它們的存在，比如說在 Spring 框架內部都使用了各種不同的事件來處理不同的任務。Spring Boot 基礎的構建這裡就不介紹了，如果你對 Spring Boot 還不是很熟悉，或者只是會簡單的使用，那還是建議你深入學習下吧，推薦這個 Spring Boot 學習倉庫，歡迎 Star 關注：https://github.com/javastacks/spring-boot-best-practice1、新建監聽器
  • Springboot2.2.6構建RabbitMQ消息發布端代碼
    RabbitMQ官網：www.rabbitmq.com 上次介紹了RabbitMQ底層核心原理，即AMQP協議及模型，以及模型所涉及的組件都是什麼具體到應用開發，需要使用RabbitMQ API來實現具體業務場景
  • 1小時學會spring boot,人人都可以成為架構師「手稿」
    之前看到別人一本書，借來觀看，也感謝JZ給我解析一些要點，因為還給別人，所以花了兩天通宵把spring boot這本書看完和做了要點筆記，然後把書還給別人， 因為一邊看書一邊盲寫，字有點醜，會有個別字寫的有點潦草，大家可以聯繫上下文理解，希望不嫌棄。
  • Spring Boot 實現RESTful webservice服務端示例
    See the License for the specific language governing * permissions and limitations under the License. */ package org.witpool; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication
  • Spring Boot 2.X 實戰--SQL 資料庫(MyBatis)
    這裡需要你提前安裝好 MySQL 或其他 SQL 資料庫。Gradle 依賴 1dependencies { 2    implementation 'org.springframework.boot:spring-boot-starter-web' 3    implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter
  • Spring Boot 配置文件的多環境實現
    可以獲取spring.application.json 或者 SPRING_APPLICATION_JSON的參數作為spring boot參數一種方式可以設置系統參數放入到systemProperties環境中配置運行參數 。
  • 基於Spring Boot和Spring Cloud實現微服務架構
    因為網上流傳的多數資料是官網翻譯而來，很多描述的重點也都偏向於作者自身碰到的問題，這樣就很容易讓你理解和操作出現偏差，最開始我就進入了這樣誤區。官網的技術導讀真的描述的很詳細，雖然對於我們看英文很費勁，但如果英文不是很差，請選擇沉下心去讀，你一定能收穫好多。
  • 一文搞懂如何在Spring Boot 正確中使用JPA
    ;artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId>
  • Spring Boot 和 Spring 到底有啥區別?
    Web應用程式：<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.0.6.RELEASE<