SpringBoot實戰(二)之計劃任務
計劃任務這個對於Java開發者們,應該不陌生了,非常常用又非常常見。比如jdk自帶的Timer
實現例子如下:
class MyTask extends TimerTask{
@Override
public void run() {
System.out.println("hello world");
}
}
public class TimerDemo {
public static void main(String[] args) {
//創建定時器對象
Timer t=new Timer();
//在3秒後執行MyTask類中的run方法,後面每10秒跑一次
t.schedule(new MyTask(), 3000,10000);
}
}
或者是Spring中的定時任務
@Scheduled(cron = "0 0/1 * * * ? ")
public void test() {
MonitorUrl.testUrlWithTimeOut2018("http://www.test.com:2018/", 2000);
logger.info("每分鐘執行" + System.currentTimeMillis());
}
關於Spring中的定時任務如何使用,可以參考我的這篇博客:Spring定時任務使用和如何使用郵件監控服務器
環境為:JDK8+MAVEN3+Eclipse
下面演示SpringBoot的定時任務,總的來說與上面這些沒有什麽區別。
一、maven依賴
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.springboot</groupId>
<artifactId>springboot002</artifactId>
<version>0.0.1-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.8.RELEASE</version>
</parent>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
二、編寫定時任務類
package hello;
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");
@Scheduled(fixedRate = 5000)
public void reportCurrentTime() {
log.info("The time is now {}", dateFormat.format(new Date()));
}
}
在Scheduled
當特定的方法運行註解定義。註意:此示例使用fixedRate
,指定從每次調用的開始時間開始測量的方法調用之間的間隔。還有其他選項,例如fixedDelay
,它指定從完成任務開始測量的調用之間的間隔。您還可以使用@Scheduled(cron=". . .")
表達式進行更復雜的任務調度。
在這裏順便說說@Component註解,這個註解的意思可理解為掃描
與在對應的配置文件中配置
<bean id="" class=""/>是一樣的。
這裏配置bean意思相當於將這個對象實例化到Spring容器中進行管理。
package hello;
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");
@Scheduled(cron = "0 0/1 * * * ? ")
public void reportCurrentTime() {
log.info("The time is now {}", dateFormat.format(new Date()));
}
}
cron表達式和Linux中的cron基本一致,並無差別要說差別的話,一個是Java的類庫,一個是Linux系統自帶的系統軟件。
cron是表達式,表示在什麽時候進行任務調度。
對於cron表達式的解釋如下:
一個cron表達式有至少6個(也可能7個)有空格分隔的時間元素。
按順序依次為
秒(0~59)
分鐘(0~59)
小時(0~23)
天(月)(0~31,但是你需要考慮你月的天數)
月(0~11)
天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
年份(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”參數時,不要指定列表或範圍,因為這會導致問題
字段 允許值 允許的特殊字符
秒 0-59 , - * /
分 0-59 , - * /
小時 0-23 , - * /
日期 1-31 , - * ? / L W C
月份 1-12 或者 JAN-DEC , - * /
星期 1-7 或者 SUN-SAT , - * ? / L C #
年(可選) 留空, 1970-2099 , - * /
三、編寫啟動類
package hello;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@EnableScheduling
public class Application {
public static void main(String[] args) throws Exception {
SpringApplication.run(Application.class);
}
}
@ComponentScan
告訴Spring在包中尋找其他組件,配置和服務hello
,允許它找到控制器。
與上述@Component結合 就可以保證我配置bean,從而讓@ComponentScan,@ComponentScan顧名思義,即掃描組件,也就是掃描bean
這樣就可以保證加上@Component註解的Java類被掃描到,從而初始化,從而執行對應的定時任務。
@EnableScheduling
要實現計劃任務,首先通過在配置類註解@EnableScheduling來開啟對計劃任務的支持,然後在要執行計劃任務的方法上註解@Scheduled,聲明這是一個計劃任務。
SpringBoot實戰(二)之計劃任務