一、什么是quartz作業調度?
Quartz框架是一個全功能、開源的任務調度服務,可以集成幾乎任何的java應用程序—從小的單片機系統到大型的電子商務系統。Quartz可以執行上千上萬的任務調度。
二、quartz的體系結構。
1.quartz中使用了一下幾種設計模式。
Builer模式
Factory模式
組件模式
鏈式寫法
2.三個主要的概念
調度器 :Quartz框架的核心是調度器。調度器負責管理Quartz應用運行時環境。調度器不是靠自己做所有的工作,而是依賴框架內一些非常重要的部件。Quartz不僅僅是線程和線程池管理。為確保可伸縮性,Quartz采用了基於多線程的架構。啟動時,框架初始化一套worker線程,這套線程被調度器用來執行預定的作業。這就是Quartz怎樣能並發運行多個作業的原理。Quartz依賴一套松耦合的線程池管理部件來管理線程環境。
任務:這個很簡單,就是我們自己編寫的業務邏輯,交給quartz幫我們執行 。
觸發器:簡單的講就是調度作業,什么時候開始執行,什么時候結束執行。
3.quartz的體系結構
quartz框架至少有三百多個類組成,這里我們重點介紹幾個它的核心部分
JobDetail:quartz每次都會直接創建一個JobDetail,同時創建一個Job實例,它不直接接受一個Job的實例,但是它接受一個Job的實現類,通過new instance()的反射方式來實例一個Job,在這里Job是一個接口,我們需要自己編寫類去實現這個接口。下面我們會講到這個接口。
Trigger : 它由SimpleTrigger和CronTrigger組成,SimpleTrigger實現類似Timer的定時調度任務,CronTrigger可以通過cron表達式實現更復雜的調度邏輯·。
Scheduler:調度器,JobDetail和Trigger可以通過Scheduler綁定到一起。
4.quartz重要組成部分
1).Job接口:可以通過實現該就接口來實現我們自己的業務邏輯,該接口只有execute()一個方法,我們可以通過下面的方式來實現Job接口來實現我們自己的業務邏輯
public class HelloJob implements Job{ public void execute(JobExecutionContext context) throws JobExecutionException { //編寫我們自己的業務邏輯 }
2).JobDetail:
每次都會直接創建一個JobDetail,同時創建一個Job實例,它不直接接受一個Job的實例,但是它接受一個Job的實現類,通過new instance()的反射方式來實例一個Job.可以通過下面的方式將一個Job實現類綁定到JobDetail中
JobDetail jobDetail=JobBuilder.newJob(HelloJob.class). withIdentity("myJob", "group1") .build();
3)JobBuiler:
主要是用來創建jobDeatil實例
4)JobStore:
綁定了Job的各種數據
5)trigger:前文講到它主要用來執行Job實現類的業務邏輯的,我們可以通過下面的代碼來創建一個Trigger實例:(這里我們會看到cron表達式,可以先不用,我們后面會介紹)
CronTrigger trigger = (CronTrigger) TriggerBuilder .newTrigger() .withIdentity("myTrigger", "group1") //創建一個標識符 .startAt(date)//什么時候開始觸發 //每秒鍾觸發一次任務 .withSchedule(CronScheduleBuilder.cronSchedule("* * * * * ? *")) .build();
6)Scheduler:創建Scheduler有兩種方式
通過StdSchedulerFactory來創建
SchedulerFactory sfact=new StdSchedulerFactory(); Scheduler scheduler=sfact.getScheduler();
通過DirectSchedulerFactory來創建
DiredtSchedulerFactory factory=DirectSchedulerFactory.getInstance();
Scheduler scheduler=factory.getScheduler();
Scheduler 配置參數一般存儲在quartz.properties中,我們可以修改參數來配置相應的參數。通過調用getScheduler()方法就能創建和初始化調度對象。
Scheduler的主要函數介紹:
Date schedulerJob(JobDetail,Trigger trigger);返回最近觸發的一次時間
void standby()暫時掛起
void shutdown()完全關閉,不能重新啟動了
shutdown(true)表示等待所有正在執行的job執行完畢之后,再關閉scheduler
shutdown(false)即直接關閉scheduler
在這里我們不得不提一下quartz.properties這個資源文件,在org.quartz這個包下,當我們程序啟動的時候,它首先會到我們的根目錄下查看是否配置了該資源文件,如果沒有就會到該包下讀取相應信息,當我們咋實現更復雜的邏輯時,需要自己指定參數的時候,可以自己配置參數來實現。下面我們簡單看一下這個資源文件:
org.quartz.scheduler.instanceName: DefaultQuartzScheduler
org.quartz.scheduler.rmi.export: false
org.quartz.scheduler.rmi.proxy: false
org.quartz.scheduler.wrapJobExecutionInUserTransaction: false
org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount: 10
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
org.quartz.jobStore.misfireThreshold: 60000
org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore
該資源文件主要組成部分:
①調度器屬性
②線程池屬性
③作業存儲設置
④插件設置
調度器屬性:
org.quartz.scheduler.instanceName屬性用來區分特定的調度器實例,可以按照功能用途來給調度器起名。
org.quartz.scheduler.instanceId屬性和前者一樣,也允許任何字符串,但這個值必須是在所有調度器實例中是唯一的,尤其是在一個集群當中,作為集群的唯一key,假如你想quartz幫你生成這個值的話,可以設置我Auto
線程池屬性:
threadCount設置線程的數量
threadPriority設置線程的優先級
org.quartz.threadPool.class 線程池的實現
作業存儲設置:
描述了在調度器實例的聲明周期中,job和trigger信息是怎么樣存儲的
插件配置:
滿足特定需求用到的quartz插件的配置
5.監聽器
監聽器顧名思義,就是對事件進行監聽並且加入自己相應的業務邏輯,主要有以下三個監聽器分別對Job,Trigger,Scheduler進行監聽。
JobListener
TriggerListener
SchedulerListener
三、Cron表達式
在這里,我們着重講解一下cron表達式,quartz之所以能夠實現更加復雜的業務邏輯,主要在依賴於cron表達式。
cron表達式編寫的順序一次是”秒 分 時 日 月 周 年”。
在這里我們可以看兩張圖片就能了解到cron表達式的基本語法了。
在線Cron生成表達式:http://cron.qqe2.com/
附:cronExpression配置說明 字段 允許值 允許的特殊字符 秒 0-59 , - * / 分 0-59 , - * / 小時 0-23 , - * / 日期 1-31 , - * ? / L W C 月份 1-12 或者 JAN-DEC , - * / 星期 1-7 或者 SUN-SAT , - * ? / L C # 年(可選) 留空, 1970-2099 , - * / 表達式 意義 "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觸發 特殊字符 意義 * 表示所有值; ? 表示未說明的值,即不關心它為何值; - 表示一個指定的范圍; , 表示附加一個可能值; / 符號前表示開始時間,符號后表示每次遞增的值; L("last") ("last") "L" 用在day-of-month字段意思是 "這個月最后一天";用在 day-of-week字段, 它簡單意思是 "7" or "SAT"。 如果在day-of-week字段里和數字聯合使用,它的意思就是 "這個月的最后一個星期幾" – 例如: "6L" means "這個月的最后一個星期五". 當我們用“L”時,不指明一個列表值或者范圍是很重要的,不然的話,我們會得到一些意想不到的結果。 W("weekday") 只能用在day-of-month字段。用來描敘最接近指定天的工作日(周一到周五)。例如:在day-of-month字段用“15W”指“最接近這個月第15天的工作日”,即如果這個月第15天是周六,那么觸發器將會在這個月第14天即周五觸發;如果這個月第15天是周日,那么觸發器將會在這個月第16天即周一觸發;如果這個月第15天是周二,那么就在觸發器這天觸發。注意一點:這個用法只會在當前月計算值,不會越過當前月。“W”字符僅能在day-of-month指明一天,不能是一個范圍或列表。也可以用“LW”來指定這個月的最后一個工作日。 # 只能用在day-of-week字段。用來指定這個月的第幾個周幾。例:在day-of-week字段用"6#3"指這個月第3個周五(6指周五,3指第3個)。如果指定的日期不存在,觸發器就不會觸發。 C 指和calendar聯系后計算過的值。例:在day-of-month 字段用“5C”指在這個月第5天或之后包括calendar的第一天;在day-of-week字段用“1C”指在這周日或之后包括calendar的第一天
四、quartz框架實戰
文件一(執行具體任務class)
public class QuartzDemo implements Job{ @Override public void execute(JobExecutionContext arg0) throws JobExecutionException { System.out.println("Quartz執行......."); } }
文件二:
public class QuartzManager{ private static final SimpleTrigger CronTrigger = null; public static void main(String[] args){ } public void simpleDemo(){ //通過SchedulerFactory來獲取一個調度器 SchedulerFactory schedulerFactory = new StdSchedulerFactory(); Scheduler scheduler; try { scheduler = schedulerFactory.getScheduler(); //引進作業程序 JobDetail jobDetail = new JobDetail("jobDetail-s1", "jobDetailGroup-s1", QuartzDemo.class); //new一個觸發器 SimpleTrigger simpleTrigger = new SimpleTrigger("simpleTrigger", "triggerGroup-s1"); //設置作業啟動時間 long ctime = System.currentTimeMillis(); simpleTrigger.setStartTime(new Date(ctime)); //設置作業執行間隔 simpleTrigger.setRepeatInterval(1000); //設置作業執行次數 simpleTrigger.setRepeatCount(10); //設置作業執行優先級默認為5 //simpleTrigger.setPriority(10); //作業和觸發器設置到調度器中 scheduler.scheduleJob(jobDetail, simpleTrigger); //啟動調度器 scheduler.start(); } catch (SchedulerException e) { // TODO Auto-generated catch block e.printStackTrace(); } } public void cronDemo(){ try { SchedulerFactory schedFact = new org.quartz.impl.StdSchedulerFactory(); Scheduler sched = schedFact.getScheduler(); sched.start(); JobDetail jobDetail = new JobDetail( " Income Report " , " Report Generation " , QuartzDemo.class ); jobDetail.getJobDataMap().put( " type " , " FULL " ); CronTrigger trigger = new CronTrigger( " Income Report " , " Report Generation " ); /**/ /* 每1分鍾執行一次 */ trigger.setCronExpression( "0 33 16 * * ?" ); sched.scheduleJob(jobDetail, trigger); } catch (Exception e) { e.printStackTrace(); } } public void caledarDemo(){ //通過SchedulerFactory來獲取一個調度器 SchedulerFactory schedulerFactory = new StdSchedulerFactory(); Scheduler scheduler; try { scheduler = schedulerFactory.getScheduler(); //引進作業程序 JobDetail jobDetail = new JobDetail("jobDetail-s1", "jobDetailGroup-s1", QuartzDemo.class); //new一個觸發器 CronTrigger simpleTrigger = new CronTrigger("trigger", "group", "job", "group", "16 26/1 8-17 * * ?"); // new SimpleTrigger("simpleTrigger", "triggerGroup-s1"); //設置作業啟動時間 //Calendar excelCal = Calendar.getInstance(); //excelCal.add(Calendar.DAY_OF_MONTH, 1); ///excelCal.set(Calendar.HOUR_OF_DAY, 16); //excelCal.set(Calendar.SECOND, 0); //excelCal.add(Calendar.MINUTE, 9); // long ctime = System.currentTimeMillis(); // simpleTrigger.setStartTime(excelCal.getTime()); //設置作業執行間隔 // simpleTrigger.setRepeatInterval(1000); //設置作業執行次數 // simpleTrigger.setRepeatCount(10); //設置作業執行優先級默認為5 //simpleTrigger.setPriority(10); //作業和觸發器設置到調度器中 scheduler.scheduleJob(jobDetail, simpleTrigger); //啟動調度器 scheduler.start(); } catch (SchedulerException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (ParseException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }
需要注意的幾點是經常會出現org.quartz.core.ErrorLogger : An error occured instantiating job to be executed.....這種異常,解決辦法是
1)Job類必須有默認的無參構造方法,當然不覆蓋的話類本身就是無參的構造方法 2)Job的scope必須是Public類型的,因為quartz根據反射機制實例化類,如果不是public的,無法對其暴露 3) Job類不能是內部類,原因同上,所以最好單獨建類
注意:Quartz提供管理任務的Java代碼:
/** * Package Name:nc.xyzq.common.task * */ package nc.xyzq.common.task; import org.quartz.CronTrigger; import org.quartz.JobDetail; import org.quartz.Scheduler; import org.quartz.SchedulerFactory; import org.quartz.impl.StdSchedulerFactory; //任務管理器 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說明文檔 * */ public static void addJob(String jobName, String jobClass, String time) { try { //System.out.println("addJob>>>1111>>Apache Tomcat v6.0.32 at localhost:"+jobName+" jobClass:"+jobClass+" time:"+time); //通過SchedulerFactory來獲取一個調度器 Scheduler sched = gSchedulerFactory.getScheduler(); //引進作業程序 JobDetail jobDetail = new JobDetail(jobName, JOB_GROUP_NAME, Class .forName(jobClass));// 任務名,任務組,任務執行類 //new一個觸發器 CronTrigger trigger = new CronTrigger(jobName, TRIGGER_GROUP_NAME); // 觸發器時間設定 trigger.setCronExpression(time); sched.scheduleJob(jobDetail, trigger); // 啟動 if (!sched.isShutdown()) { sched.start(); } } catch (Exception e) { // TODO Auto-generated catch block e.printStackTrace(); } } /** * 添加一個定時任務 * * @param jobName 任務名 * @param jobGroupName 任務組名 * @param triggerName 觸發器名 * @param triggerGroupName 觸發器組名 * @param jobClass 任務 * @param time 時間設置,參考quartz說明文檔 */ public static void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, String jobClass, String time) { try { //通過SchedulerFactory來獲取一個調度器 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); // 啟動 if (!sched.isShutdown()) { sched.start(); } } 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(); if (sched.isShutdown()) { 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); } } /*** * 停止觸發器 * @param triggerName * @param triggerGroupName */ public static void pauseTrigger(){ try { Scheduler sched = gSchedulerFactory.getScheduler(); sched.pauseTriggerGroup(TRIGGER_GROUP_NAME); } catch (Exception e) { e.printStackTrace(); throw new RuntimeException(e); } } /*** * 重啟觸發器 * @param triggerName * @param triggerGroupName * @param time */ public static void resumeTrigger() { try { Scheduler sched = gSchedulerFactory.getScheduler(); // 重啟觸發器 sched.resumeTriggerGroup(TRIGGER_GROUP_NAME); } catch (Exception e) { e.printStackTrace(); throw new RuntimeException(e); } } }