定時(shí)任務(wù)在實(shí)際的開(kāi)發(fā)中特別常見(jiàn),比如電商平臺(tái) 30 分鐘后自動(dòng)取消未支付的訂單,以及凌晨的數(shù)據(jù)匯總和備份等,都需要借助定時(shí)任務(wù)來(lái)實(shí)現(xiàn),那么我們本文就來(lái)看一下定時(shí)任務(wù)最簡(jiǎn)單的幾種實(shí)現(xiàn)方式。
TOP 1:Timer
Timer 是 JDK 自帶的定時(shí)任務(wù)執(zhí)行類,無(wú)論任何項(xiàng)目都可以直接使用 Timer 來(lái)實(shí)現(xiàn)定時(shí)任務(wù),所以 Timer 的優(yōu)點(diǎn)就是使用方便,它的實(shí)現(xiàn)代碼如下:
public class MyTimerTask {
public static void main(String[] args) {
// 定義一個(gè)任務(wù)
TimerTask timerTask = new TimerTask() {
@Override
public void run() {
System.out.println("Run timerTask:" + new Date());
}
};
// 計(jì)時(shí)器
Timer timer = new Timer();
// 添加執(zhí)行任務(wù)(延遲 1s 執(zhí)行,每 3s 執(zhí)行一次)
timer.schedule(timerTask, 1000, 3000);
}
}
程序執(zhí)行結(jié)果如下:
Run timerTask:Mon Aug 17 21:29:25 CST 2020
Run timerTask:Mon Aug 17 21:29:28 CST 2020
Run timerTask:Mon Aug 17 21:29:31 CST 2020
Timer 缺點(diǎn)分析
Timer 類實(shí)現(xiàn)定時(shí)任務(wù)雖然方便,但在使用時(shí)需要注意以下問(wèn)題。
問(wèn)題 1:任務(wù)執(zhí)行時(shí)間長(zhǎng)影響其他任務(wù)
當(dāng)一個(gè)任務(wù)的執(zhí)行時(shí)間過(guò)長(zhǎng)時(shí),會(huì)影響其他任務(wù)的調(diào)度,如下代碼所示:
public class MyTimerTask {
public static void main(String[] args) {
// 定義任務(wù) 1
TimerTask timerTask = new TimerTask() {
@Override
public void run() {
System.out.println("進(jìn)入 timerTask 1:" + new Date());
try {
// 休眠 5 秒
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("Run timerTask 1:" + new Date());
}
};
// 定義任務(wù) 2
TimerTask timerTask2 = new TimerTask() {
@Override
public void run() {
System.out.println("Run timerTask 2:" + new Date());
}
};
// 計(jì)時(shí)器
Timer timer = new Timer();
// 添加執(zhí)行任務(wù)(延遲 1s 執(zhí)行,每 3s 執(zhí)行一次)
timer.schedule(timerTask, 1000, 3000);
timer.schedule(timerTask2, 1000, 3000);
}
}
程序執(zhí)行結(jié)果如下:
進(jìn)入 timerTask 1:Mon Aug 17 21:44:08 CST 2020
Run timerTask 1:Mon Aug 17 21:44:13 CST 2020
Run timerTask 2:Mon Aug 17 21:44:13 CST 2020
進(jìn)入 timerTask 1:Mon Aug 17 21:44:13 CST 2020
Run timerTask 1:Mon Aug 17 21:44:18 CST 2020
進(jìn)入 timerTask 1:Mon Aug 17 21:44:18 CST 2020
Run timerTask 1:Mon Aug 17 21:44:23 CST 2020
Run timerTask 2:Mon Aug 17 21:44:23 CST 2020
進(jìn)入 timerTask 1:Mon Aug 17 21:44:23 CST 2020
從上述結(jié)果中可以看出,當(dāng)任務(wù) 1 運(yùn)行時(shí)間超過(guò)設(shè)定的間隔時(shí)間時(shí),任務(wù) 2 也會(huì)延遲執(zhí)行。 原本任務(wù) 1 和任務(wù) 2 的執(zhí)行時(shí)間間隔都是 3s,但因?yàn)槿蝿?wù) 1 執(zhí)行了 5s,因此任務(wù) 2 的執(zhí)行時(shí)間間隔也變成了 10s(和原定時(shí)間不符)。
問(wèn)題 2:任務(wù)異常影響其他任務(wù)
使用 Timer 類實(shí)現(xiàn)定時(shí)任務(wù)時(shí),當(dāng)一個(gè)任務(wù)拋出異常,其他任務(wù)也會(huì)終止運(yùn)行,如下代碼所示:
public class MyTimerTask {
public static void main(String[] args) {
// 定義任務(wù) 1
TimerTask timerTask = new TimerTask() {
@Override
public void run() {
System.out.println("進(jìn)入 timerTask 1:" + new Date());
// 模擬異常
int num = 8 / 0;
System.out.println("Run timerTask 1:" + new Date());
}
};
// 定義任務(wù) 2
TimerTask timerTask2 = new TimerTask() {
@Override
public void run() {
System.out.println("Run timerTask 2:" + new Date());
}
};
// 計(jì)時(shí)器
Timer timer = new Timer();
// 添加執(zhí)行任務(wù)(延遲 1s 執(zhí)行,每 3s 執(zhí)行一次)
timer.schedule(timerTask, 1000, 3000);
timer.schedule(timerTask2, 1000, 3000);
}
}
程序執(zhí)行結(jié)果如下:
進(jìn)入 timerTask 1:Mon Aug 17 22:02:37 CST 2020
Exception in thread "Timer-0" java.lang.ArithmeticException: / by zero
at com.example.MyTimerTask$1.run(MyTimerTask.java:21)
at java.util.TimerThread.mainLoop(Timer.java:555)
at java.util.TimerThread.run(Timer.java:505)
Process finished with exit code 0
Timer 小結(jié)
Timer 類實(shí)現(xiàn)定時(shí)任務(wù)的優(yōu)點(diǎn)是方便,因?yàn)樗?JDK 自定的定時(shí)任務(wù),但缺點(diǎn)是任務(wù)如果執(zhí)行時(shí)間太長(zhǎng)或者是任務(wù)執(zhí)行異常,會(huì)影響其他任務(wù)調(diào)度,所以在生產(chǎn)環(huán)境下建議謹(jǐn)慎使用。
TOP 2:ScheduledExecutorService
ScheduledExecutorService 也是 JDK 1.5 自帶的 API,我們可以使用它來(lái)實(shí)現(xiàn)定時(shí)任務(wù)的功能,也就是說(shuō) ScheduledExecutorService 可以實(shí)現(xiàn) Timer 類具備的所有功能,并且它可以解決了 Timer 類存在的所有問(wèn)題。
ScheduledExecutorService 實(shí)現(xiàn)定時(shí)任務(wù)的代碼示例如下:
public class MyScheduledExecutorService {
public static void main(String[] args) {
// 創(chuàng)建任務(wù)隊(duì)列
ScheduledExecutorService scheduledExecutorService =
Executors.newScheduledThreadPool(10); // 10 為線程數(shù)量
// 執(zhí)行任務(wù)
scheduledExecutorService.scheduleAtFixedRate(() -> {
System.out.println("Run Schedule:" + new Date());
}, 1, 3, TimeUnit.SECONDS); // 1s 后開(kāi)始執(zhí)行,每 3s 執(zhí)行一次
}
}
程序執(zhí)行結(jié)果如下:
Run Schedule:Mon Aug 17 21:44:23 CST 2020
Run Schedule:Mon Aug 17 21:44:26 CST 2020
Run Schedule:Mon Aug 17 21:44:29 CST 2020
ScheduledExecutorService 可靠性測(cè)試
① 任務(wù)超時(shí)執(zhí)行測(cè)試
ScheduledExecutorService 可以解決 Timer 任務(wù)之間相應(yīng)影響的缺點(diǎn),首先我們來(lái)測(cè)試一個(gè)任務(wù)執(zhí)行時(shí)間過(guò)長(zhǎng),會(huì)不會(huì)對(duì)其他任務(wù)造成影響,測(cè)試代碼如下:
public class MyScheduledExecutorService {
public static void main(String[] args) {
// 創(chuàng)建任務(wù)隊(duì)列
ScheduledExecutorService scheduledExecutorService =
Executors.newScheduledThreadPool(10);
// 執(zhí)行任務(wù) 1
scheduledExecutorService.scheduleAtFixedRate(() -> {
System.out.println("進(jìn)入 Schedule:" + new Date());
try {
// 休眠 5 秒
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("Run Schedule:" + new Date());
}, 1, 3, TimeUnit.SECONDS); // 1s 后開(kāi)始執(zhí)行,每 3s 執(zhí)行一次
// 執(zhí)行任務(wù) 2
scheduledExecutorService.scheduleAtFixedRate(() -> {
System.out.println("Run Schedule2:" + new Date());
}, 1, 3, TimeUnit.SECONDS); // 1s 后開(kāi)始執(zhí)行,每 3s 執(zhí)行一次
}
}
程序執(zhí)行結(jié)果如下:
Run Schedule2:Mon Aug 17 11:27:55 CST 2020
進(jìn)入 Schedule:Mon Aug 17 11:27:55 CST 2020
Run Schedule2:Mon Aug 17 11:27:58 CST 2020
Run Schedule:Mon Aug 17 11:28:00 CST 2020
進(jìn)入 Schedule:Mon Aug 17 11:28:00 CST 2020
Run Schedule2:Mon Aug 17 11:28:01 CST 2020
Run Schedule2:Mon Aug 17 11:28:04 CST 2020
從上述結(jié)果可以看出,當(dāng)任務(wù) 1 執(zhí)行時(shí)間 5s 超過(guò)了執(zhí)行頻率 3s 時(shí),并沒(méi)有影響任務(wù) 2 的正常執(zhí)行,因此使用 ScheduledExecutorService 可以避免任務(wù)執(zhí)行時(shí)間過(guò)長(zhǎng)對(duì)其他任務(wù)造成的影響。
② 任務(wù)異常測(cè)試
接下來(lái)我們來(lái)測(cè)試一下 ScheduledExecutorService 在一個(gè)任務(wù)異常時(shí),是否會(huì)對(duì)其他任務(wù)造成影響,測(cè)試代碼如下:
public class MyScheduledExecutorService {
public static void main(String[] args) {
// 創(chuàng)建任務(wù)隊(duì)列
ScheduledExecutorService scheduledExecutorService =
Executors.newScheduledThreadPool(10);
// 執(zhí)行任務(wù) 1
scheduledExecutorService.scheduleAtFixedRate(() -> {
System.out.println("進(jìn)入 Schedule:" + new Date());
// 模擬異常
int num = 8 / 0;
System.out.println("Run Schedule:" + new Date());
}, 1, 3, TimeUnit.SECONDS); // 1s 后開(kāi)始執(zhí)行,每 3s 執(zhí)行一次
// 執(zhí)行任務(wù) 2
scheduledExecutorService.scheduleAtFixedRate(() -> {
System.out.println("Run Schedule2:" + new Date());
}, 1, 3, TimeUnit.SECONDS); // 1s 后開(kāi)始執(zhí)行,每 3s 執(zhí)行一次
}
}
程序執(zhí)行結(jié)果如下:
進(jìn)入 Schedule:Mon Aug 17 22:17:37 CST 2020
Run Schedule2:Mon Aug 17 22:17:37 CST 2020
Run Schedule2:Mon Aug 17 22:17:40 CST 2020
Run Schedule2:Mon Aug 17 22:17:43 CST 2020
從上述結(jié)果可以看出,當(dāng)任務(wù) 1 出現(xiàn)異常時(shí),并不會(huì)影響任務(wù) 2 的執(zhí)行。
ScheduledExecutorService 小結(jié)
在單機(jī)生產(chǎn)環(huán)境下建議使用 ScheduledExecutorService 來(lái)執(zhí)行定時(shí)任務(wù),它是 JDK 1.5 之后自帶的 API,因此使用起來(lái)也比較方便,并且使用 ScheduledExecutorService 來(lái)執(zhí)行任務(wù),不會(huì)造成任務(wù)間的相互影響。
TOP 3:Spring Task
如果使用的是 Spring 或 Spring Boot 框架,可以直接使用 Spring Framework 自帶的定時(shí)任務(wù),使用上面兩種定時(shí)任務(wù)的實(shí)現(xiàn)方式,很難實(shí)現(xiàn)設(shè)定了具體時(shí)間的定時(shí)任務(wù),比如當(dāng)我們需要每周五來(lái)執(zhí)行某項(xiàng)任務(wù)時(shí),但如果使用 Spring Task 就可輕松的實(shí)現(xiàn)此需求。
以 Spring Boot 為例,實(shí)現(xiàn)定時(shí)任務(wù)只需兩步:
- 開(kāi)啟定時(shí)任務(wù);
- 添加定時(shí)任務(wù)。
具體實(shí)現(xiàn)步驟如下。
① 開(kāi)啟定時(shí)任務(wù)
開(kāi)啟定時(shí)任務(wù)只需要在 Spring Boot 的啟動(dòng)類上聲明 @EnableScheduling
即可,實(shí)現(xiàn)代碼如下:
@SpringBootApplication
@EnableScheduling // 開(kāi)啟定時(shí)任務(wù)
public class DemoApplication {
// do someing
}
② 添加定時(shí)任務(wù)
定時(shí)任務(wù)的添加只需要使用 @Scheduled
注解標(biāo)注即可,如果有多個(gè)定時(shí)任務(wù)可以創(chuàng)建多個(gè) @Scheduled
注解標(biāo)注的方法,示例代碼如下:
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component // 把此類托管給 Spring,不能省略
public class TaskUtils {
// 添加定時(shí)任務(wù)
@Scheduled(cron = "59 59 23 0 0 5") // cron 表達(dá)式,每周五 23:59:59 執(zhí)行
public void doTask(){
System.out.println("我是定時(shí)任務(wù)~");
}
}
注意:定時(shí)任務(wù)是自動(dòng)觸發(fā)的無(wú)需手動(dòng)干預(yù),也就是說(shuō) Spring Boot 啟動(dòng)后會(huì)自動(dòng)加載并執(zhí)行定時(shí)任務(wù)。
Cron 表達(dá)式
Spring Task 的實(shí)現(xiàn)需要使用 cron 表達(dá)式來(lái)聲明執(zhí)行的頻率和規(guī)則,cron 表達(dá)式是由 6 位或者 7 位組成的(最后一位可以省略),每位之間以空格分隔,每位從左到右代表的含義如下:
其中 * 和 ? 號(hào)都表示匹配所有的時(shí)間。
cron 表達(dá)式在線生成地址:https://cron.qqe2.com/
知識(shí)擴(kuò)展:分布式定時(shí)任務(wù)
上面的方法都是關(guān)于單機(jī)定時(shí)任務(wù)的實(shí)現(xiàn),如果是分布式環(huán)境可以使用 Redis 來(lái)實(shí)現(xiàn)定時(shí)任務(wù)。
使用 Redis 實(shí)現(xiàn)延遲任務(wù)的方法大體可分為兩類:通過(guò) ZSet 的方式和鍵空間通知的方式。
① ZSet 實(shí)現(xiàn)方式
通過(guò) ZSet 實(shí)現(xiàn)定時(shí)任務(wù)的思路是,將定時(shí)任務(wù)存放到 ZSet 集合中,并且將過(guò)期時(shí)間存儲(chǔ)到 ZSet 的 Score 字段中,然后通過(guò)一個(gè)無(wú)線循環(huán)來(lái)判斷當(dāng)前時(shí)間內(nèi)是否有需要執(zhí)行的定時(shí)任務(wù),如果有則進(jìn)行執(zhí)行,具體實(shí)現(xiàn)代碼如下:
import redis.clients.jedis.Jedis;
import utils.JedisUtils;
import java.time.Instant;
import java.util.Set;
public class DelayQueueExample {
// zset key
private static final String _KEY = "myTaskQueue";
public static void main(String[] args) throws InterruptedException {
Jedis jedis = JedisUtils.getJedis();
// 30s 后執(zhí)行
long delayTime = Instant.now().plusSeconds(30).getEpochSecond();
jedis.zadd(_KEY, delayTime, "order_1");
// 繼續(xù)添加測(cè)試數(shù)據(jù)
jedis.zadd(_KEY, Instant.now().plusSeconds(2).getEpochSecond(), "order_2");
jedis.zadd(_KEY, Instant.now().plusSeconds(2).getEpochSecond(), "order_3");
jedis.zadd(_KEY, Instant.now().plusSeconds(7).getEpochSecond(), "order_4");
jedis.zadd(_KEY, Instant.now().plusSeconds(10).getEpochSecond(), "order_5");
// 開(kāi)啟定時(shí)任務(wù)隊(duì)列
doDelayQueue(jedis);
}
/**
* 定時(shí)任務(wù)隊(duì)列消費(fèi)
* @param jedis Redis 客戶端
*/
public static void doDelayQueue(Jedis jedis) throws InterruptedException {
while (true) {
// 當(dāng)前時(shí)間
Instant nowInstant = Instant.now();
long lastSecond = nowInstant.plusSeconds(-1).getEpochSecond(); // 上一秒時(shí)間
long nowSecond = nowInstant.getEpochSecond();
// 查詢當(dāng)前時(shí)間的所有任務(wù)
Set<String> data = jedis.zrangeByScore(_KEY, lastSecond, nowSecond);
for (String item : data) {
// 消費(fèi)任務(wù)
System.out.println("消費(fèi):" + item);
}
// 刪除已經(jīng)執(zhí)行的任務(wù)
jedis.zremrangeByScore(_KEY, lastSecond, nowSecond);
Thread.sleep(1000); // 每秒查詢一次
}
}
}
② 鍵空間通知
我們可以通過(guò) Redis 的鍵空間通知來(lái)實(shí)現(xiàn)定時(shí)任務(wù),它的實(shí)現(xiàn)思路是給所有的定時(shí)任務(wù)設(shè)置一個(gè)過(guò)期時(shí)間,等到了過(guò)期之后,我們通過(guò)訂閱過(guò)期消息就能感知到定時(shí)任務(wù)需要被執(zhí)行了,此時(shí)我們執(zhí)行定時(shí)任務(wù)即可。
默認(rèn)情況下 Redis 是不開(kāi)啟鍵空間通知的,需要我們通過(guò) config set notify-keyspace-events Ex
的命令手動(dòng)開(kāi)啟,開(kāi)啟之后定時(shí)任務(wù)的代碼如下:
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPubSub;
import utils.JedisUtils;
public class TaskExample {
public static final String _TOPIC = "__keyevent@0__:expired"; // 訂閱頻道名稱
public static void main(String[] args) {
Jedis jedis = JedisUtils.getJedis();
// 執(zhí)行定時(shí)任務(wù)
doTask(jedis);
}
/**
* 訂閱過(guò)期消息,執(zhí)行定時(shí)任務(wù)
* @param jedis Redis 客戶端
*/
public static void doTask(Jedis jedis) {
// 訂閱過(guò)期消息
jedis.psubscribe(new JedisPubSub() {
@Override
public void onPMessage(String pattern, String channel, String message) {
// 接收到消息,執(zhí)行定時(shí)任務(wù)
System.out.println("收到消息:" + message);
}
}, _TOPIC);
}
}