如何在Web工程中實現任務計劃調度(定時功能)

如何在Web工程中實現任務計劃調度 作者： ∣來源：JavaResearch∣原文地址∣2004-2-23

    好多朋友用過Windows的任務計劃，也有不少程序迷自己曾寫過時鐘報警、系統自動關機等趣味程序，可卻很少有朋友在Web工程中實現過類似功能。今天有空把筆者先前曾在Tomcat上實現的類似功能，搬出來與大家共享。
    早在幾年前，我公司跟某市財政局合作項目開發，爲加強財政局對所屬單位財務狀況的有效監管，開發、實施了財政局數據中心項目。此項目採用B/S加C/S混合結構模式。財政局Web服務器上架設數據同步接收裝置，由市屬單位每天下班前把財務信息通過HTTP協議上傳至財政局中心服務器，與Web服務器上的接收裝置對接。財政局內部各部門需要查閱大量財務信息，獲取完備的市屬單位當前財務狀況信息，各部門按職能劃分，需要準確的獲取各部門各自所關注的彙總信息，以財政報表的形式提供。 
    因財政數據量大，實時計算財政報表速度較慢，當初就考慮用報表緩存來減輕服務器的負擔，但用緩存需要一個合理的緩存更新機制。考慮到各市屬單位每天下班前才把財務數據上傳，財政局每天所查看到的財務信息其實並不包括當天（除非有某位領導等到所屬單位全部上傳完之後纔來查看信息，應該已經下班了），所以要是能實現任務計劃調度，在每晚深夜把當天及歷史財務信息彙總，更新緩存，速度瓶頸不就解決了嗎。
    當時由於系統核心是基於Web部署的，報表計算引擎也相應的部署在Tomcat容器上，因此如果想要借用Windows的任務計劃來實現定時計算，就需要額外編寫普通桌面應用程序接口，稍顯複雜。於是就琢磨着想在Web上實現，經過查閱較多相關資料，發現Java定時器（java.util.Timer）有定時觸發計劃任務的功能，通過配置定時器的間隔時間，在某一間隔時間段之後會自動有規律的調用預先所安排的計劃任務（java.util.TimerTask）。另外，由於我們希望當Web工程啓動時，定時器能自動開始計時，在整個Web工程的生命期裏，定時器能在每晚深夜觸發一次報表計算引擎。因此定時器的存放位置也值得考查，不能簡單的存在於單個Servlet或JavaBean中，必須能讓定時器宿主的存活期爲整個Web工程生命期，在工程啓動時能自動加載運行。結合這兩點，跟Servlet上下文有關的偵聽器就最合適不過了，通過在工程的配置文件中加以合理配置，會在工程啓動時自動運行，並在整個工程生命期中處於監聽狀態。
    下面就Servlet偵聽器結合Java定時器來講述整個實現過程。要運用Servlet偵聽器需要實現javax.servlet.ServletContextListener接口，同時實現它的contextInitialized(ServletContextEvent event)和contextDestroyed(ServletContextEvent event)兩個接口函數。考慮定時器有個建立和銷燬的過程，看了前面兩個接口函數，就不容置疑的把建立的過程置入contextInitialized，把銷燬的過程置入contextDestroyed了。
    我把ServletContextListener的實現類取名爲ContextListener,在其內添加一個定時器，示例代碼如下所示（爲考慮篇幅，僅提供部分代碼供讀者參考）：

1.     private java.util.Timer timer = null;
2.     public void contextInitialized(ServletContextEvent event) {
3.         timer = new java.util.Timer(true);
4.         event.getServletContext().log("定時器已啓動");        
5.          timer.schedule(new MyTask(event.getServletContext()), 0, 60*60*1000);
6.         event.getServletContext().log("已經添加任務調度表");
7.     }
8.     public void contextDestroyed(ServletContextEvent event) {
9.         timer.cancel();
10.         event.getServletContext().log("定時器銷燬");
11.     }

    以上代碼中, timer.schedule(new MyTask(event.getServletContext()), 0, 60*60*1000)這一行爲定時器調度語句，其中MyTask是自定義需要被調度的執行任務（在我的財政數據中心項目中就是報表計算引擎入口），從java.util.TimerTask繼承，下面會重點講述，第三個參數表示每小時(即60*60*1000毫秒)被觸發一次，中間參數0表示無延遲。其它代碼相當簡單，不再詳細說明。
   下面介紹MyTask的實現，上面的代碼中看到了在構造MyTask時，傳入了javax.servlet.ServletContext類型參數,是爲記錄Servlet日誌方便而傳入，因此需要重載MyTask的構造函數（其父類java.util.TimerTask原構造函數是沒有參數的）。在timer.schedule()的調度中,設置了每小時調度一次,因此如果想實現調度任務每24小時被執行一次，還需要判斷一下時鐘點，以常量C_SCHEDULE_HOUR表示(晚上12點，也即0點)。同時爲防止24小時執行下來，任務還未執行完（當然，一般任務是沒有這麼長的），避免第二次又被調度以引起執行衝突，設置了當前是否正在執行的狀態標誌isRunning。示例代碼如下所示：

1.     private static final int C_SCHEDULE_HOUR   = 0;
2.     private static boolean isRunning = false;
3.          private ServletContext context = null;
4.     public MyTask(ServletContext context) {
5.         this.context = context;
6.     }
7.     public void run() {
8.         Calendar cal = Calendar.getInstance();        
9.         if (!isRunning)  {           
10.             if (C_SCHEDULE_HOUR == cal.get(Calendar.HOUR_OF_DAY)) {            
11.                     isRunning = true;                
12.                 context.log("開始執行指定任務");
13.                 
14.                 //TODO 添加自定義的詳細任務，以下只是示例
15.                 int i = 0;
16.                 while (i++ < 10) {
17.                     context.log("已完成任務的" + i + "/" + 10);
18.                 }
19.  
20.                 isRunning = false;
21.                 context.log("指定任務執行結束");               
22.             }            
23.         } else {
24.             context.log("上一次任務執行還未結束");
25.         }
26.     }

    上面代碼中“//TODO……”之下四行是真正被調度執行的演示代碼(在我的財政數據中心項目中就是報表計算過程)，您可以換成自己希望執行的語句。
到這兒，ServletContextListener和MyTask的代碼都已完整了。最後一步就是把ServletContextListener部署到您的Web工程中去，在您工程的web.xml配置文件中加入如下三行：
    <listener>
        <listener-class>com.test.ContextListener</listener-class>
    </listener> 
    當然，上面的com.test得換成您自己的包名了。保存web.xml文件後，把工程打包部署到Tomcat中即可。任務會在每晚12點至凌晨1點之間被執行，上面的代碼會在Tomcat的日誌文件中記錄如下：
2003-12-05 0：21：39 開始執行指定任務
2003-12-05 0：21：39 已完成任務的1/10
    ……
2003-12-05 0：21：39 已完成任務的10/10
2003-12-05 0：21：39 指定任務執行結束
    以上代碼在Tomcat 4.1.29以及Tomcat 5.0.16上調試通過。如果您需要完整代碼，請通過[email protected]與我聯繫。