定時任務之-Quartz使用篇
Quartz是OpenSymphony開源組織在Job scheduling領域又一個開源項目,它可以與J2EE與J2SE應用程序相結合也可以單獨使用。Quartz可以用來創建簡單或爲運行十個,百個,甚至是好幾萬個Jobs這樣複雜的日程序表。Jobs可以做成標準的Java組件或 EJBs。官方網站:http://www.opensymphony.com/quartz
相關Jar:
quartz-all-1.6.0.jar
jta.jar
commons-logging-1.1.jar
commons-collections3.2.jar
經過封裝的管理類:
- /**
- * 版權所有:華信軟件
- * 項目名稱:公用模塊
- * 創建者: Wangdf
- * 創建日期: 2011-1-22
- * 文件說明: 定時任務管理類
- * 最近修改者:Wangdf
- * 最近修改日期:2011-1-22
- */
- package com.extjweb.quartz;
- import java.text.ParseException;
- import org.quartz.CronTrigger;
- import org.quartz.JobDetail;
- import org.quartz.Scheduler;
- import org.quartz.SchedulerException;
- import org.quartz.SchedulerFactory;
- import org.quartz.impl.StdSchedulerFactory;
- /**
- * 定時任務管理類
- *
- * @author 王德封
- */
- public class QuartzManager {
- private static SchedulerFactory gSchedulerFactory = new StdSchedulerFactory();
- private static String JOB_GROUP_NAME = "EXTJWEB_JOBGROUP_NAME";
- private static String TRIGGER_GROUP_NAME = "EXTJWEB_TRIGGERGROUP_NAME";
- /**
- * 添加一個定時任務,使用默認的任務組名,觸發器名,觸發器組名
- *
- * @param jobName
- * 任務名
- * @param jobClass
- * 任務
- * @param time
- * 時間設置,參考quartz說明文檔
- * @throws SchedulerException
- * @throws ParseException
- */
- public static void addJob(String jobName, String jobClass, String time) {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- JobDetail jobDetail = new JobDetail(jobName, JOB_GROUP_NAME, Class.forName(jobClass));// 任務名,任務組,任務執行類
- // 觸發器
- CronTrigger trigger = new CronTrigger(jobName, TRIGGER_GROUP_NAME);// 觸發器名,觸發器組
- trigger.setCronExpression(time);// 觸發器時間設定
- sched.scheduleJob(jobDetail, trigger);
- // 啓動
- if (!sched.isShutdown()){
- sched.start();
- }
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 添加一個定時任務
- *
- * @param jobName
- * 任務名
- * @param jobGroupName
- * 任務組名
- * @param triggerName
- * 觸發器名
- * @param triggerGroupName
- * 觸發器組名
- * @param jobClass
- * 任務
- * @param time
- * 時間設置,參考quartz說明文檔
- * @throws SchedulerException
- * @throws ParseException
- */
- public static void addJob(String jobName, String jobGroupName,
- String triggerName, String triggerGroupName, String jobClass, String time){
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- JobDetail jobDetail = new JobDetail(jobName, jobGroupName, Class.forName(jobClass));// 任務名,任務組,任務執行類
- // 觸發器
- CronTrigger trigger = new CronTrigger(triggerName, triggerGroupName);// 觸發器名,觸發器組
- trigger.setCronExpression(time);// 觸發器時間設定
- sched.scheduleJob(jobDetail, trigger);
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 修改一個任務的觸發時間(使用默認的任務組名,觸發器名,觸發器組名)
- *
- * @param jobName
- * @param time
- */
- public static void modifyJobTime(String jobName, String time) {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- CronTrigger trigger = (CronTrigger) sched.getTrigger(jobName, TRIGGER_GROUP_NAME);
- if(trigger == null) {
- return;
- }
- String oldTime = trigger.getCronExpression();
- if (!oldTime.equalsIgnoreCase(time)) {
- JobDetail jobDetail = sched.getJobDetail(jobName, JOB_GROUP_NAME);
- Class objJobClass = jobDetail.getJobClass();
- String jobClass = objJobClass.getName();
- removeJob(jobName);
- addJob(jobName, jobClass, time);
- }
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 修改一個任務的觸發時間
- *
- * @param triggerName
- * @param triggerGroupName
- * @param time
- */
- public static void modifyJobTime(String triggerName,
- String triggerGroupName, String time) {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- CronTrigger trigger = (CronTrigger) sched.getTrigger(triggerName, triggerGroupName);
- if(trigger == null) {
- return;
- }
- String oldTime = trigger.getCronExpression();
- if (!oldTime.equalsIgnoreCase(time)) {
- CronTrigger ct = (CronTrigger) trigger;
- // 修改時間
- ct.setCronExpression(time);
- // 重啓觸發器
- sched.resumeTrigger(triggerName, triggerGroupName);
- }
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 移除一個任務(使用默認的任務組名,觸發器名,觸發器組名)
- *
- * @param jobName
- */
- public static void removeJob(String jobName) {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- sched.pauseTrigger(jobName, TRIGGER_GROUP_NAME);// 停止觸發器
- sched.unscheduleJob(jobName, TRIGGER_GROUP_NAME);// 移除觸發器
- sched.deleteJob(jobName, JOB_GROUP_NAME);// 刪除任務
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 移除一個任務
- *
- * @param jobName
- * @param jobGroupName
- * @param triggerName
- * @param triggerGroupName
- */
- public static void removeJob(String jobName, String jobGroupName,
- String triggerName, String triggerGroupName) {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- sched.pauseTrigger(triggerName, triggerGroupName);// 停止觸發器
- sched.unscheduleJob(triggerName, triggerGroupName);// 移除觸發器
- sched.deleteJob(jobName, jobGroupName);// 刪除任務
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 啓動所有定時任務
- */
- public static void startJobs() {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- sched.start();
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- /**
- * 關閉所有定時任務
- */
- public static void shutdownJobs() {
- try {
- Scheduler sched = gSchedulerFactory.getScheduler();
- if(!sched.isShutdown()) {
- sched.shutdown();
- }
- } catch (Exception e) {
- e.printStackTrace();
- throw new RuntimeException(e);
- }
- }
- }
改造Quartz的JobRunShell類的202行代碼、使定時任務支持數據庫全程事務以及數據庫連接的關閉:
- // execute the job
- try {
- log.debug("Calling execute on job " + jobDetail.getFullName());
- job.execute(jec);
- // 2011/1/22 王德封 添加
- DBUtil.commit();
- endTime = System.currentTimeMillis();
- } catch (JobExecutionException jee) {
- endTime = System.currentTimeMillis();
- jobExEx = jee;
- // 2011/1/22 王德封 添加
- DBUtil.rollback();
- getLog().info("Job " + jobDetail.getFullName() +
- " threw a JobExecutionException: ", jobExEx);
- } catch (Throwable e) {
- endTime = System.currentTimeMillis();
- getLog().error("Job " + jobDetail.getFullName() +
- " threw an unhandled Exception: ", e);
- SchedulerException se = new SchedulerException(
- "Job threw an unhandled exception.", e);
- se.setErrorCode(SchedulerException.ERR_JOB_EXECUTION_THREW_EXCEPTION);
- qs.notifySchedulerListenersError("Job ("
- + jec.getJobDetail().getFullName()
- + " threw an exception.", se);
- jobExEx = new JobExecutionException(se, false);
- jobExEx.setErrorCode(JobExecutionException.ERR_JOB_EXECUTION_THREW_EXCEPTION);
- // 2011/1/22 王德封 添加
- DBUtil.rollback();
- } finally {
- // 2011/1/22 王德封 添加
- DBUtil.closeCurrentConnection();
- }
測試代碼:
- System.out.println("【系統啓動】開始(每1秒輸出一次)...");
- QuartzManager.addJob(job_name, job, "0/1 * * * * ?");
- //QuartzManager.addJob(job_name, job, "0 0/3 8-20 ? ? *");
- Thread.sleep(5000);
- System.out.println("【修改時間】開始(每2秒輸出一次)...");
- QuartzManager.modifyJobTime(job_name, "10/2 * * * * ?");
- Thread.sleep(6000);
- System.out.println("【移除定時】開始...");
- QuartzManager.removeJob(job_name);
- System.out.println("【移除定時】成功");
- System.out.println("/n【再次添加定時任務】開始(每10秒輸出一次)...");
- QuartzManager.addJob(job_name, job, "*/10 * * * * ?");
- Thread.sleep(60000);
- System.out.println("【移除定時】開始...");
- QuartzManager.removeJob(job_name);
- System.out.println("【移除定時】成功");
- package com.extjweb.quartz;
- import java.util.Calendar;
- import org.quartz.Job;
- import org.quartz.JobExecutionContext;
- import org.quartz.JobExecutionException;
- public class TestJob implements Job {
- @SuppressWarnings("deprecation")
- public void execute(JobExecutionContext arg0) throws JobExecutionException {
- System.out.println(Calendar.getInstance().getTime().toLocaleString()+ "★★★★★★★★★★★");
- }
- }
quartz 時間配置規則
格式: [秒] [分] [小時] [日] [月] [周] [年]
序號 | 說明 | 是否必填 | 允許填寫的值 | 允許的通配符 |
1 | 秒 | 是 | 0-59 | , - * / |
2 | 分 | 是 | 0-59 | , - * / |
3 | 小時 | 是 | 0-23 | , - * / |
4 | 日 | 是 | 1-31 | , - * ? / L W |
5 | 月 | 是 | 1-12 or JAN-DEC | , - * / |
6 | 周 | 是 | 1-7 or SUN-SAT | , - * ? / L # |
7 | 年 | 否 | empty 或 1970-2099 | , - * / |
通配符說明:
* 表示所有值. 例如:在分的字段上設置 "*",表示每一分鐘都會觸發。
? 表示不指定值。使用的場景爲不需要關心當前設置這個字段的值。例如:要在每月的10號觸發一個操作,但不關心是周幾,所以需要周位置的那個字段設置爲"?" 具體設置爲 0 0 0 10 * ?
- 表示區間。例如 在小時上設置 "10-12",表示 10,11,12點都會觸發。
, 表示指定多個值,例如在周字段上設置 "MON,WED,FRI" 表示週一,週三和週五觸發
/ 用於遞增觸發。如在秒上面設置"5/15" 表示從5秒開始,每增15秒觸發(5,20,35,50)。在月字段上設置'1/3'所示每月1號開始,每隔三天觸發一次。
L 表示最後的意思。在日字段設置上,表示當月的最後一天(依據當前月份,如果是二月還會依據是否是潤年[leap]), 在周字段上表示星期六,相當於"7"或"SAT"。如果在"L"前加上數字,則表示該數據的最後一個。例如在周字段上設置"6L"這樣的格式,則表示“本月最後一個星期五"
W 表示離指定日期的最近那個工作日(週一至週五). 例如在日字段上設置"15W",表示離每月15號最近的那個工作日觸發。如果15號正好是週六,則找最近的週五(14號)觸發, 如果15號是周未,則找最近的下週一(16號)觸發.如果15號正好在工作日(週一至週五),則就在該天觸發。如果指定格式爲 "1W",它則表示每月1號往後最近的工作日觸發。如果1號正是週六,則將在3號下週一觸發。(注,"W"前只能設置具體的數字,不允許區間"-").
小提示 |
'L'和 'W'可以一組合使用。如果在日字段上設置"LW",則表示在本月的最後一個工作日觸發(一般指發工資 ) |
小提示 |
周字段的設置,若使用英文字母是不區分大小寫的 MON 與mon相同. |
常用示例:
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分每分觸發 |
0 0/5 14 * * ? | 每天下午的 2點到2點59分(整點開始,每隔5分觸發) |
0 0/5 14,18 * * ? |
每天下午的 2點到2點59分(整點開始,每隔5分觸發) 每天下午的 18點到18點59分(整點開始,每隔5分觸發) |
0 0-5 14 * * ? | 每天下午的 2點到2點05分每分觸發 |
0 10,44 14 ? 3 WED | 3月分每週三下午的 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 | 每月的第三週的星期五開始觸發 |
0 0 12 1/5 * ? | 每月的第一個中午開始每隔5天觸發一次 |
0 11 11 11 11 ? | 每年的11月11號 11點11分觸發(光棍節) |