Quartz2.2.1操作手册

2022-09-30 08:27:29

一、初识quartz

 JobDetail job = newJob(HelloJob.class).withIdentity("job1", "group1").build();

 Trigger trigger = newTrigger().withIdentity("trigger1", "group1").startNow().build();

 Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

 scheduler.scheduleJob(job, trigger);

 scheduler.start();

 scheduler.shutdown();

认识quartz读懂这几行代码就可以了。

1.JobDetail是quartz的真正意义上的job,必须指定JobDetail的name,group属性,这两个属性是JobDetail的唯一标识;
     其中HelloJob是一个implements Job的类,它是真正意义上我们的业务执行类,我们的任务逻辑实现写在execute(JOB接口唯一的方法)的方法里.

2.Trigger是JobDetail的触发器,JobDetail什么时候触发,触发间隔,触发次数都由它来指定;同样Trigger的name,group属性,这两个属性是Trigger的唯一标识;
   一个JobDetail可以被多个Trigger触发.

3.Scheduler将JobDetail和Trigger组合在一起进行工作,Scheduler只有调用start()的方法才会真正的启动调度;
     Scheduler可以先start()启动,再scheduleJob(JobDetail,Trigger);反之亦然,很好理解,因为调度框架启动后就可以自动去调度任务.

二、JobDetail,Trigger的更方便的生成方式
quartz给我们提供了很多便捷的操作,最简单的,静态引入:

  import static org.quartz.JobBuilder.*;

  import static org.quartz.SimpleScheduleBuilder.*;

  import static org.quartz.CronScheduleBuilder.*;

  import static org.quartz.CalendarIntervalScheduleBuilder.*;

  import static org.quartz.TriggerBuilder.*;

  import static org.quartz.DateBuilder.*;

这样,newJob,newTrigger,cronSchedule等一系列方便的方法就可以直接使用了.因为quartz的CronTrigger几乎可以满足所有的开发需求,
所以我的Trigger全部采用CronTrigger来实现,只需生成对应的cron表达式.

三、细谈Job,JobDetail
一个简单的Job如下,事实上复杂的也是这样,只是区别于execute方法体:

 public class HelloJob implements Job {

     public HelloJob() {}

     public void execute(JobExecutionContext context) throws JobExecutionException{

       System.err.println("Hello!  HelloJob is executing.");

     }

 }

如果你想给JobDetail传入参数,可以获取dataMap,并向其中随意put,建议所有属性都为String类型:

 jobDetail.getJobDataMap().put(JOB_DATA_KEY,JSONObject.toJSONString(Object));

如果你想给Trigger传入参数,同样可以获取dataMap,不过这是JobDetail的,要知道trigger本身不需要任何参数,都是为JobDetail服务:

 trigger.getJobDataMap().put(JOB_DATA_KEY, JSONObject.toJSONString(Object));

这样在你的execute方法里你就可以获取刚刚添加的所有参数,建议获取所有的:

 context.getMergedJobDataMap().getString("paramName");

四、监听Trigger,监听JobDetail

很简单
1.创建自己的Listener:

 public class McTriggerListener extends TriggerListenerSupport

 public class McJobListener extends JobListenerSupport

2.scheduler获取ListenerManager添加自己的listener即可:

  scheduler.getListenerManager().addJobListener(mcJobListener, allJobs());

  scheduler.getListenerManager().addTriggerListener(triggerListener);

因为我需要记录任务执行成功失败,记录成功失败条数,失败原因,执行完成后更新状态,所以这里先将监听器摆出来,监听器执行的顺序:

 TriggerListenerSupport.triggerFired()

 JobListenerSupport.jobToBeExecuted()

 Job.execute()

 JobListenerSupport.jobWasExecuted()

 TriggerListenerSupport.triggerComplete()

这样你就可以随意的统计,或者在任务执行前后做自己想做的事情,我觉得这是很重要的.

五、将quartz引入web项目

1.如果web项目不将quartz的Scheduler先实例化并启动,那么quartz的生命周期将无法与web容器同步,导致的结果就是项目停了任务还在继续跑,项目起了任务
不执行,还需要人工执行start()方法,我这里没有用spring,在web.xml中初始化:

 <!-- Quartz -->

 <servlet>

     <servlet-name>QuartzInitializer</servlet-name>

     <servlet-class>org.quartz.ee.servlet.QuartzInitializerServlet</servlet-class>

     <init-param>

         <param-name>config-file</param-name>

         <param-value>/quartz.properties</param-value>

     </init-param>

     <init-param>

         <param-name>shutdown-on-unload</param-name>

         <param-value>true</param-value>

     </init-param>

   　<load-on-startup>2</load-on-startup>

 </servlet>

2.当然了你需要配置quartz的属性文件,扔到maven的resources下即可,很简单如下:

 org.quartz.scheduler.instanceName: MainScheduler     //实例名称

 org.quartz.scheduler.instanceId: instance_one        //实例Id,集群时请设置不同的Id

 org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool     //使用quartz线程池

 org.quartz.threadPool.threadCount = 10

 org.quartz.threadPool.threadPriority = 5

 org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true

 org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX     //使用数据库持久化

 org.quartz.jobStore.tablePrefix = QRTZ_   //表前缀,所需要的表在quartz下载的包中可以找到

 org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate

 org.quartz.jobStore.dataSource = qzDS     //数据源

 org.quartz.jobStore.useProperties=true    //参数类型只能为String

 org.quartz.jobStore.isClustered=false     //是否集群

 org.quartz.dataSource.qzDS.driver = com.mysql.jdbc.Driver

 org.quartz.dataSource.qzDS.URL = jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=utf-8

 org.quartz.dataSource.qzDS.user = root

 org.quartz.dataSource.qzDS.password = 123456

 org.quartz.dataSource.qzDS.maxConnections = 30

3.web启动时自动初始化scheduler,并将其放在ServletContext中,并调用它的start()方法,程序可直接获取此实例,万事俱备:

 SchedulerFactory sf = (SchedulerFactory)servletContext.getAttribute(QuartzInitializerServlet.QUARTZ_FACTORY_KEY);

 Scheduler scheduler = sf.getScheduler();

六、到这步quartz的框框就搭起来了,你可以自己写个管理类,负责添加,修改,暂停,重启,删除Job,比较简单.

quartz官方文档写的已经很详细了,写这篇博客的目的是为了让初学的同学能尽快上手,上手之后再查阅官方文档的一些具体说明,就会事半功倍.

喜欢请关注微信公众号：码农小麦

码农公寓

相关文章