一个Scheduler的生命周期是由它的创作范围,通过SchedulerFactory来调用他的创建和关闭。
创建Scheduler后,就可以使用它
//definethejobandtieittoourHelloJobclassJobDetailjob=newJob(HelloJob.class).withIdentity("myJob","group1")//name"myJob",group"group1".build();//Triggerthejobtorunnow,andthenevery40secondsTriggertrigger=newTrigger().withIdentity("myTrigger","group1").startNow().withSchedule(simpleSchedule().withIntervalInSeconds(40).repeatForever()).build();//Tellquartztoschedulethejobusingourtriggersched.scheduleJob(job,trigger);JobsandTriggersJob是一个接口
publicinterfaceJob{publicvoidexecute(JobExecutionContextcontext)throwsJobExecutionException;}当一个Jobs被触发执行的时候,会调用execute,在一个Scheduler的worker的线程里面。
JobExecutionContext提供了运行的时候需要的一些变量
JobDetail在Job加到Scheduler的时候,他能包含一些属性用来设置给job的,比如说JobDataMap,他能让我们存储一些状态信息给我们Job
Trigger用来触发执行任务,也包含了JobDataMap,他能告诉我们什么时候执行任务。默认有SimpleTrigger和CronTrigger
如果您希望基于类似日历的日程安排(如每个周五中午或每个月的第10天的10:15)进行触发,那么CronTrigger非常有用。
JobKeyandTriggerKey
groups
//definethejobandtieittoourHelloJobclassJobDetailjob=newJob(HelloJob.class).withIdentity("myJob","group1")//name"myJob",group"group1".build();//Triggerthejobtorunnow,andthenevery40secondsTriggertrigger=newTrigger().withIdentity("myTrigger","group1").startNow().withSchedule(simpleSchedule().withIntervalInSeconds(40).repeatForever()).build();//Tellquartztoschedulethejobusingourtriggersched.scheduleJob(job,trigger);publicclassHelloJobimplementsJob{publicHelloJob(){}publicvoidexecute(JobExecutionContextcontext)throwsJobExecutionException{System.err.println("Hello!HelloJobisexecuting.");}}每次执行的时候,都会在调用execute前创建其实例,执行完成后会删除和垃圾回收。
//definethejobandtieittoourDumbJobclassJobDetailjob=newJob(DumbJob.class).withIdentity("myJob","group1")//name"myJob",group"group1".usingJobData("jobSays","HelloWorld!").usingJobData("myFloatValue",3.141f).build();publicclassDumbJobimplementsJob{publicDumbJob(){}publicvoidexecute(JobExecutionContextcontext)throwsJobExecutionException{JobKeykey=context.getJobDetail().getKey();JobDataMapdataMap=context.getJobDetail().getJobDataMap();StringjobSays=dataMap.getString("jobSays");floatmyFloatValue=dataMap.getFloat("myFloatValue");System.err.println("Instance"+key+"ofDumbJobsays:"+jobSays+",andvalis:"+myFloatValue);}}JobExecutionContext能够帮我们合并Trigger和JobDetail上的JobDataMap里面的值,Trigger上的key会覆盖JobDetail上的
publicclassDumbJobimplementsJob{publicDumbJob(){}publicvoidexecute(JobExecutionContextcontext)throwsJobExecutionException{JobKeykey=context.getJobDetail().getKey();JobDataMapdataMap=context.getMergedJobDataMap();//NotethedifferencefromthepreviousexampleStringjobSays=dataMap.getString("jobSays");floatmyFloatValue=dataMap.getFloat("myFloatValue");ArrayListstate=(ArrayList)dataMap.get("myStateData");state.add(newDate());System.err.println("Instance"+key+"ofDumbJobsays:"+jobSays+",andvalis:"+myFloatValue);}}Job实例触发器触发,会加载对应的JobDetail,并且通过配置的Jobfactory来实例化对应的Job
并且尝试在对应的JobFactory上调用与JobDataMap中的键名匹配的setter方法。
@DisallowConcurrentExecution
这个用来加到Job类上面,用来告诉Quartz不要同时执行同一个Job
@PersistJobDataAfterExecution
也是加到Job类上面,告诉Quartz执行完成后(没有出现异常),更新JobDataMap的存储,用来告诉下次执行的时候能够获取当前设置的值。
像Job一样,Trigger也很容易使用,但是确实包含各种自定义选项,在充分利用Quartz之前,您需要了解它们并了解它们。同样,如前所述,您可以选择不同类型的Trigger来满足不同的调度需求。
当我们触发器很多,Quartz线程池的工作线程很少的时候,可能没有足够的资源同事启动所有要触发的触发器,如果没有指定优先级,会使用默认优先级5
优先级配置支持任何整数值正数或者负数
注意:当检测到触发器的作业需要恢复时,其恢复的排定的优先级与原始触发器相同。
publicinterfaceCalendar{publicbooleanisTimeIncluded(longtimeStamp);publiclonggetNextIncludedTime(longtimeStamp);}上述接口都是毫秒,为了方便Quartz还提供了HolidayCalendar来提供整天的排除
使用CronTrigger,您可以指定触发计划,例如“每个星期五中午”,“每个工作日至9:30”,甚至“每个星期一,星期三的上午9:00至10:00之间的每5分钟”和一月的星期五”。
即便如此,与SimpleTrigger一样,CronTrigger具有一个startTime,用于指定计划何时生效;以及一个(可选的)endTime,用于指定计划何时终止。
表达式用于配置CronTrigger的实例。Cron-Expression是实际上由七个子表达式组成的字符串,它们描述了日程表的各个细节。这些子表达式用空格分隔,代表:
各个子表达式可以包含范围和/或列表。
通配符''可以用于表示字段的所有可能值
*代表每一周的每一天
/代表指定值的增量。
:星期几和星期几字段允许使用字符。用于指定“无特定值”。当您需要在两个字段之一中指定某项而不是另一个字段时,这很有用
L:用于月和周,表示最后一个,月表示月的最后一天1月31日,2月28日。用于星期的话表示7或者sat(周六),如果6L表示该月的最后一个最后一个星期五,可以用来指定该月最后一天的偏移量L-3,表示日历月的倒数第三天
W用来指定给定日期的工作日(周一到星期五),15W指的是离每月15日最近的工作日
#用于指定每月的第“n”个XXX工作日。例如,星期几字段中的6#3或FRI#3的值表示每月的第三个星期五。
CronTrigger示例1-用于创建仅每5分钟触发一次的触发器的表达式
00/5***?CronTrigger示例2-创建一个触发器的表达式,该触发器每5分钟触发一次,每分钟后10秒(例如10:00:10am,10:05:10am等)触发。
100/5***?CronTrigger示例3-创建一个触发器的表达式,该触发器在每个星期三和星期五的10:30、11:30、12:30和13:30触发。
03010-13?*WED,FRICronTrigger示例4-创建一个触发器的表达式,该触发器在每月的5号和20号的上午8点到10点之间每半小时触发一次。请注意,触发器不会在上午10:00,仅在8:00、8:30、9:00和9:30触发
00/308-95,20*请注意,某些计划要求太过复杂而无法用一次触发来表达,例如“上午9:00至上午10:00之间每5分钟一次,下午1:00至10:00下午每20分钟一次”。这种情况下的解决方案是简单地创建两个触发器,并注册两个触发器以运行相同的作业。
importstaticorg.quartz.TriggerBuilder.*;importstaticorg.quartz.CronScheduleBuilder.*;importstaticorg.quartz.DateBuilder.*:建立一个触发器,该触发器每天每天从早上8点到下午5点之间每隔一分钟触发一次:trigger=newTrigger().withIdentity("trigger3","group1").withSchedule(cronSchedule("00/28-17**")).forJob("myJob","group1").build();建立触发器,每天10:42am触发trigger=newTrigger().withIdentity("trigger3","group1").withSchedule(dailyAtHourAndMinute(10,42)).forJob(myJobKey).build();或者
trigger=newTrigger().withIdentity("trigger3","group1").withSchedule(cronSchedule("04210**")).forJob(myJobKey).build();构建一个触发器,该触发器将在星期三上午10:42,使用系统默认值以外的TimeZone触发trigger=newTrigger().withIdentity("trigger3","group1").withSchedule(weeklyOnDayAndHourAndMinute(DateBuilder.WEDNESDAY,10,42)).forJob(myJobKey).inTimeZone(TimeZone.getTimeZone("America/Los_Angeles")).build();或者
publicinterfaceJobListener{publicStringgetName();publicvoidjobToBeExecuted(JobExecutionContextcontext);publicvoidjobExecutionVetoed(JobExecutionContextcontext);publicvoidjobWasExecuted(JobExecutionContextcontext,JobExecutionExceptionjobException);}使用自己的监听器要创建侦听器,只需创建一个实现org.quartz.TriggerListener或org.quartz.JobListener接口的对象。然后,在运行时将侦听器注册到调度程序,并且必须给其指定名称(或者说,它们必须通过其getName()方法发布自己的名称)。
侦听器与调度程序的ListenerManager一起注册,该Matcher描述了侦听器要为其接收事件的作业/触发器。
scheduler.getListenerManager().addJobListener(myJobListener,jobKeyEquals(jobKey("myJobName","myJobGroup")));添加对特定组的所有作业感兴趣的JobListenerscheduler.getListenerManager().addJobListener(myJobListener,jobGroupEquals("myJobGroup"));添加对两个特定组的所有作业感兴趣的JobListenerscheduler.getListenerManager().addJobListener(myJobListener,or(jobGroupEquals("myJobGroup"),jobGroupEquals("yourGroup")));添加对所有作业感兴趣的JobListenerscheduler.getListenerManager().addJobListener(myJobListener,allJobs());Quartz的大多数用户都不使用侦听器,但是当应用程序需求创建事件通知的需求时,侦听器非常方便,而Job本身不必显式通知应用程序。
*SchedulerListener*与TriggerListeners和JobListeners非常相似,除了它们在Scheduler自身内接收事件的通知-不一定与特定触发器或作业有关的事件。
publicinterfaceSchedulerListener{publicvoidjobScheduled(Triggertrigger);publicvoidjobUnscheduled(StringtriggerName,StringtriggerGroup);publicvoidtriggerFinalized(Triggertrigger);publicvoidtriggersPaused(StringtriggerName,StringtriggerGroup);publicvoidtriggersResumed(StringtriggerName,StringtriggerGroup);publicvoidjobsPaused(StringjobName,StringjobGroup);publicvoidjobsResumed(StringjobName,StringjobGroup);publicvoidschedulerError(Stringmsg,SchedulerExceptioncause);publicvoidschedulerStarted();publicvoidschedulerInStandbyMode();publicvoidschedulerShutdown();publicvoidschedulingDataCleared();}添加一个SchedulerListenerscheduler.getListenerManager().addSchedulerListener(mySchedListener);删除SchedulerListenerscheduler.getListenerManager().removeSchedulerListener(mySchedListener);9.JobStoreJobStore负责跟踪您提供给调度程序的所有“JobData”:作业,触发器,日历等。为Quartz调度程序实例选择适当的JobStore是重要的一步。
幸运的是,一旦您了解了两者之间的差异,那么选择就非常容易。
要使用RAMJobStore(并假设您正在使用StdSchedulerFactory),只需将类名称org.quartz.simpl.RAMJobStore指定为用于配置石英的JobStore类属性:
org.quartz.jobStore.class=org.quartz.simpl.RAMJobStoreJDBCJobStore
JDBCJobStore也被恰当地命名-它通过JDBC将其所有数据保存在数据库中。因此,它的配置要比RAMJobStore复杂一些,并且速度也没有那么快。
JDBCJobStore几乎可以与任何数据库一起使用,它已被Oracle,PostgreSQL,MySQL,MSSQLServer,HSQLDB和DB2广泛使用。要使用JDBCJobStore,必须首先创建一组数据库表供Quartz使用。您可以在Quartz发行版的docs/dbTables目录中找到表创建SQL脚本。如果没有针对您的数据库类型的脚本,只需查看现有脚本之一,然后以数据库所需的任何方式对其进行修改。需要注意的一件事是,在这些脚本中,所有表都以前缀“QRTZ_”开头(例如表“QRTZ_TRIGGERS”和“QRTZ_JOB_DETAIL”)。只要您告知JDBCJobStore前缀是什么(在Quartz属性中),该前缀实际上就可以是您想要的任何前缀。使用不同的前缀对于创建多个表集,多个调度程序实例可能很有用,
创建表之后,在配置和启动JDBCJobStore之前,您需要做出另一个重要决定。您需要确定您的应用程序需要哪种事物来管理。如果您不需要将调度命令(例如添加和删除触发器)与其他事务绑定,则可以让Quartz通过将JobStoreTX用作JobStore来管理事务(这是最常见的选择)。
如果您需要Quartz与其他事务一起工作(即在J2EE应用程序服务器中),则应使用JobStoreCMT-在这种情况下,Quartz将允许应用程序服务器容器管理事务。
最后一个难题是设置一个数据源,JDBCJobStore可以从该数据源获得与您的数据库的连接。
数据源是使用几种不同方法之一在Quartz属性中定义的。
要使用JDBCJobStore(并假设您使用的是StdSchedulerFactory),首先需要将Quartz配置的JobStore类属性设置为org.quartz.impl.jdbcjobstore.JobStoreTX或org.quartz.impl.jdbcjobstore.JobStoreCMT根据以上几段中的说明进行的选择。
配置Quartz以使用JobStoreTx
org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX接下来,您需要选择一个DriverDelegate供JobStore使用。DriverDelegate负责完成特定数据库可能需要的任何JDBC工作。
StdJDBCDelegate是使用“原始”JDBC代码(和SQL语句)完成其工作的委托。如果没有专门为您的数据库创建的另一个委托,请尝试使用此委托-我们仅对使用StdJDBCDelegate与(发现最多!)发现问题的数据库进行了特定于数据库的委托。其他代表可以在“org.quartz.impl.jdbcjobstore”包或其子包中找到。其他代表包括DB2v6Delegate(用于DB2版本6和更早版本),HSQLDBDelegate(用于HSQLDB),MSSQLDelegate(用于MicrosoftSQLServer),PostgreSQLDelegate(用于PostgreSQL),WeblogicDelegate(用于使用由Weblogic制造的JDBC驱动程序),
选择委托后,将其类名称设置为JDBCJobStore使用的委托。
配置JDBCJobStore以使用DriverDelegate
org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate接下来,您需要通知JobStore您正在使用的表前缀(上面已讨论过)。
使用表前缀配置JDBCJobStore
org.quartz.jobStore.tablePrefix=QRTZ_最后,您需要设置JobStore应该使用哪个数据源。还必须在Quartz属性中定义命名的DataSource。在这种情况下,我们指定Quartz应该使用数据源名称“myDS”(在配置属性的其他位置定义)。
使用要使用的数据源的名称配置JDBCJobStore
org.quartz.jobStore.dataSource=myDS如果您的调度程序很忙(即几乎总是执行与线程池大小相同的作业数),那么您可能应该将DataSource中的连接数设置为线程池大小的+2。可以将“org.quartz.jobStore.useProperty”配置参数设置为“true”(默认为false),以指示JDBCJobStoreJobDataMaps中的所有值均为字符串,因此可以存储为名称-值对,而不是而不是将更复杂的对象以其序列化形式存储在BLOB列中。从长远来看,这样做更加安全,因为可以避免将非String类序列化为BLOB时出现的类版本控制问题。
TerracottaJobStore提供了一种无需使用数据库即可进行缩放和增强功能的方法。这意味着您的数据库可以免于Quartz的负载,而可以为应用程序的其余部分保存所有资源。
TerracottaJobStore可以集群化或非集群化运行,并且在两种情况下都可以为您的作业数据提供一种存储介质,该存储介质在应用程序重新启动之间是持久的,因为数据存储在Terracotta服务器中。它的性能比通过JDBCJobStore使用数据库要好得多(大约好一个数量级),但比RAMJobStore慢得多。
要使用TerracottaJobStore(并假设您使用的是StdSchedulerFactory),只需指定类名称org.quartz.jobStore.class=org.terracotta.quartz.TerracottaJobStore作为用于配置Quartz的JobStore类属性,然后添加一行配置以指定Terracotta服务器的位置:
Quartz的体系结构是模块化的,因此要使其运行,需要将多个组件“绑定”在一起。幸运的是,存在一些帮助实现此目标的助手。
Quartz进行工作之前需要配置的主要组件是:
该*线程池*提供了一组线程供Quartz在执行Jobs时使用。池中的线程越多,可以并行运行的作业数越多。但是,太多线程可能会使您的系统瘫痪。
其他用户发现他们需要10、15、50甚至100个线程-因为它们具有成千上万个具有各种计划的触发器-最终平均有10到100个试图在任何给定时刻执行的作业。
为调度程序池找到合适的大小完全取决于您使用调度程序的目的。没有真正的规则,除了使线程数尽可能小(为了节省计算机资源)外-还要确保有足够的空间按时启动作业。
如果在调度程序配置的misfire阈值期间没有可用的线程,这甚至可能导致线程不触发。
在org.quartz.spi包中定义了ThreadPool接口,您可以按照自己喜欢的任何方式创建ThreadPool实现。Quartz附带了一个简单(但非常令人满意)的线程池,名为org.quartz.simpl.SimpleThreadPool。此ThreadPool只是在其池中维护一组固定的线程-永不增长,永不收缩。但是它非常健壮,并且经过了很好的测试-因为几乎所有使用Quartz的人都使用该池。
这里值得一提的是,所有JobStore都实现了org.quartz.spi.JobStore接口-如果捆绑的JobStore之一不符合您的需求,那么您可以自己制作。
最后,您需要创建Scheduler实例。需要给Scheduler本身一个名称,告诉它的RMI设置,并传递JobStore和ThreadPool的实例。RMI设置包括调度程序是否应将其自身创建为RMI的服务器对象(使其可用于远程连接),要使用的主机和端口等。StdSchedulerFactory(下面讨论)还可以产生实际上是代理的Scheduler实例(RMI存根)到在远程进程中创建的调度程序。
StdSchedulerFactory是org.quartz.SchedulerFactory接口的实现。它使用一组属性(java.util.Properties)创建和初始化QuartzScheduler。
这些属性通常存储在文件中并从文件中加载,但是也可以由程序创建并直接交给工厂。只需在工厂上调用getScheduler()即可生成调度程序,对其进行初始化(及其ThreadPool,JobStore和DataSources),并将句柄返回其公共接口。
Quartz发行版的“docs/config”目录中有一些示例配置(包括属性说明)。您可以在Quartz文档的“Reference”部分下的“Configuration”手册中找到完整的文档。
DirectSchedulerFactory是另一个SchedulerFactory实现。对于希望以更具编程性的方式创建其Scheduler实例的用户来说,这很有用。通常不建议使用它,原因如下:
Quartz使用SLF4J框架来满足其所有日志记录需求。为了“调整”日志记录设置(例如输出的数量以及输出的输出位置),您需要了解SLF4J框架,这不在本文档的讨论范围之内。
如果要捕获有关触发器触发和作业执行的其他信息,则可能对启用org.quartz.plugins.history.LoggingJobHistoryPlugin或org.quartz.plugins.history.LoggingTriggerHistoryPlugin感兴趣。
群集当前可与JDBC-Jobstore(JobStoreTX或JobStoreCMT)和TerracottaJobStore一起使用。功能包括负载平衡和作业故障转移(如果JobDetail的“请求恢复”标志设置为true)。
使用JobStoreTX或JobStoreCMT进行群集通过将org.quartz.jobStore.isClustered属性设置为“true”来启用群集。
集群中的每个实例都应使用quartz.properties文件的相同副本。例外情况是使用相同的属性文件,但允许以下例外:不同的线程池大小和org.quartz.scheduler.instanceId属性的不同值。
集群中的每个节点必须具有唯一的instanceId,可以通过将“AUTO”放置为该属性的值来轻松完成(不需要其他属性文件)。
切勿针对其他实例正在运行的同一组表启动非集群实例。您可能会遇到严重的数据损坏,并且肯定会遇到不稳定的行为
每次触发时,只有一个节点将触发该作业。我的意思是,如果作业具有重复的触发器,告诉它每10秒触发一次,则在12:00:00恰好一个节点将运行该作业,而在12:00:10恰好一个节点将运行作业等等。不一定每次都在同一个节点上-哪个节点运行它或多或少是随机的。对于繁忙的调度程序(大量触发器),负载平衡机制几乎是随机的,但偏向于对于非繁忙的调度程序(例如,一个或两个触发器)仅处于活动状态的同一节点。
您可能还需要考虑如何设置Terracotta服务器的含义,特别是打开诸如持久性等功能以及为HA运行一系列Terracotta服务器的配置选项。
TerracottaJobStore企业版提供高级QuartzWhere功能,可将作业智能地定向到适当的群集节点。
JobStoreCMT允许在较大的JTA事务中执行Quartz调度操作。
通过将org.quartz.scheduler.wrapJobExecutionInUserTransaction属性设置为true,作业还可以在JTA事务(UserTransaction)中执行。
设置此选项后,JTA事务将在Job的execute方法被调用之前开始begin(),而execute调用终止后将进行commit()。这适用于所有作业。
如果要为每个作业指示JTA事务是否应该包装其执行,则应在作业类上使用@ExecuteInJTATransaction批注。
除了Quartz在JTA事务中自动包装Job执行之外,在使用JobStoreCMT时,您在Scheduler接口上进行的调用也会参与事务。只需确保已启动事务,然后再调用调度程序上的方法即可。您可以通过使用UserTransaction来直接执行此操作,也可以将使用调度程序的代码放在使用容器管理的事务的SessionBean中。
Quartz提供了一个用于插入附加功能的接口(org.quartz.spi.SchedulerPlugin)。
可以在*org.quartz.plugins*包中找到Quartz附带的提供各种实用程序功能的插件。它们提供了一些功能,例如在调度程序启动时自动调度作业,记录作业和触发事件的历史记录,并确保在JVM退出时调度程序完全关闭。
触发触发器时,将通过在Scheduler上配置的JobFactory实例化与之关联的Job。默认的JobFactory仅在作业类上调用newInstance()。
您可能需要创建自己的JobFactory实现,以完成诸如使应用程序的IoC或DI容器生成/初始化作业实例之类的事情。
Quartz还提供了许多实用程序作业,您可以在应用程序中使用它们来完成诸如发送电子邮件和调用EJB之类的事情。这些开箱即用的作业可以在*org.quartz.jobs*包中找到。