前言
定時器功能在專案裡面往往會用到,比如定時傳送郵件、定時釋放資料庫資源;這裡記錄一下springboot對定時器的支援的簡單例項
cron表示式
開始之前要先介紹一下cron表示式,這裡當一下百度百科搬運工:
Cron表示式是一個字串,字串以5或6個空格隔開,分為6或7個域,每一個域代表一個含義,Cron有如下兩種語法格式:
Seconds Minutes Hours DayofMonth Month DayofWeek Year或
Seconds Minutes Hours DayofMonth Month DayofWeek
每一個域可出現的字元如下:
Seconds 可出現", - * /"四個字元,有效範圍為0-59的整數
Minutes 可出現", - * /"四個字元,有效範圍為0-59的整數
Hours 可出現", - * /"四個字元,有效範圍為0-23的整數
DayofMonth 可出現", - * / ? L W C"八個字元,有效範圍為0-31的整數
Month 可出現", - * /"四個字元,有效範圍為1-12的整數或JAN-DEc
DayofWeek 可出現", - * / ? L C #"八個字元,有效範圍為1-7的整數或SUN-SAT兩個範圍。1表示星期天,2表示星期一, 依次類推
Year 可出現", - * /"四個字元,有效範圍為1970-2099年
每一個域都使用數字,但還可以出現如下特殊字元,它們的含義是:
(1)* 表示匹配該域的任意值,假如在Minutes域使用*, 即表示每分鐘都會觸發事件。
(2)? 只能用在DayofMonth和DayofWeek兩個域。它也匹配域的任意值,但實際不會。因為DayofMonth和DayofWeek會相互影響。例如想在每月的20日觸發排程,不管20日到底是星期幾,則只能使用如下寫法: 13 13 15 20 * ?, 其中最後一位只能用?,而不能使用*,如果使用*表示不管星期幾都會觸發,實際上並不是這樣。
(3)- 表示範圍,例如在Minutes域使用5-20,表示從5分到20分鐘每分鐘觸發一次
(4)/ 表示起始時間開始觸發,然後每隔固定時間觸發一次,例如在Minutes域使用5/20,則意味著5分鐘觸發一次,而25,45等分別觸發一次.
(5), 表示列出列舉值值。例如:在Minutes域使用5,20,則意味著在5和20分每分鐘觸發一次。
(6)L 表示最後,只能出現在DayofWeek和DayofMonth域,如果在DayofWeek域使用5L,意味著在最後的一個星期四觸發。
(7)W 表示有效工作日(週一到週五),只能出現在DayofMonth域,系統將在離指定日期的最近的有效工作日觸發事件。例如:在 DayofMonth使用5W,如果5日是星期六,則將在最近的工作日:星期五,即4日觸發。如果5日是星期天,則在6日(週一)觸發;如果5日在星期一到星期五中的一天,則就在5日觸發。另外一點,W的最近尋找不會跨過月份
(8)LW 這兩個字元可以連用,表示在某個月最後一個工作日,即最後一個星期五。
(9)# 用於確定每個月第幾個星期幾,只能出現在DayofMonth域。例如在4#2,表示某月的第二個星期三。
舉幾個例子:
"0 0 2 1 * ? * " 表示在每月的1日的凌晨2點排程任務
"0 15 10 ? * MON-FRI" 表示週一到週五每天上午10:15執行作業
"0 15 10 ? 6L 2002-2006" 表示2002-2006年的每個月的最後一個星期五上午10:15執行作
"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觸發
0 0 * * * ? 每隔一個小時執行一次 0 0/10 * * * ? 每隔十分鐘執行一次 0 * * * * ? 每隔一分鐘執行一次
上面的例子我沒有測試過,如果要用大家最好自己先進行測試。
SpringBoot的支援
在啟動類加註解: @EnableScheduling //允許支援定時器了
/** * 啟動主類,springboot的入口 * springboot 預設掃描的類是在啟動類的當前包和下級包 */@SpringBootApplication@EnableScheduling //允許支援定時器了public class SpringbootWebsocketSpringdataJpaApplication { public static void main(String[] args) { SpringApplication.run(SpringbootWebsocketSpringdataJpaApplication.class, args); }}
編寫定時器類
/** * 測試定時器 */@Componentpublic class TestScheduler { @Scheduled(cron="0/30 * * * * ?") private void test(){ System.err.println("這句話每30秒列印一次 "+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); }}
效果
更新
2021-03-09更新
當有多個方法使用@Scheduled註解時,就會建立多個定時任務到任務列表中,當其中一個任務沒執行完時,其它任務在阻塞隊列當中等待,因此,所有的任務都是按照順序執行的
/** * 測試定時器 */@Component@Slf4jpublic class TestScheduler { @Scheduled(cron = "0/1 * * * * ?") public void taskA() { log.info("taskA方法(這句話每1秒列印一次)"+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); } @Scheduled(cron = "0/2 * * * * ?") public void taskB() { try { log.info("taskB方法(這句話每2秒列印一次)"+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); Thread.sleep(3000); } catch (InterruptedException e) { e.printStackTrace(); } }}
那麼要如何實現定時器多執行緒去執行呢?
我們可以配置定時任務執行緒池
/** * 定時器執行緒池配置 */@Configurationpublic class ScheduleConfig implements SchedulingConfigurer { @Override public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { taskRegistrar.setScheduler(getExecutor()); } @Bean public Executor getExecutor(){ return new ScheduledThreadPoolExecutor(5); }}
或者使用@Async優雅非同步呼叫
/** * 測試定時器 */@Component@Slf4jpublic class TestScheduler { @Async("asyncTaskExecutor") @Scheduled(cron = "0/1 * * * * ?") public void taskA() { log.info("taskA方法(這句話每1秒列印一次)"+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); } @Async("asyncTaskExecutor") @Scheduled(cron = "0/2 * * * * ?") public void taskB() { try { log.info("taskB方法(這句話每2秒列印一次)"+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); Thread.sleep(3000); } catch (InterruptedException e) { e.printStackTrace(); } }}
結束語
兩三個註解就可以輕鬆實現定時器,很強很簡單
程式碼開源
程式碼已經開源、託管到我的GitHub、碼雲:
GitHub:https://github.com/huanzi-qch/springBoot
碼雲:https://gitee.com/huanzi-qch/springBoot
出處:https://www.cnblogs.com/huanzi-qch