quartz的简单使用-基于2.X（二）【与框架的整合】

与JFinal的集成

JFinal有个插件可以使用以集成。

在 public void configPlugin(Plugins me)中加载插件

QuartzPlugin quartzPlugin = new QuartzPlugin("job.properties");
me.add(quartzPlugin);

配置文件如下

#Job EveryDay Day : 00:10:00 every day
a.job=cn.server.service.ds.JobByDay
a.cron=0 10 0 * * ?
a.enable=true

#Job EveryMonth : 03:00:00 1th every month
b.job=cn.server.service.ds.JobByMonth
b.cron=0 0 3 1 * ?
b.enable=true

#Job Org Data : 02:00:00 every day
c.job=cn.server.service.ds.OrgDataImportService
c.cron=0 30 5 * * ?
c.enable=true


#Job clean sms code fro login Day : 00:10:00 every day
d.job=cn.server.service.ds.JobClear
d.cron=0 10 0 * * ?
d.enable=true

job就是一个实现了Job接口的类，用于写你的实际任务。

另外一个实时的Jfinal插件，原文http://my.oschina.net/superbigfu/blog/206630

QuartzPlugin

import java.util.Properties;

import org.quartz.Scheduler;
import org.quartz.impl.StdSchedulerFactory;

import xidian.wwf.ivc.quartz.QuartzFactory;
import xidian.wwf.ivc.utils.PropertiesUtil;

import com.jfinal.plugin.IPlugin;

/**  * Quartz插件  * @author WWF  */
public class QuartzPlugin implements IPlugin{
    
    
    /**默认配置文件**/
    private String config = "quartz.properties";
    
    public QuartzPlugin(){
        
    }
    
    public QuartzPlugin(String config){
        this.config = config;
    }

    @Override
    public boolean start() {
        try {
            //加载配置文件
            Properties props = PropertiesUtil.loadPropertyFile(config);
            //实例化
            QuartzFactory.sf = new StdSchedulerFactory(props);
            //获取Scheduler
            Scheduler sched = QuartzFactory.sf.getScheduler();
        	    sched.start();
        	    return true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

    @Override
    public boolean stop() {
        try {
            QuartzFactory.sf.getScheduler().shutdown();
            QuartzFactory.sf = null;
            return true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

}

QuartzFactory是我自己写的一个开始job任务的管理类，如下

import static org.quartz.JobBuilder.newJob;
import static org.quartz.TriggerBuilder.newTrigger;

import org.quartz.Job;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.TriggerKey;

import xidian.wwf.ivc.utils.TimeUtil;

/**  * QuartzFactory   * @author WWF  */
public class QuartzFactory {
    
    public static SchedulerFactory sf;
    
    /**  * 定时开始任务  * @param startTime  * @param id  * @param name  * @param group  * @param jobClass  */
    public static void startJobOnce(String startTime, int id,String name,String group,Class<? extends Job> jobClass){
        try {
            Scheduler sched = sf.getScheduler();
            // define the job and tie it to our HelloJob class
              JobDetail job = newJob(jobClass)
                  .withIdentity("job_"+name+"_"+id, "group_"+group+"_"+id)
                  .requestRecovery()
                  .build();
              job.getJobDataMap().put(group+"_"+name, id);
              // 定时执行
              SimpleTrigger trigger = (SimpleTrigger) newTrigger()
                  .withIdentity("trigger_"+name+"_"+id, "group_"+group+"_"+id)
                  .startAt(TimeUtil.StringToDate2(startTime))
                  .build();
              

              sched.scheduleJob(job, trigger);
              sched.start();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    /**  * 停止任务  * @param name  * @param group  * @param id  */
    public static void stopJob(String name,String group,int id){
        try {
            if (sf!=null) {
                Scheduler scheduler = sf.getScheduler();
                TriggerKey triggerKey = TriggerKey.triggerKey("trigger_"+name+"_"+id,"group_"+ group+"_"+id);
                Trigger trigger = scheduler.getTrigger(triggerKey);
                if (trigger!=null) {
                    scheduler.pauseTrigger(triggerKey);
                    scheduler.unscheduleJob(triggerKey);
                    scheduler.deleteJob(trigger.getJobKey());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }



}

因为有时候服务器维护，会关闭tomcat，所以我把调度任务存入到数据库中，可以中断回复，下面是我的quartz.properties配置文件和数据库连接ConnectionProvider

quartz.properties

#==================================================
# 配置实例名和id  
#==================================================
org.quartz.scheduler.instanceName = myScheduler
org.quartz.scheduler.instanceId: my
org.quartz.scheduler.skipUpdateCheck: true

#==================================================
# 配置线程池  
#==================================================
org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount: 5
org.quartz.threadPool.threadPriority: 5

#==================================================
# 配置JobStore 
#==================================================
org.quartz.jobStore.misfireThreshold: 600000

org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
org.quartz.jobStore.useProperties=false
org.quartz.jobStore.dataSource=my
org.quartz.jobStore.tablePrefix=QRTZ_
org.quartz.jobStore.isClustered=true

#==================================================
# 配置数据库
#==================================================
org.quartz.dataSource.my.connectionProvider.class = QuartzConnectionProvider

QuartzConnectionProvider

import java.sql.Connection;
import java.sql.SQLException;
import java.util.Properties;

import org.quartz.utils.ConnectionProvider;

import xidian.wwf.ivc.utils.PropertiesUtil;

import com.alibaba.druid.filter.stat.StatFilter;
import com.alibaba.druid.wall.WallFilter;
import com.jfinal.plugin.druid.DruidPlugin;

/**  * 自定义QuartzConnectionProvider  * @author WWF  */
public class QuartzConnectionProvider implements ConnectionProvider{
    
    private static final String DB_CONFIG="databaseConfig.properties";
    private DruidPlugin druidPlugin;

    @Override
    public Connection getConnection() throws SQLException {
        return druidPlugin.getDataSource().getConnection();
    }

    @Override
    public void initialize() throws SQLException {
        Properties properties = PropertiesUtil.loadPropertyFile(DB_CONFIG);
        druidPlugin = new DruidPlugin(
                properties.getProperty("jdbcUrl"),
                properties.getProperty("user"),
                properties.getProperty("password"),
                properties.getProperty("jdbcDriverClass"));
        // StatFilter提供JDBC层的统计信息
        druidPlugin.addFilter(new StatFilter());
        // WallFilter的功能是防御SQL注入攻击
        WallFilter wallFilter = new WallFilter();
        wallFilter.setDbType("mysql");
        druidPlugin.addFilter(wallFilter);
        druidPlugin.start();
    }

    @Override
    public void shutdown() throws SQLException {
        druidPlugin.stop();
    }

}

QuartzConnectionProvider中使用了DruidPlugin，动态加载数据库配置文件，数据库更换只需要修改数据库配置文件即可

最后，新建一个TestJob

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import xidian.wwf.ivc.utils.TimeUtil;

public class TestJob implements Job{
    
    public TestJob(){
    }

    @Override
    public void execute(JobExecutionContext arg0) throws JobExecutionException {
        System.out.println("开始时间="+TimeUtil.getTimeAll());
        try {
            //JobDataMap dataMap= arg0.getJobDetail().getJobDataMap();
            System.out.println("哇哈哈");
        } catch (Exception e) {
            e.printStackTrace();
        }
        System.out.println("结束时间="+TimeUtil.getTimeAll());
    }
    

}

在afterJFinalStart中新建测试任务

//测试quartz
String startTime = "2014-03-09 09:54:00";
QuartzFactory.startJobOnce(startTime, 5, "test", "testgroup", TestJob.class);

到点了就执行TestJob了。大家还可以根据需要，在QuartzFactory中添加间隔定时调度等，因为我项目就一个定点调度，所以基本都是执行一次即可。

与Spring的整合

Maven来管理项目，需要的Jar包我给大家贴出来。 
quartz-1.8.5.jar 
commons-logging.jar 
spring-core-3.0.5.RELEASE.jar 
spring-beans-3.0.5.RELEASE.jar 
spring-context-3.0.5.RELEASE.jar 
spring-context-support-3.0.5.RELEASE.jar 
spring-asm-3.0.5.RELEASE.jar 
spring-expression-3.0.5.RELEASE.jar 
spring.transaction-3.0.5.RELEASE.jar 
spring-web-3.0.5.RELEASE.jar 
Maven的pom.xml的配置： 

 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>

     <groupId>QtzTest</groupId>
     <artifactId>QtzTest</artifactId>
     <version>1.0</version>

     <properties>
         <springframework.version>3.0.5.RELEASE</springframework.version>
     </properties>

     <dependencies>
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
             <version>${springframework.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context-support</artifactId>
             <version>${springframework.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-tx</artifactId>
             <version>${springframework.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-web</artifactId>
             <version>${springframework.version}</version>
         </dependency>

         <dependency>
             <groupId>org.quartz-scheduler</groupId>
             <artifactId>quartz</artifactId>
             <version>1.8.5</version>
         </dependency>
     </dependencies>

     <build>
         <finalName>${project.artifactId}</finalName>
         <plugins>
             <plugin>
                 <groupId>org.mortbay.jetty</groupId>
                 <artifactId>jetty-maven-plugin</artifactId>
                 <version>7.5.4.v20111024</version>
                 <configuration>
                     <scanIntervalSeconds>10</scanIntervalSeconds>
                     <webApp>
                         <contextPath>/${project.artifactId}</contextPath>
                     </webApp>
                 </configuration>
             </plugin>
         </plugins>
     </build>
 </project>

特别注意一点，与Spring3.1以下版本整合必须使用Quartz1，最初我拿2.1.3的，怎么搞都报错：  
Caused by: org.springframework.beans.factory.CannotLoadBeanClassException: Error loading class [org.springframework.scheduling.quartz.CronTriggerBean] for bean with name 'mytrigger' defined in class path resource [applicationContext.xml]: problem with class file or dependent class; nested exception is java.lang.IncompatibleClassChangeError: class org.springframework.scheduling.quartz.CronTriggerBean has interface org.quartz.CronTrigger as super class 

查看发现spring3.0.5中org.springframework.scheduling.quartz.CronTriggerBean继承了org.quartz.CronTrigger（public class CronTriggerBeanextends CronTrigger），而在quartz2.1.3中org.quartz.CronTrigger是个接口（publicabstract interface CronTrigger extends Trigger），而在quartz1.8.5及1.8.4中org.quartz.CronTrigger是个类（publicclass CronTrigger extends Trigger），从而造成无法在applicationContext中配置触发器。这是spring3.1以下版本和quartz2版本不兼容的一个bug。（感谢tiren的回复，spring3.1以及以后版本支持quartz2）  

在Spring中使用Quartz有两种方式实现：第一种是任务类继承QuartzJobBean，第二种则是在配置文件里定义任务类和要执行的方法，类和方法仍然是普通类。很显然，第二种方式远比第一种方式来的灵活。  

第一种方式的JAVA代码： 

 package com.ncs.hj;

 import org.quartz.JobExecutionContext;
 import org.quartz.JobExecutionException;
 import org.springframework.scheduling.quartz.QuartzJobBean;

 public class SpringQtz extends QuartzJobBean{
     private static int counter = 0;
     protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
         System.out.println();
         long ms = System.currentTimeMillis();
         System.out.println("\t\t" + new Date(ms));
         System.out.println(ms);
         System.out.println("(" + counter++ + ")");
         String s = (String) context.getMergedJobDataMap().get("service");
         System.out.println(s);
         System.out.println();
     }
 }

第二种方式的JAVA代码： 

 package com.ncs.hj;

 import org.quartz.JobExecutionContext;
 import org.quartz.JobExecutionException;
 import org.springframework.scheduling.quartz.QuartzJobBean;

 import java.util.Date;

 public class SpringQtz {
     private static int counter = 0;
     protected void execute()  {
         long ms = System.currentTimeMillis();
         System.out.println("\t\t" + new Date(ms));
         System.out.println("(" + counter++ + ")");
     }
 }

Spring的配置文件： 

 <!------------ 配置调度程序quartz ，其中配置JobDetail有两种方式-------------->
     <!--方式一：使用JobDetailBean，任务类必须实现Job接口 -->
     <bean id="myjob" class="org.springframework.scheduling.quartz.JobDetailBean">
      <property name="name" value="exampleJob"></property>
      <property name="jobClass" value="com.ncs.hj.SpringQtz"></property>
      <property name="jobDataAsMap">
 <map>
     <entry key="service"><value>simple is the beat</value></entry>
 </map>
 ;/property>
     </bean>
     <!--运行时请将方式一注释掉！ -->
     <!-- 方式二：使用MethodInvokingJobDetailFactoryBean，任务类可以不实现Job接口，通过targetMethod指定调用方法-->
     <!-- 定义目标bean和bean中的方法 -->
     <bean id="SpringQtzJob" class="com.ncs.hj.SpringQtz"/>
     <bean id="SpringQtzJobMethod" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
     <property name="targetObject">
         <ref bean="SpringQtzJob"/>
     </property>
     <property name="targetMethod">  <!-- 要执行的方法名称 -->
         <value>execute</value>
     </property>
 </bean>

 <!-- ======================== 调度触发器 ======================== -->
 <bean id="CronTriggerBean" class="org.springframework.scheduling.quartz.CronTriggerBean">
     <property name="jobDetail" ref="SpringQtzJobMethod"></property>
     <property name="cronExpression" value="0/5 * * * * ?"></property>
 </bean>

 <!-- ======================== 调度工厂 ======================== -->
 <bean id="SpringJobSchedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
     <property name="triggers">
         <list>
             <ref bean="CronTriggerBean"/>
         </list>
     </property>
 </bean>

关于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触发 
每天早上6点 
0 6 * * * 
每两个小时 
0 */2 * * * 
晚上11点到早上8点之间每两个小时，早上八点 
0 23-7/2，8 * * * 
每个月的4号和每个礼拜的礼拜一到礼拜三的早上11点 
0 11 4 * 1-3 
1月1日早上4点 
0 4 1 1 *  
最后别忘了在web.xml里面配置Spring： 

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns="http://java.sun.com/xml/ns/javaee"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
           http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
          version="2.5">
     <welcome-file-list>
         <welcome-file>index.html</welcome-file>
     </welcome-file-list>

     <context-param>
         <param-name>contextConfigLocation</param-name>
         <param-value>/WEB-INF/spring-config.xml</param-value>
     </context-param>

     <listener>
         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
     </listener>
 </web-app>

运行结果： 
Wed Feb 08 13:58:30 CST 2012 
(0) 
Wed Feb 08 13:58:35 CST 2012 
(1) 
Wed Feb 08 13:58:40 CST 2012 
(2) 
Wed Feb 08 13:58:45 CST 2012 
(3) 
Wed Feb 08 13:58:50 CST 2012 
(4) 
Wed Feb 08 13:58:55 CST 2012 
(5) 
Wed Feb 08 13:59:00 CST 2012 

首先我们来写一个被调度的类：

package  com.kay.quartz;
public   class  QuartzJob
{

     public   void  work()
    {
    System.out.println( " Quartz的任务调度！！！ " );
    }
}

Spring的配置文件：

<? xml version="1.0" encoding="UTF-8" ?>
<! DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd" >

< beans >     
         <!--  要调用的工作类  -->
         < bean  id ="quartzJob"  class ="com.kay.quartz.QuartzJob" ></ bean >
         <!--  定义调用对象和调用对象的方法  -->
         < bean  id ="jobtask"  class ="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean" >
             <!--  调用的类  -->
             < property  name ="targetObject" >
                 < ref  bean ="quartzJob" />
             </ property >
             <!--  调用类中的方法  -->
             < property  name ="targetMethod" >
                 < value > work </ value >
             </ property >
         </ bean >
         <!--  定义触发时间  -->
         < bean  id ="doTime"  class ="org.springframework.scheduling.quartz.CronTriggerBean" >
             < property  name ="jobDetail" >
                 < ref  bean ="jobtask" />
             </ property >
             <!--  cron表达式  -->
             < property  name ="cronExpression" >
                 < value > 10,15,20,25,30,35,40,45,50,55 * * * * ? </ value >
             </ property >
         </ bean >
         <!--  总管理类 如果将lazy-init='false'那么容器启动就会执行调度程序   -->
         < bean  id ="startQuertz"  lazy-init ="false"  autowire ="no"  class ="org.springframework.scheduling.quartz.SchedulerFactoryBean" >
             < property  name ="triggers" >
                 < list >
                     < ref  bean ="doTime" />
                 </ list >
             </ property >
         </ bean >
    
</ beans >

测试程序：

package  com.kay.quartz;

import  org.springframework.context.ApplicationContext;
import  org.springframework.context.support.ClassPathXmlApplicationContext;

public   class  MainTest
{

     /**
     *  @param  args
      */
     public   static   void  main(String[] args)
    {
        System.out.println( " Test start. " );
        ApplicationContext context  =   new  ClassPathXmlApplicationContext( " quartz-config.xml " );
         // 如果配置文件中将startQuertz bean的lazy-init设置为false 则不用实例化
         // context.getBean("startQuertz");
        System.out.print( " Test end.. " );
        

    }

}