介紹 Java 語言中 Timer 類的一種簡潔用法
Tom White
首席 Java 開發人員, Kizoom
2003 年 12 月 01 日
所有類型的 Java 應用程序一般都需要計劃重復執行的任務。企業應用程序需要計劃每日的日志或者晚間批處理過程。一個 J2SE或者 J2ME 日歷應用程序需要根據用戶的約定計劃鬧鈴時間。不過，標準的調度類 Timer 和 TimerTask 沒有足夠的靈活性，無法支持通常需要的計劃任務類型。在本文中，Java 開發人員 Tom White 向您展示了如何構建一個簡單通用的計劃框架，以用于執行任意復雜的計劃任務。
我將把 java.util.Timer 和 java.util.TimerTask 統稱為 Java 計時器框架，它們使程序員可以很容易地計劃簡單的任務（注意這些類也可用于 J2ME 中）。在 Java 2 SDK, Standard Edition, Version 1.3 中引入這個框架之前，開發人員必須編寫自己的調度程序，這需要花費很大精力來處理線程和復雜的 Object.wait() 方法。不過，Java 計時器框架沒有足夠的能力來滿足許多應用程序的計劃要求。甚至一項需要在每天同一時間重復執行的任務，也不能直接使用 Timer 來計劃，因為在夏令時開始和結束時會出現時間跳躍。
本文展示了一個通用的 Timer 和 TimerTask 計劃框架，從而允許更靈活的計劃任務。這個框架非常簡單 ―― 它包括兩個類和一個接口 ―― 并且容易掌握。如果您習慣于使用 Java 定時器框架，那么您應該可以很快地掌握這個計劃框架（有關 Java 定時器框架的更多信息，請參閱 參考資料）。
計劃單次任務
計劃框架建立在 Java 定時器框架類的基礎之上。因此，在解釋如何使用計劃框架以及如何實現它之前，我們將首先看看如何用這些類進行計劃。
想像一個煮蛋計時器，在數分鐘之后（這時蛋煮好了）它會發出聲音提醒您。清單 1 中的代碼構成了一個簡單的煮蛋計時器的基本結構，它用 Java 語言編寫： 清單 1. EggTimer 類
package org.tiling.scheduling.examples;
import java.util.Timer;
import java.util.TimerTask;
public class EggTimer {
private final Timer timer = new Timer();
private final int minutes;
public EggTimer(int minutes) {
this.minutes = minutes;
}
public void start() {
timer.schedule(new TimerTask() {
public void run() {
playSound();
timer.cancel();
}
private void playSound() {
System.out.println("Your egg is ready!");
// Start a new thread to play a sound...
}
}, minutes * 60 * 1000);
}
public static void main(String[] args) {
EggTimer eggTimer = new EggTimer(2);
eggTimer.start();
}
}
|
EggTimer 實例擁有一個 Timer 實例，用于提供必要的計劃。用 start() 方法啟動煮蛋計時器后，它就計劃了一個 TimerTask ，在指定的分鐘數之后執行。時間到了， Timer 就在后臺調用 TimerTask 的 start() 方法，這會使它發出聲音。在取消計時器后這個應用程序就會中止。
計劃重復執行的任務
通過指定一個固定的執行頻率或者固定的執行時間間隔， Timer 可以對重復執行的任務進行計劃。不過，有許多應用程序要求更復雜的計劃。例如，每天清晨在同一時間發出叫醒鈴聲的鬧鐘不能簡單地使用固定的計劃頻率 86400000 毫秒（24 小時），因為在鐘撥快或者撥慢（如果您的時區使用夏令時）的那些天里，叫醒可能過晚或者過早。解決方案是使用日歷算法計算每日事件下一次計劃發生的時間。而這正是計劃框架所支持的。考慮清單 2 中的 AlarmClock 實現（有關計劃框架的源代碼以及包含這個框架和例子的 JAR 文件，請參閱 參考資料）： 清單 2. AlarmClock 類
package org.tiling.scheduling.examples;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.tiling.scheduling.Scheduler;
import org.tiling.scheduling.SchedulerTask;
import org.tiling.scheduling.examples.iterators.DailyIterator;
public class AlarmClock {
private final Scheduler scheduler = new Scheduler();
private final SimpleDateFormat dateFormat =
new SimpleDateFormat("dd MMM yyyy HH:mm:ss.SSS");
private final int hourOfDay, minute, second;
public AlarmClock(int hourOfDay, int minute, int second) {
this.hourOfDay = hourOfDay;
this.minute = minute;
this.second = second;
}
public void start() {
scheduler.schedule(new SchedulerTask() {
public void run() {
soundAlarm();
}
private void soundAlarm() {
System.out.println("Wake up! " +
"It's " + dateFormat.format(new Date()));
// Start a new thread to sound an alarm...
}
}, new DailyIterator(hourOfDay, minute, second));
}
public static void main(String[] args) {
AlarmClock alarmClock = new AlarmClock(7, 0, 0);
alarmClock.start();
}
}
|
注意這段代碼與煮蛋計時器應用程序非常相似。 AlarmClock 實例擁有一個 Scheduler （而不是 Timer ）實例，用于提供必要的計劃。啟動后，這個鬧鐘對 SchedulerTask （而不是 TimerTask ）進行調度用以發出報警聲。這個鬧鐘不是計劃一個任務在固定的延遲時間后執行，而是用 DailyIterator 類描述其計劃。在這里，它只是計劃任務在每天上午 7:00 執行。下面是一個正常運行情況下的輸出：
Wake up! It's 24 Aug 2003 07:00:00.023
Wake up! It's 25 Aug 2003 07:00:00.001
Wake up! It's 26 Aug 2003 07:00:00.058
Wake up! It's 27 Aug 2003 07:00:00.015
Wake up! It's 28 Aug 2003 07:00:00.002
...
|
DailyIterator 實現了 ScheduleIterator ，這是一個將 SchedulerTask 的計劃執行時間指定為一系列 java.util.Date 對象的接口。然后 next() 方法按時間先后順序迭代 Date 對象。返回值 null 會使任務取消（即它再也不會運行）―― 這樣的話，試圖再次計劃將會拋出一個異常。清單 3 包含 ScheduleIterator 接口：
清單 3. ScheduleIterator 接口
package org.tiling.scheduling;
import java.util.Date;
public interface ScheduleIterator {
public Date next();
}
|
DailyIterator 的 next() 方法返回表示每天同一時間（上午 7:00）的 Date 對象，如清單 4 所示。所以，如果對新構建的 next() 類調用 next() ，那么將會得到傳遞給構造函數的那個日期當天或者后面一天的 7:00 AM。再次調用 next() 會返回后一天的 7:00 AM，如此重復。為了實現這種行為， DailyIterator 使用了 java.util.Calendar 實例。構造函數會在日歷中加上一天，對日歷的這種設置使得第一次調用 next() 會返回正確的 Date 。注意代碼沒有明確地提到夏令時修正，因為 Calendar 實現（在本例中是 GregorianCalendar ）負責對此進行處理，所以不需要這樣做。
清單 4. DailyIterator 類
package org.tiling.scheduling.examples.iterators;
import org.tiling.scheduling.ScheduleIterator;
import java.util.Calendar;
import java.util.Date;
/**
* A DailyIterator class returns a sequence of dates on subsequent days
* representing the same time each day.
*/
public class DailyIterator implements ScheduleIterator {
private final int hourOfDay, minute, second;
private final Calendar calendar = Calendar.getInstance();
public DailyIterator(int hourOfDay, int minute, int second) {
this(hourOfDay, minute, second, new Date());
}
public DailyIterator(int hourOfDay, int minute, int second, Date date) {
this.hourOfDay = hourOfDay;
this.minute = minute;
this.second = second;
calendar.setTime(date);
calendar.set(Calendar.HOUR_OF_DAY, hourOfDay);
calendar.set(Calendar.MINUTE, minute);
calendar.set(Calendar.SECOND, second);
calendar.set(Calendar.MILLISECOND, 0);
if (!calendar.getTime().before(date)) {
calendar.add(Calendar.DATE, -1);
}
}
public Date next() {
calendar.add(Calendar.DATE, 1);
return calendar.getTime();
}
}
|
實現計劃框架
在上一節，我們學習了如何使用計劃框架，并將它與 Java 定時器框架進行了比較。下面，我將向您展示如何實現這個框架。除了 清單 3 中展示的 ScheduleIterator 接口，構成這個框架的還有另外兩個類 ―― Scheduler 和 SchedulerTask 。這些類實際上在內部使用 Timer 和 SchedulerTask ，因為計劃其實就是一系列的單次定時器。清單 5 和 6 顯示了這兩個類的源代碼： 清單 5. Scheduler
package org.tiling.scheduling;
import java.util.Date;
import java.util.Timer;
import java.util.TimerTask;
public class Scheduler {
class SchedulerTimerTask extends TimerTask {
private SchedulerTask schedulerTask;
private ScheduleIterator iterator;
public SchedulerTimerTask(SchedulerTask schedulerTask,
ScheduleIterator iterator) {
this.schedulerTask = schedulerTask;
this.iterator = iterator;
}
public void run() {
schedulerTask.run();
reschedule(schedulerTask, iterator);
}
}
private final Timer timer = new Timer();
public Scheduler() {
}
public void cancel() {
timer.cancel();
}
public void schedule(SchedulerTask schedulerTask,
ScheduleIterator iterator) {
Date time = iterator.next();
if (time == null) {
schedulerTask.cancel();
} else {
synchronized(schedulerTask.lock) {
if (schedulerTask.state != SchedulerTask.VIRGIN) {
throw new IllegalStateException("Task already
scheduled " + "or cancelled");
}
schedulerTask.state = SchedulerTask.SCHEDULED;
schedulerTask.timerTask =
new SchedulerTimerTask(schedulerTask, iterator);
timer.schedule(schedulerTask.timerTask, time);
}
}
}
private void reschedule(SchedulerTask schedulerTask,
ScheduleIterator iterator) {
Date time = iterator.next();
if (time == null) {
schedulerTask.cancel();
} else {
synchronized(schedulerTask.lock) {
if (schedulerTask.state != SchedulerTask.CANCELLED) {
schedulerTask.timerTask =
new SchedulerTimerTask(schedulerTask, iterator);
timer.schedule(schedulerTask.timerTask, time);
}
}
}
}
}
|
清單 6 顯示了 SchedulerTask 類的源代碼： 清單 6. SchedulerTask
package org.tiling.scheduling;
import java.util.TimerTask;
public abstract class SchedulerTask implements Runnable {
final Object lock = new Object();
int state = VIRGIN;
static final int VIRGIN = 0;
static final int SCHEDULED = 1;
static final int CANCELLED = 2;
TimerTask timerTask;
protected SchedulerTask() {
}
public abstract void run();
public boolean cancel() {
synchronized(lock) {
if (timerTask != null) {
timerTask.cancel();
}
boolean result = (state == SCHEDULED);
state = CANCELLED;
return result;
}
}
public long scheduledExecutionTime() {
synchronized(lock) {
return timerTask == null ? 0 : timerTask.scheduledExecutionTime();
}
}
}
|
就像煮蛋計時器， Scheduler 的每一個實例都擁有 Timer 的一個實例，用于提供底層計劃。 Scheduler 并沒有像實現煮蛋計時器時那樣使用一個單次定時器，它將一組單次定時器串接在一起，以便在由 ScheduleIterator 指定的各個時間執行 SchedulerTask 類。
考慮 Scheduler 上的 public schedule() 方法 ―― 這是計劃的入口點，因為它是客戶調用的方法（在 取消任務 一節中將描述僅有的另一個 public 方法 cancel() ）。通過調用 ScheduleIterator 接口的 next() ，發現第一次執行 SchedulerTask 的時間。然后通過調用底層 Timer 類的單次 schedule() 方法，啟動計劃在這一時刻執行。為單次執行提供的 TimerTask 對象是嵌入的 SchedulerTimerTask 類的一個實例，它包裝了任務和迭代器（iterator）。在指定的時間，調用嵌入類的 run() 方法，它使用包裝的任務和迭代器引用以便重新計劃任務的下一次執行。 reschedule() 方法與 schedule() 方法非常相似，只不過它是 private 的，并且執行一組稍有不同的 SchedulerTask 狀態檢查。重新計劃過程反復重復，為每次計劃執行構造一個新的嵌入類實例，直到任務或者調度程序被取消（或者 JVM 關閉）。
類似于 TimerTask ， SchedulerTask 在其生命周期中要經歷一系列的狀態。創建后，它處于 VIRGIN 狀態，這表明它從沒有計劃過。計劃以后，它就變為 SCHEDULED 狀態，再用下面描述的方法之一取消任務后，它就變為 CANCELLED 狀態。管理正確的狀態轉變 ―― 如保證不對一個非 VIRGIN 狀態的任務進行兩次計劃 ―― 增加了 Scheduler 和 SchedulerTask 類的復雜性。在進行可能改變任務狀態的操作時，代碼必須同步任務的鎖對象。
取消任務
取消計劃任務有三種方式。第一種是調用 SchedulerTask 的 cancel() 方法。這很像調用 TimerTask 的 cancel() 方法：任務再也不會運行了，不過已經運行的任務 仍會運行完成。 cancel() 方法的返回值是一個布爾值，表示如果沒有調用 cancel() 的話，計劃的任務是否還會運行。更準確地說，如果任務在調用 cancel() 之前是 SCHEDULED 狀態，那么它就返回 true 。如果試圖再次計劃一個取消的（甚至是已計劃的）任務，那么 Scheduler 就會拋出一個 IllegalStateException 。
取消計劃任務的第二種方式是讓 ScheduleIterator 返回 null 。這只是第一種方式的簡化操作，因為 Scheduler 類調用 SchedulerTask 類的 cancel() 方法。如果您想用迭代器而不是任務來控制計劃停止時間時，就用得上這種取消任務的方式了。
第三種方式是通過調用其 cancel() 方法取消整個 Scheduler 。這會取消調試程序的所有任務，并使它不能再計劃任何任務。
擴展 cron 實用程序
可以將計劃框架比作 UNIX 的 cron 實用程序，只不過計劃次數的規定是強制性而不是聲明性的。例如，在 AlarmClock 實現中使用的 DailyIterator 類，它的計劃與 cron 作業的計劃相同，都是由以 0 7 * * * 開始的 crontab 項指定的（這些字段分別指定分鐘、小時、日、月和星期）。
不過，計劃框架比 cron 更靈活。想像一個在早晨打開熱水的 HeatingController 應用程序。我想指示它“在每個工作日上午 8:00 打開熱水，在周未上午 9:00 打開熱水”。使用 cron ，我需要兩個 crontab 項（ 0 8 * * 1,2,3,4,5 和 0 9 * * 6,7 ）。而使用 ScheduleIterator 的解決方案更簡潔一些，因為我可以使用復合（composition）來定義單一迭代器。清單 7 顯示了其中的一種方法： 清單 7. 用復合定義單一迭代器
int[] weekdays = new int[] {
Calendar.MONDAY,
Calendar.TUESDAY,
Calendar.WEDNESDAY,
Calendar.THURSDAY,
Calendar.FRIDAY
};
int[] weekend = new int[] {
Calendar.SATURDAY,
Calendar.SUNDAY
};
ScheduleIterator i = new CompositeIterator(
new ScheduleIterator[] {
new RestrictedDailyIterator(8, 0, 0, weekdays),
new RestrictedDailyIterator(9, 0, 0, weekend)
}
);
|
RestrictedDailyIterator 類很像 DailyIterator ，只不過它限制為只在一周的特定日子里運行，而一個 CompositeIterator 類取得一組 ScheduleIterator s，并將日期正確排列到單個計劃中。這些類的源代碼請參閱 參考資料。
有許多計劃是 cron 無法生成的，但是 ScheduleIterator 實現卻可以。例如，“每個月的最后一天”描述的計劃可以用標準 Java 日歷算法來實現（用 Calendar 類），而用 cron 則無法表達它。應用程序甚至無需使用 Calendar 類。在本文的源代碼（請參閱 參考資料）中，我加入了一個安全燈控制器的例子，它按“在日落之前 15 分鐘開燈”這一計劃運行。這個實現使用了 Calendrical Calculations Software Package （請參閱 參考資料），用于計算當地（給定經度和緯度）的日落時間。
實時保證
在編寫使用計劃的應用程序時，一定要了解框架在時間方面有什么保證。我的任務是提前還是延遲執行？如果有提前或者延遲，偏差最大值是多少？不幸的是，對這些問題沒有簡單的答案。不過在實際中，它的行為對于很多應用程序已經足夠了。下面的討論假設系統時鐘是正確的（有關網絡時間協議(Network Time Protocol)的信息，請參閱 參考資料）。
因為 Scheduler 將計劃委托給 Timer 類， Scheduler 可以做出的實時保證與 Timer 的一樣。 Timer 用 Object.wait(long) 方法計劃任務。當前線程要等待直到喚醒它，喚醒可能出于以下原因之一：
- 另一個線程調用對象的
notify() 或者 notifyAll() 方法。
- 線程被另一個線程中斷。
- 在沒有通知的情況下，線程被喚醒（稱為 spurious wakeup，Joshua Bloch 的 Effective Java Programming Language Guide一書中 Item 50 對其進行了描述 ―― 請參閱 參考資料）。
- 規定的時間已到。
對于 Timer 類來說，第一種可能性是不會發生的，因為對其調用 wait() 的對象是私有的。即便如此， Timer 實現仍然針對前三種提前喚醒的原因進行了保護，這樣保證了線程在規定時間后才喚醒。目前， Object.wait(long) 的文檔注釋聲明，它會在規定的時間“前后”蘇醒，所以線程有可能提前喚醒。在本例中， Timer 會讓另一個 wait() 執行（ scheduledExecutionTime - System.currentTimeMillis() ）毫秒，從而保證 任務永遠不會提前執行。
任務是否會延遲執行呢？會的。延遲執行有兩個主要原因：線程計劃和垃圾收集。
Java 語言規范故意沒有對線程計劃做嚴格的規定。這是因為 Java 平臺是通用的，并針對于大范圍的硬件及其相關的操作系統。雖然大多數 JVM 實現都有公平的線程調度程序，但是這一點沒有任何保證 —— 當然，各個實現都有不同的為線程分配處理器時間的策略。因此，當 Timer 線程在分配的時間后喚醒時，它實際執行其任務的時間取決于 JVM 的線程計劃策略，以及有多少其他線程競爭處理器時間。因此，要減緩任務的延遲執行，應該將應用程序中可運行的線程數降至最少。為了做到這一點，可以考慮在一個單獨的 JVM 中運行調度程序。
對于創建大量對象的大型應用程序，JVM 花在垃圾收集（GC）上的時間會非常多。默認情況下，進行 GC 時，整個應用程序都必須等待它完成，這可能要有幾秒鐘甚至更長的時間（ Java 應用程序啟動器的命令行選項 -verbose:gc 將導致向控制臺報告每一次 GC 事件）。要將這些由 GC 引起的暫停（這可能會影響快速任務的執行）降至最少，應該將應用程序創建的對象的數目降至最低。同樣，在單獨的 JVM 中運行計劃代碼是有幫助的。同時，可以試用幾個微調選項以盡可能地減少 GC 暫停。例如，增量 GC 會盡量將主收集的代價分散到幾個小的收集上。當然這會降低 GC 的效率，但是這可能是時間計劃的一個可接受的代價（有關 GC 微調的更多提示，請參閱 參考資料）。
我被計劃到什么時候？
如果任務本身能監視并記錄所有延遲執行的實例，那么對于確定任務是否能按時運行會很有幫助。 SchedulerTask 類似于 TimerTask ，有一個 scheduledExecutionTime() 方法，它返回計劃任務最近一次執行的時間。在任務的 run() 方法開始時，對表達式 System.currentTimeMillis() - scheduledExecutionTime() 進行判斷，可以讓您確定任務延遲了多久執行（以毫秒為單位）。可以記錄這個值，以便生成一個關于延遲執行的分布統計。可以用這個值決定任務應當采取什么動作 ―― 例如，如果任務太遲了，那么它可能什么也不做。在遵循上述原則的情況下，如果應用程序需要更嚴格的時間保證，可參考 Java 的實時規范（更多信息請參閱 參考資料）。
結束語
在本文中，我介紹了 Java 定時器框架的一個簡單增強，它使得靈活的計劃策略成為可能。新的框架實質上是更通用的 cron ―― 事實上，將 cron 實現為一個 ScheduleIterator 接口，用以替換單純的 Java cron ，這是非常有用的。雖然沒有提供嚴格的實時保證，但是許多需要計劃定期任務的通用 Java 應用程序都可以使用這一框架。
參考資料
關于作者
Tom White 是 Kizoom 的首席 Java 開發人員，Kizoom 是一家領先的英國軟件公司，提供向移動設備發送個性化旅行信息的服務。客戶包括英國的國家火車操作員、倫敦公共交通系統（national train operator），以及英國國家公共汽車公司。自 1999 年成立以來，Kizoom 使用了極限編程的所有方法。自 1996 年起，Tom 一直全職編寫 Java 程序，使用了大部分標準和企業 Java API，編寫了從客戶 Swing GUI 和圖形到后端消息傳送系統等各種應用程序。他在劍橋大學獲得了一級榮譽學位（first class honours degree）。工作之余，Tom 喜歡逗他的小女兒開心，觀看 20 世紀 30 年代的好萊塢電影。可以通過 tom@tiling.org與 Tom 聯系。 |
|