Home | 簡體中文 | 繁體中文 | 雜文 | 知乎專欄 | Github | OSChina 博客 | 雲社區 | 雲棲社區 | Facebook | Linkedin | 視頻教程 | 打賞(Donations) | About
知乎專欄多維度架構 | 微信號 netkiller-ebook | QQ群:128659835 請註明“讀者”

2.33. Spring boot with Scheduling

項目中經常會用到計劃任務,spring Boot 中通過@EnableScheduling啟用計劃任務,再通過@Scheduled註解配置計劃任務如果運行。

2.33.1. Application.java

Application.java

啟用計劃任務, 在Spring Boot啟動類加上註解@EnableScheduling,表示該項目啟用計劃任務

			
package api;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@SpringBootApplication
@EnableAutoConfiguration
@ComponentScan({ "api.config", "api.web", "api.rest", "api.service","api.schedule" })
@EnableMongoRepositories
@EnableJpaRepositories
@EnableScheduling
public class Application {

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

}
				
		

開啟計劃任務 @EnableScheduling

確保你的計劃任務在 @ComponentScan 包中。

2.33.2. Component

在計劃任務方法上加上@Scheduled註解,表示該方法是一個計劃任務,項目啟動後會去掃瞄該註解的方法並加入計劃任務列表。

			
			
package api.schedule;

import java.text.SimpleDateFormat;
import java.util.Date;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
public class ScheduledTasks {

	private static final Logger log = LoggerFactory.getLogger(ScheduledTasks.class);
	private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
	public final static long ONE_DAY = 24 * 60 * 60 * 1000;
	public final static long ONE_HOUR = 60 * 60 * 1000;
	
	public ScheduledTasks() {
	// TODO Auto-generated constructor stub
	}
	
	@Scheduled(fixedRate = 5000) //5秒運行一次調度任務
		public void echoCurrentTime() {
		log.info("The time is now {}", dateFormat.format(new Date()));
	}
	
	@Scheduled(fixedRate = ONE_DAY)
		public void scheduledTask() {
		System.out.println("每隔一天執行一次調度任務");
	}
	
	@Scheduled(fixedDelay = ONE_HOUR)
		public void scheduleTask2() {
		System.out.println("運行完後隔一小時就執行任務");
	}
	
	@Scheduled(initialDelay = 1000, fixedRate = 5000)
	public void doSomething() {
		// something that should execute periodically
	}
	
	@Scheduled(cron = "0 0/1 * * * ? ")
		public void ScheduledTask3() {
		System.out.println(" 每隔一分鐘執行一次任務");
	}

}
			
		

2.33.3. 查看日誌

			
tail -f spring.log			
			
		

2.33.4. 計劃任務控制開關

matchIfMissing = true, 如果改屬性條目不存在返回 true

			
@ConditionalOnProperty("batch.metrics.export.influxdb.enabled")

# mybean.enabled = true
@ConditionalOnProperty(value='mybean.enabled')
@ConditionalOnProperty(value = "endpoints.hal.enabled", matchIfMissing = true)

# server.host = localhost
@ConditionalOnProperty(name="server.host", havingValue="localhost")
@ConditionalOnExpression("'${server.host}'=='localhost'")

# spring.rabbitmq.dynamic = true
@ConditionalOnProperty(prefix = "spring.rabbitmq", name = "dynamic", matchIfMissing = true)
@ConditionalOnProperty(prefix = "extension.security.cors", name = "enabled", matchIfMissing = false)
@ConditionalOnProperty(prefix = "camunda.bpm.job-execution", name = "enabled", havingValue = "true", matchIfMissing = true)

# spring.social.auto-connection-views = true
@ConditionalOnProperty(prefix = "spring.social.", value = "auto-connection-views")
			
		

使用案例

			
package mis.schedule;

import java.text.SimpleDateFormat;
import java.util.Date;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@ConditionalOnProperty("mis.schedule.enabled")
@Component
public class ScheduledTasks {
	private static final Logger logger = LoggerFactory.getLogger(ScheduledTasks.class);
	private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-mm-dd HH:mm:ss");
	public final static long ONE_DAY = 24 * 60 * 60 * 1000;
	public final static long ONE_HOUR = 60 * 60 * 1000;
	public final static long ONE_SECOND = 1000;

	public ScheduledTasks() {
		// TODO Auto-generated constructor stub
	}

	@Scheduled(fixedDelay = ONE_SECOND)
	public void scheduleTaskSplitLine() {
		logger.info("==================== {} ====================", dateFormat.format(new Date()));
	}
}
			
		

application.properties 配置如下

			
mis.schedule.enabled=true			
			
		

2.33.5. @Scheduled 詳解

@Scheduled參數說明

			
@Scheduled註解有一些參數,用於配置計劃任務執行頻率,執行時段等。

cron :cron表達式,e.g. {@code "0 * * * * ?"}從前到後依次表示秒 分 時 日 月 年
zone:設置時區,指明計劃任務運行在哪個時區下,預設為空,採用操作系統預設時區
fixedDelay:同一個計劃任務兩次執行間隔固定時間,單位毫秒,上次執行結束到下次開始執行的時間,以long類型複製
fixedDelayString:同一個計劃任務兩次執行間隔固定時間,單位毫秒,上次執行結束到下次開始執行的時間,以String類型賦值
fixedRate:以一個固定頻率執行,單位毫秒,表示每隔多久執行一次,以long類型賦值
fixedRateString:以一個固定頻率執行,單位毫秒,表示每隔多久執行一次,以String類型賦值
initialDelay:延遲啟動計劃任務,單位毫秒,表示執行第一次計劃任務前先延遲一段時間,以long類型賦值
initialDelayString:延遲啟動計劃任務,單位毫秒,表示執行第一次計劃任務前先延遲一段時間,以String賦值
			
		

cron表達式使用空格分隔的時間元素。

			
欄位   允許值   允許的特殊字元
秒	 	0-59	 	, - * /
分	 	0-59	 	, - * /
小時	 	0-23	 	, - * /
日期	 	1-31	 	, - * ? / L W C
月份	 	1-12 或者 JAN-DEC	 	, - * /
星期	 	1-7 或者 SUN-SAT	 	, - * ? / L C #
年(可選)	 	留空, 1970-2099	 	, - * /		

按順序依次為

秒(0~59)

分鐘(0~59)

小時(0~23)

天(月)(0~31,但是你需要考慮你月的天數)

月(0~11)

天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)

7.年份(1970-2099)


其中每個元素可以是一個值(如6),一個連續區間(9-12),一個間隔時間(8-18/4)(/表示每隔4小時),一個列表(1,3,5),通配符。由於"月份中的日期"和"星期中的日期"這兩個元素互斥的,必須要對其中一個設置?.

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”表示一個月的最後一天

在天(星期)自表達式中,“L”表示一個星期的最後一天,也就是SAT

如果在“L”前有具體的內容,它就具有其他的含義了

例如:“6L”表示這個月的倒數第6天,“FRIL”表示這個月的最一個星期五

注意:在使用“L”參數時,不要指定列表或範圍,因為這會導致問題

			
		

2.33.5.1. 每3秒鐘一運行一次

				
@Component
@EnableScheduling
public class MyTask {

    @Scheduled(cron="*/3 * * * * *")
    public void myTaskMethod(){
        //do something
    }
}
				
			

2.33.5.2. 凌晨23點運行

				
	@Scheduled(cron = "0 0 23 * * ?")
	private void cleanNewToday() {
		long begin = System.currentTimeMillis();
        
		redisTemplate.delete("news:today");
    
        long end = System.currentTimeMillis();
		logger.info("Schedule clean redis {} 耗時 {} 秒", "cleanNewFlash()", (end-begin) / 1000 );
	}
				
			

2.33.6. Timer 例子

			
package cn.netkiller.schedule;

import java.util.Date;
import java.util.Timer;
import java.util.TimerTask;

public class TimerTest {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		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);
	}

}
			
			

		

2.33.7. ScheduledExecutorService 例子

		
package cn.netkiller.schedule;

import java.util.Date;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

public class ScheduledExecutorServiceTest {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();

		// 參數:執行命令,初始執行的延時時間,任務執行間隔,間隔時間單位
		service.scheduleAtFixedRate(() -> System.out.println("ScheduledExecutorService " + new Date()), 0, 3, TimeUnit.SECONDS);

	}

}