Quartz动态添加、修改和删除定时任务时间的方法以及日期转换cron表达式时间格式工具类

最新推荐文章于 2024-08-04 07:00:00 发布

置顶 csdn_dengyu

最新推荐文章于 2024-08-04 07:00:00 发布

阅读量1.4w

点赞数 8

文章标签： quartz QuartzManager QuartzCronDateUtils

本文链接：https://blog.csdn.net/u010377605/article/details/77801896

版权

Quartz是一个完全由java编写的定时工作任务调度框架，功能十分强大。本文主要讲解工作中使用的Quartz框架动态的操作定时任务。使用Java Quartz2.2版本。在使用Quartz之前，需要理解几个重要的对象：scheduler 调度器,用于工作任务调度；trigger 触发器，用于定义任务调度时间规则;job 工作任务;jobdetail工作任务详情；misfire 错过的，指本来应该被执行但实际没有被执行的任务调度，也就是你设置的触发时间cron已经是历史时间了，无法被命中；最后一个JobDataMap类，它是一个键值对对象，可以获取Job 类中传递过来的数据并进行访问。下面一步步介绍Quartz的使用步骤：

1 下载jar包，使用maven构建项目，在需要在pom.xml中加入依赖

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

2 编写工具类com.huato.util.QuartzCronDateUtils，日期转换cron表达式用的

package com.huato.util;

import java.text.SimpleDateFormat;
import java.util.Date;

public class QuartzCronDateUtils {
	/*** 
     *  功能描述：日期转换cron表达式时间格式
     * @param date 
     * @param dateFormat : e.g:yyyy-MM-dd HH:mm:ss 
     * @return 
     */  
    public static String formatDateByPattern(Date date,String dateFormat){  
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);  
        String formatTimeStr = null;  
        if (date != null) {  
            formatTimeStr = sdf.format(date);  
        }  
        return formatTimeStr;  
    }  
    /*** 
     * convert Date to cron ,eg.  "14 01 17 22 07 ? 2017" 
     * @param date:时间点 
     * @return 
     */  
    public static String getCron(java.util.Date  date){  
        String dateFormat="ss mm HH dd MM ? yyyy";  
        return formatDateByPattern(date,dateFormat);  
    }  
}

3 编写动态任务调度管理器工具类，实现CRUD管理定时器。com.huato.weixin.quartz.QuartzManager

package com.huato.weixin.quartz;

import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.TriggerKey;
import org.quartz.impl.StdSchedulerFactory;
/**
 * 功能:封装了 Quartz 2.2 动态添加、修改和删除定时任务时间的方法
 * @author dengyu
 * @date  2017-07-22
 */
public class QuartzManager {
	
	private static SchedulerFactory schedulerFactory = new StdSchedulerFactory();

    /**
 	 * 功能： 添加一个定时任务 
     * @param jobName 任务名 
     * @param jobGroupName  任务组名 
     * @param triggerName 触发器名 
     * @param triggerGroupName 触发器组名 
     * @param jobClass  任务的类类型  eg:TimedMassJob.class
     * @param cron   时间设置 表达式，参考quartz说明文档  
     * @param objects  可变参数需要进行传参的值
     */
    public static void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Class jobClass, String cron,Object...objects) {  
        try {  
            Scheduler scheduler = schedulerFactory.getScheduler();  
            // 任务名，任务组，任务执行类
            JobDetail jobDetail= JobBuilder.newJob(jobClass).withIdentity(jobName, jobGroupName).build();
            // 触发器  
	        if(objects!=null){
	        	for (int i = 0; i < objects.length; i++) {
	        		//该数据可以通过Job中的JobDataMap dataMap = context.getJobDetail().getJobDataMap();来进行参数传递值
	        		jobDetail.getJobDataMap().put("data"+(i+1), objects[i]);
				}
	        }
            TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
            // 触发器名,触发器组  
            triggerBuilder.withIdentity(triggerName,triggerGroupName);
            triggerBuilder.startNow();
            // 触发器时间设定  
            triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
            // 创建Trigger对象
            CronTrigger trigger = (CronTrigger) triggerBuilder.build();
            // 调度容器设置JobDetail和Trigger
            scheduler.scheduleJob(jobDetail, trigger);  
            // 启动  
            if (!scheduler.isShutdown()) {  
            	scheduler.start();  
            }  
        } catch (Exception e) {  
            throw new RuntimeException(e);  
        }  
    }  

    /** 
     * 功能：修改一个任务的触发时间
     * @param jobName 
     * @param jobGroupName
     * @param triggerName 触发器名
     * @param triggerGroupName 触发器组名 
     * @param cron   时间设置，参考quartz说明文档   
     */  
    public static void modifyJobTime(String jobName, String jobGroupName, String triggerName, String triggerGroupName, String cron) {  
        try {  
            Scheduler scheduler = schedulerFactory.getScheduler();  
            TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
            CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);  
            if (trigger == null) {  
                return;  
            }  
            String oldTime = trigger.getCronExpression();  
            if (!oldTime.equalsIgnoreCase(cron)) { 
                // 触发器  
                TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
                // 触发器名,触发器组  
                triggerBuilder.withIdentity(triggerName, triggerGroupName);
                triggerBuilder.startNow();
                // 触发器时间设定  
                triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
                // 创建Trigger对象
                trigger = (CronTrigger) triggerBuilder.build();
                // 方式一 ：修改一个任务的触发时间
                scheduler.rescheduleJob(triggerKey, trigger);
            }  
        } catch (Exception e) {  
            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 scheduler = schedulerFactory.getScheduler();  

            TriggerKey triggerKey = TriggerKey.triggerKey(triggerName,triggerGroupName);
            // 停止触发器  
            scheduler.pauseTrigger(triggerKey);
            // 移除触发器  
            scheduler.unscheduleJob(triggerKey);
            // 删除任务  
            scheduler.deleteJob(JobKey.jobKey(jobName,jobGroupName));
        } catch (Exception e) {  
            throw new RuntimeException(e);  
        }  
    }  

	/**
	 * 
	 * 功能：启动所有定时任务
	 */
	public static void startJobs() {
		try {
			Scheduler scheduler = schedulerFactory.getScheduler();
			scheduler.start();
		} catch (Exception e) {
			throw new RuntimeException(e);
		}
	}
	/**
	 * 功能：关闭所有定时任务
	 */
	public static void shutdownJobs() {
		try {
			Scheduler scheduler = schedulerFactory.getScheduler();
			if (!scheduler.isShutdown()) {
				scheduler.shutdown();
			}
		} catch (Exception e) {
			throw new RuntimeException(e);
		}
	}

4.编写com.huato.weixin.quartz.TimedMassJob实现org.quartz.Job接口

package com.huato.weixin.quartz;

import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import com.huato.dto.BasicInfoDTO;
import com.huato.system.service.IMassMsgService;
import com.huato.system.service.impl.MassMsgServiceImpl;
import com.huato.vo.MassVO;
/**
 * 功能:定时群发工作任务
 * @author dengyu
 * @date 2017-07-22
 */
public class TimedMassJob implements org.quartz.Job {
	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
		JobDataMap dataMap = context.getJobDetail().getJobDataMap();
		MassVO massVO = (MassVO) dataMap.get("data1");
		BasicInfoDTO basicInfo = (BasicInfoDTO) dataMap.get("data2");
		IMassMsgService massMsgService = new MassMsgServiceImpl();
		massMsgService.sendMassMessage(basicInfo, massVO);
	}  
}


}

这样就完成了一个定时群发消息的工作任务。注意:Quartz框架默认是支持并发的。