SpringBoot中使用@Scheduled注解創(chuàng)建定時任務(wù)的實現(xiàn)

更新時間：2020年06月19日 16:01:47 作者：fastlearn

這篇文章主要介紹了SpringBoot中使用@Scheduled注解創(chuàng)建定時任務(wù)的實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

在項目日常開發(fā)過程中，經(jīng)常需要定時任務(wù)來幫我們做一些工作，如清理日志。定時任務(wù)的實現(xiàn)方法主要有 Timer、Quartz 以及 elastic-job

Timer 實現(xiàn)定時任務(wù)

只執(zhí)行一次的定時任務(wù)

Timer timer = new Timer();
timer.schedule(new TimerTask() {
 @Override
 public void run() {
  System.out.println("2000毫米后執(zhí)行一次。");
 }
}, 2000);

timer.schedule(new TimerTask() {
 @Override
 public void run() {
  System.out.println("5000毫米后執(zhí)行一次。");
 }
}, new Date(System.currentTimeMillis() + 5000));

循環(huán)執(zhí)行任務(wù)

Timer timer = new Timer();
timer.schedule(new TimerTask() {
 @Override
 public void run() {
  System.out.println(111);
 }
}, 1000, 2000); // 1000毫米后執(zhí)行第一次，之后每2000毫米執(zhí)行一次

終止任務(wù)

timer.concel();

Timer 是 JDK 實現(xiàn)的定時任務(wù)，用起來簡單、方便，對一些簡單的定時任務(wù)可以使用它。由于它不支持 cron 表達(dá)式，現(xiàn)在已經(jīng)很少用了。

Quartz 實現(xiàn)定時任務(wù)

Quartz 是一個完全由　Java 編寫的開源作業(yè)調(diào)度框架，可以用它來實現(xiàn)定時任務(wù)。

在 pom.xml 文件添加 Quartz 依賴

<dependency>
 <groupId>org.quartz-scheduler</groupId>
 <artifactId>quartz</artifactId>
 <version>2.2.1</version>
</dependency>
<dependency>
 <groupId>org.quartz-scheduler</groupId>
 <artifactId>quartz-jobs</artifactId>
 <version>2.2.1</version>
</dependency>

<dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 <version>1.7.25</version>
</dependency>

<dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-simple</artifactId>
 <version>1.7.6</version>
</dependency>

編寫 Job

定時執(zhí)行的任務(wù)

public class QuartzJob implements Job{

 public void execute(JobExecutionContext context) throws JobExecutionException {
  JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
  String hello = (String) jobDataMap.get("hello");
  System.err.println(hello);
 }
 
}

編寫 Task

public void task() {
 // 該 map 可在 job 中獲取
 JobDataMap map = new JobDataMap();
 map.put("hello", "world");

 JobDetail jobDetail = newJob(QuartzJob.class).
   withIdentity("myJob", "myGroup").
   setJobData(map).build();
 /*
  * 簡單定時器
  *
  * 執(zhí)行時間間隔
  * withIntervalInMilliSeconds 毫秒
  * withIntervalInSeconds 秒
  * withIntervalInMinutes 分鐘
  * withIntervalInHours 小時
  *
  * 執(zhí)行次數(shù)
  * repeatForever 重復(fù)執(zhí)行
  * withRepeatCount 次數(shù)
  */
 SimpleScheduleBuilder scheduleBuilder = simpleSchedule().withIntervalInSeconds(3).withRepeatCount(10);

 /*
  * corn定時器
  *
  * corn表達(dá)式，使用更靈活
  * corn表達(dá)式在線生成 http://cron.qqe2.com/
  */
 CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0 0 0 1 * ?");

 Trigger trigger = newTrigger().startAt(new Date()).//startNow() 默認(rèn)現(xiàn)在開始
   withIdentity("myTrigger", "myGroup").
   //withSchedule(scheduleBuilder).build();
   withSchedule(cronScheduleBuilder).build();

 try {
  //1.創(chuàng)建Scheduler工廠
  SchedulerFactory schedulerFactory = new StdSchedulerFactory();
  //2.獲取實例
  Scheduler scheduler = schedulerFactory.getScheduler();
  //3.設(shè)置jobDetail詳情和trigger觸發(fā)器
  scheduler.scheduleJob(jobDetail, trigger);
  //4.定時任務(wù)開始
  scheduler.start();
 } catch (SchedulerException e) {
  e.printStackTrace();
 }

}

在項目啟動的時候調(diào)用 task 方法即可啟動定時任務(wù)。

Spring Boot 創(chuàng)建定時任務(wù)

Spring Boot 默認(rèn)已經(jīng)實現(xiàn)了定時任務(wù)，只需要添加相應(yīng)的注解即可完成

pom.xml 文件配置

pom.xml 不需要添加其他依賴，只需要加入 Spring Boot 依賴即可，這里我們添加一個 web 和 test 的依賴

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

在啟動類上面加上 @EnableScheduling 注解

在啟動類上面加上 @EnableScheduling 注解即可開啟定時任務(wù)

@EnableScheduling
@SpringBootApplication
public class SchedulingApplication {

 public static void main(String[] args) {
 SpringApplication.run(SchedulingApplication.class, args);
 }
}

編寫定時任務(wù)

@Component
public class ScheduledTask {

 @Scheduled(initialDelay=1000, fixedDelay = 1000)
 public void task1() {
  System.out.println("延遲1000毫秒后執(zhí)行，任務(wù)執(zhí)行完1000毫秒之后執(zhí)行！");
  try {
   Thread.sleep(2000);
  } catch (InterruptedException e) {
   e.printStackTrace();
  }
 }

 @Scheduled(fixedRate = 2000)
 public void task2() {
  System.out.println("延遲1000毫秒后執(zhí)行，之后每2000毫秒執(zhí)行一次！");
 }

}

除了這些還支持 cron 表達(dá)式

@Scheduled(cron = "*/2 * * * * ?")
public void task3() {
 System.out.println("每2秒執(zhí)行一次！");
}

啟動 Spring Boot 項目在控制臺就會看到任務(wù)定時執(zhí)行

cron 表達(dá)式

以下是 cron 表達(dá)式的的兩種語法

Seconds Minutes Hours DayofMonth Month DayofWeek Year
Seconds Minutes Hours DayofMonth Month DayofWeek

每一個域可出現(xiàn)的字符如下：

Seconds:可出現(xiàn)", - * /"四個字符，有效范圍為0-59的整數(shù)
Minutes:可出現(xiàn)", - * /"四個字符，有效范圍為0-59的整數(shù)
Hours:可出現(xiàn)", - * /"四個字符，有效范圍為0-23的整數(shù)
DayofMonth:可出現(xiàn)", - * / ? L W C"八個字符，有效范圍為0-31的整數(shù)
Month:可出現(xiàn)", - * /"四個字符，有效范圍為1-12的整數(shù)或JAN-DEc
DayofWeek:可出現(xiàn)", - * / ? L C #"四個字符，有效范圍為1-7的整數(shù)或SUN-SAT兩個范圍。1表示星期天，2表示星期一，依次類推
Year:可出現(xiàn)", - * /"四個字符，有效范圍為1970-2099年

舉幾個例子

*/2 * * * * ? 表示每2秒執(zhí)行一次！
0 0 2 1 * ? * 表示在每月的1日的凌晨2點調(diào)度任務(wù) 
0 15 10 ? * MON-FRI 表示周一到周五每天上午10：15執(zhí)行作業(yè) 
0 15 10 ? 6L 2002-2006 表示2002-2006年的每個月的最后一個星期五上午10:15執(zhí)行作

推薦一個 cron 表達(dá)式在線生成工具

http://tools.jb51.net/code/Quartz_Cron_create

參考資料

本文所有代碼放在 Github 上

到此這篇關(guān)于SpringBoot中使用@Scheduled注解創(chuàng)建定時任務(wù)的實現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot創(chuàng)建定時任務(wù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: