Spring4整合Quartz2实现定时任务

Spring4整合Quartz2实现定时任务

---

Quartz2可以实现非常复杂的定时任务，其时间表达式也是一个非常强大的功能，如在我们需要定义一个动态任务时，通过Quartz可以很容易就实现这种任务。本文通过Spring和Quartz的整合，实现一个可配置的动态任务。

---

1.Maven导入Quartz2的依赖

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

2.定义对象保存任务信息

注：任务实现的是每日或一周内哪些天的某个时间进行任务。

// 定义更新类型，手动、每天某个时间和每周哪些天哪个时间
public enum ServerUpdateType {
    HAND("HAND"), DAILY("DAILY"), WEEKDAYLIY("WEEKDAYLIY");

    private String value;

    ServerUpdateType(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }

    @Override
    public String toString() {
        return this.value;
    }

    public static ServerUpdateType parse(String typeStr) {
        ServerUpdateType ret = null;
        for (ServerUpdateType type : ServerUpdateType.values()) {
           if (type.getValue().equals(typeStr)) {
              ret = type;
              break;
           }
       }
       return ret;
   }
}

@Entity
@Table(name = "Schedule_Job")
public class ScheduleJobInfo implements Serializable{
    private static final long serialVersionUID = -6593963167852392917L;

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private long id;

    @Column(name = "JOB_NAME")
    private String jobName;

    @Column(name = "UPDATE_TYPE")
    private String updateTypeStr;

    @Column(name = "UPDATE_HOUR")
    private int updateHour;

    @Column(name = "UPDATE_MINUTE")
    private int updateMinute;

    // 1~7 1=SUN or SUN,MON,TUE,WED,THU,FRI,SAT
    @Column(name = "UPDATE_WEEKDAYS")
    private String updateWeekDays;

    public ServerUpdateType getUpdateType() {
        return ServerUpdateType.parse(this.updateTypeStr);
    }

    public void setUpdateType(ServerUpdateType updateType) {
        this.updateTypeStr = updateType.getValue();
    }
    // other getter and setter
}

3.将Quartz纳入Spring管理范围内

public final class AutowiringSpringBeanJobFactory extends SpringBeanJobFactory implements
        ApplicationContextAware {

    private transient AutowireCapableBeanFactory beanFactory;

    @Override
    public void setApplicationContext(final ApplicationContext context) {
        beanFactory = context.getAutowireCapableBeanFactory();
    }

    @Override
    protected Object createJobInstance(final TriggerFiredBundle bundle) throws Exception {
        final Object job = super.createJobInstance(bundle);
        beanFactory.autowireBean(job);
        return job;
    }
}

4.添加SchedulerFactoryBean配置

@Configuration
public class SchedulerConfig {
    @Autowired
    private ApplicationContext applicationContext;

    @Bean
    public SchedulerFactoryBean getSchedulerFactoryBean() {
        SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
        // 将Quartz纳入Spring管理范围
        AutowiringSpringBeanJobFactory jobFactory = new AutowiringSpringBeanJobFactory();
        jobFactory.setApplicationContext(applicationContext);
        schedulerFactoryBean.setJobFactory(jobFactory);
        return schedulerFactoryBean;
    }

}

5.建立任务运行入口，实现Job类，可以认为是一个工厂类

@DisallowConcurrentExecution
public class QuartzJobFactory implements Job {
    private static Logger logger = LoggerFactory
            .getLogger(QuartzJobFactory.class.getName());

    @Autowired
    private JobService service;

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        logger.info("-- update task start --");
        ScheduleJobInfo scheduleJob = (ScheduleJobInfo) jobExecutionContext.getMergedJobDataMap().get("scheduleJob");
        logger.info("-- start task " + scheduleJob.getJobName() + ", update type "
                + scheduleJob.getUpdateType().getValue() + " --");
        // 具体进行的任务
        service.doUpdateTask(scheduleJob);
    }
}

6.定义动态任务管理类

// 定义动态任务
public void startAndExecuteJob(ScheduleJobInfo scheduleJob){
    ServerUpdateType type = scheduleJob.getUpdateType();
    if (type == ServerUpdateType.HAND) {
       // close task
       TriggerKey triggerKey = TriggerKey.triggerKey(scheduleJob.getId(), scheduleJob.getJobName());
       scheduler.unscheduleJob(triggerKey);
    } else {
        // start or update task by cronExpression
        if (scheduleJob.getUpdateMinute() == 0 && scheduleJob.getUpdateHour() == 0) {
          throw new ResponseErrorException(Constants.ERROR_SERVER_UPDATETYPE_NOTSUPPORTED,
               "Update time format not supported");
        }
        TriggerKey triggerKey = TriggerKey.triggerKey(scheduleJob.getId(), scheduleJob.getJobName());
        CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);

        // build new cron expression
        CronScheduleBuilder scheduleBuilder = null;
        if (type == ServerUpdateType.DAILY) {
            scheduleBuilder = CronScheduleBuilder.dailyAtHourAndMinute(
                scheduleJob.getUpdateHour(), scheduleJob.getUpdateMinute());
        } else if (type == ServerUpdateType.WEEKDAYLIY) {
            String[] weeks = scheduleJob.getUpdateWeekDays().split(",");
            Integer[] weekdays = new Integer[weeks.length];
            for (int i = 0; i < weeks.length; i++) {
                weekdays[i] = Integer.valueOf(weeks[i]);
            }
            scheduleBuilder = CronScheduleBuilder.atHourAndMinuteOnGivenDaysOfWeek(
                scheduleJob.getUpdateHour(), scheduleJob.getUpdateMinute(), weekdays);
        } else {
            throw new ResponseErrorException(Constants.ERROR_SERVER_UPDATETYPE_NOTSUPPORTED,
                "Server update type not supported");
        }

        // if no task running
        if (null == trigger) {
            JobDetail jobDetail = JobBuilder.newJob(QuartzJobFactory.class)
                .withIdentity(scheduleJob.getId(), scheduleJob.getJobName()).build();
            jobDetail.getJobDataMap().put("scheduleJob", scheduleJob);

            // build new trigger by new cron expression
            trigger = TriggerBuilder.newTrigger().withIdentity(scheduleJob.getId(), scheduleJob.getJobName())
                .withSchedule(scheduleBuilder).build();
            scheduler.scheduleJob(jobDetail, trigger);
        } else {
            // task is running
            // build new trigger by new cron expression
            trigger = trigger.getTriggerBuilder().withIdentity(triggerKey)
                .withSchedule(scheduleBuilder).build();

            //reset task
            scheduler.rescheduleJob(triggerKey, trigger);
        }
    }
}

// 还可以强制执行任务
public void forceExecuteJob(ScheduleJobInfo scheduleJob){
    TriggerKey triggerKey = TriggerKey.triggerKey(scheduleJob.getId(), scheduleJob.getJobName());
    CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);

    if (null == trigger) {
        // if no task running
        JobDetail jobDetail = JobBuilder.newJob(QuartzJobFactory.class)
            .withIdentity(scheduleJob.getId(), scheduleJob.getJobName()).build();
        jobDetail.getJobDataMap().put("scheduleJob", scheduleJob);

        // build new trigger by new cron expression
        SimpleTrigger simpleTrigger = TriggerBuilder.newTrigger()
            .withIdentity(scheduleJob.getId(), scheduleJob.getJobName())
            // count(1)表示该任务只执行一次
            .withSchedule(SimpleScheduleBuilder.repeatSecondlyForTotalCount(1)).build();
        scheduler.scheduleJob(jobDetail, simpleTrigger);
    } else {
        JobKey jobKey = JobKey.jobKey(scheduleJob.getId(), scheduleJob.getJobName());
        scheduler.triggerJob(jobKey);
    }
}

上面的CronScheduleBuilder中使用的是其内置的相关方法，里面有如：

// 每日某个时间执行
public static CronScheduleBuilder dailyAtHourAndMinute(int hour, int minute) {...} 
// 一周哪些天某个时间执行
public static CronScheduleBuilder atHourAndMinuteOnGivenDaysOfWeek(int hour, int minute, Integer... daysOfWeek) {...}
// 每周哪天某个时间执行 
public static CronScheduleBuilder weeklyOnDayAndHourAndMinute(int dayOfWeek, int hour, int minute) {...}
// 每月某天某个时间执行
public static CronScheduleBuilder monthlyOnDayAndHourAndMinute(int dayOfMonth, int hour, int minute) {...}
...

当然最强大的还是其CronExpression
CronScheduleBuilder还有方法可以传入一个合法的CronExpression来构造一个定时任务，查看上面代码的源码也不能发现其实本质还是CronExpression。下面是CronExpression的一些介绍：

一个cron表达式有至少6个（也可能7个）有空格分隔的时间元素。按顺序依次为1.秒（0~59）2.分钟（0~59）3.小时（0~23）4.天（月）（0~31，但是你需要考虑你月的天数）5.月（0~11）6.天（星期）（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT）7.年份（1970－2099）
其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?.
0 0 10,14,16 * * ? 每天上午10点，下午2点，4点0 0/30 9-17 * * ??? 朝九晚五工作时间内每半小时0 0 12 ? * WED 表示每个星期三中午12点
有些子表达式能包含一些范围或列表例如：子表达式（天（星期））可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”
“*”字符代表所有可能的值因此，“*”在子表达式（月）里表示每个月的含义，“*”在子表达式（天（星期））表示星期的每一天
“/”字符用来指定数值的增量例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟 ;在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”
“L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写
但是它在两个子表达式里的含义是不同的。
在天（月）子表达式中，“L”表示一个月的最后一天 ,在天（星期）自表达式中，“L”表示一个星期的最后一天，也就是SAT
如果在“L”前有具体的内容，它就具有其他的含义了
例如：“6L”表示这个月的倒数第６天，“FRIL”表示这个月的最后一个星期五
注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题
============================================

CronTrigger配置完整格式为： [秒] [分] [小时] [日] [月] [周] [年]

 序号    说明     是否必填     允许填写的值    允许的通配符    
 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"前只能设置具体的数字,不允许区间"-").# 序号(表示每月的第几个周几)，例如在周字段上设置"6#3"表示在每月的第三个周六.注意如果指定"#5",正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了) ；小提示：'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分、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分触发(光棍节)