Spring Boot 的定時任務:
第一種:把參數配置到.properties檔案中:
代碼:
package com.accord.task;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
/**
* 從配置檔案加載任務資訊
* @author 王久印
*/
@Component
public class ScheduledTask {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
//@Scheduled(fixedDelayString = "${jobs.fixedDelay}")
@Scheduled(fixedDelayString = "2000")
public void getTask1() {
System.out.println("任務1,從配置檔案加載任務資訊,目前時間:" + dateFormat.format(new Date()));
}
@Scheduled(cron = "${jobs.cron}")
public void getTask2() {
System.out.println("任務2,從配置檔案加載任務資訊,目前時間:" + dateFormat.format(new Date()));
}
}
application.properties檔案:
jobs.fixedDelay=5000
jobs.cron=0/5 * * * * ?
SpringBootCron2Application.java中:
package com.accord;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@EnableScheduling
public class SpringBootCron2Application {
public static void main(String[] args) {
SpringApplication.run(SpringBootCron2Application.class, args);
}
}
Spring Boot 基礎就不介紹了,推薦看這個免費教程:
https://github.com/javastacks/spring-boot-best-practice
注:@EnableScheduling 這個一定要加上;否則,不會定時啟動任務!
@Scheduled中的參數說明:
-
:上一次開始執行時間點後2秒再次執行;@Scheduled(fixedRate=2000)
-
:上一次執行完畢時間點後2秒再次執行;@Scheduled(fixedDelay=2000)
-
:第一次延遲1秒執行,然後在上一次執行完畢時間點後2秒再次執行;@Scheduled(initialDelay=1000, fixedDelay=2000)
-
:按cron規則執行。@Scheduled(cron="* * * * * ?")
第二種定時任務:單線程和多線程
1、建立定時任務:
package com.accord.task;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
/**
* 建構執行定時任務
* @author 王久印
* TODO
*/
@Component
public class ScheduledTask2 {
private Logger logger = LoggerFactory.getLogger(ScheduledTask2.class);
private int fixedDelayCount = 1;
private int fixedRateCount = 1;
private int initialDelayCount = 1;
private int cronCount = 1;
@Scheduled(fixedDelay = 5000) //fixedDelay = 5000表示目前方法執行完畢5000ms後,Spring scheduling會再次調用該方法
public void testFixDelay() {
logger.info("===fixedDelay: 第{}次執行方法", fixedDelayCount++);
}
@Scheduled(fixedRate = 5000) //fixedRate = 5000表示目前方法開始執行5000ms後,Spring scheduling會再次調用該方法
public void testFixedRate() {
logger.info("===fixedRate: 第{}次執行方法", fixedRateCount++);
}
@Scheduled(initialDelay = 1000, fixedRate = 5000) //initialDelay = 1000表示延遲1000ms執行第一次任務
public void testInitialDelay() {
logger.info("===initialDelay: 第{}次執行方法", initialDelayCount++);
}
@Scheduled(cron = "0 0/1 * * * ?") //cron接受cron表達式,根據cron表達式确定定時規則
public void testCron() {
logger.info("===initialDelay: 第{}次執行方法", cronCount++);
}
}
使用 @Scheduled來建立定時任務 這個注解用來标注一個定時任務方法。
通過看 @Scheduled源碼可以看出它支援多種參數:
- cron:cron表達式,指定任務在特定時間執行;
- fixedDelay:表示上一次任務執行完成後多久再次執行,參數類型為long,機關ms;
- fixedDelayString:與fixedDelay含義一樣,隻是參數類型變為String;
- fixedRate:表示按一定的頻率執行任務,參數類型為long,機關ms;
- fixedRateString: 與fixedRate的含義一樣,隻是将參數類型變為String;
- initialDelay:表示延遲多久再第一次執行任務,參數類型為long,機關ms;
- initialDelayString:與initialDelay的含義一樣,隻是将參數類型變為String;
- zone:時區,預設為目前時區,一般沒有用到。
2、開啟定時任務:
package com.accord;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@EnableScheduling
public class SpringBootCron2Application {
public static void main(String[] args) {
SpringApplication.run(SpringBootCron2Application.class, args);
}
}
注:這裡的 @EnableScheduling 注解,它的作用是發現注解 @Scheduled的任務并由背景執行。沒有它的話将無法執行定時任務。
引用官方文檔原文:
@EnableScheduling ensures that a background task executor is created. Without it, nothing gets scheduled.
3、執行結果(單線程)
就完成了一個簡單的定時任務模型,下面執行springBoot觀察執行結果:
![](https://img.laitimes.com/img/__Qf2AjLwojIjJCLyojI0JCLiAnYldHL0FWby9mZvwFN4ETMfdHLkVGepZ2XtxSZ6l2clJ3LcV2Zh1Wa9M3clN2byBXLzN3btgHL9s2RkBnVHFmb1clWvB3MaVnRtp1XlBXe0xCMy81dvRWYoNHLwEzX5xCMx8FesU2cfdGLwMzX0xiRGZkRGZ0Xy9GbvNGLpZTY1EmMZVDUSFTU4VFRR9Fd4VGdsQTMfVmepNHLrJXYtJXZ0F2dvwVZnFWbp1zczV2YvJHctM3cv1Ce-cmbw5iNycTO3UjMmRDZxY2MkNjNzYzX1ATN0IjMzAzLcFTMyIDMy8CXn9Gbi9CXzV2Zh1WavwVbvNmLvR3YxUjLyM3Lc9CX6MHc0RHaiojIsJye.png)
從控制台輸入的結果中我們可以看出所有的定時任務都是在同一個線程池用同一個線程來處理的,那麼我們如何來并發的處理各定時任務呢,請繼續向下看。
4、多線程處理定時任務:
看到控制台輸出的結果,所有的定時任務都是通過一個線程來處理的,我估計是在定時任務的配置中設定了一個
SingleThreadScheduledExecutor
,于是我看了源碼,從
ScheduledAnnotationBeanPostProcessor
類開始一路找下去。果然,在
ScheduledTaskRegistrar
(定時任務注冊類)中的
ScheduleTasks
中又這樣一段判斷:
if (this.taskScheduler == null) {
this.localExecutor = Executors.newSingleThreadScheduledExecutor();
this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
}
這就說明如果
taskScheduler
為空,那麼就給定時任務做了一個單線程的線程池,正好在這個類中還有一個設定
taskScheduler
的方法:
public void setScheduler(Object scheduler) {
Assert.notNull(scheduler, "Scheduler object must not be null");
if (scheduler instanceof TaskScheduler) {
this.taskScheduler = (TaskScheduler) scheduler;
}
else if (scheduler instanceof ScheduledExecutorService) {
this.taskScheduler = new ConcurrentTaskScheduler(((ScheduledExecutorService) scheduler));
}
else {
throw new IllegalArgumentException("Unsupported scheduler type: " + scheduler.getClass());
}
}
這樣問題就很簡單了,我們隻需用調用這個方法顯式的設定一個
ScheduledExecutorService
就可以達到并發的效果了。我們要做的僅僅是實作
SchedulingConfigurer
接口,重寫
configureTasks
方法就OK了;
package com.accord.task;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import java.util.concurrent.Executors;
/**
* 多線程執行定時任務
* @author 王久印
*/
@Configuration
//所有的定時任務都放在一個線程池中,定時任務啟動時使用不同都線程。
public class ScheduleConfig implements SchedulingConfigurer {
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
//設定一個長度10的定時任務線程池
taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
}
}