Spring+quartz 实现动态管理任务
- - 寒江孤影在实际项目应用中经常会用到定时任务，可以通过quartz和spring的简单配置即可完成，但如果要改变任务的执行时间、频率，废弃任务等就需要改变配置甚至代码需要重启服务器，这里介绍一下如何通过quartz与spring的组合实现动态的改变定时任务的状态的一个实现. 本文章适合对quartz和spring有一定了解的读者.
Spring+quartz 实现动态管理任务
标签：
spring
quartz
管理
| 发表时间：2015-04-28 15:21 | 作者：windows9834
出处：http://windows9834.blog.163.com
在实际项目应用中经常会用到定时任务，可以通过quartz和spring的简单配置即可完成，但如果要改变任务的执行时间、频率，废弃任务等就需要改变配置甚至代码需要重启服务器，这里介绍一下如何通过quartz与spring的组合实现动态的改变定时任务的状态的一个实现。
本文章适合对quartz和spring有一定了解的读者。
spring版本为3.2 quartz版本为2.2.1 如果使用了quartz2.2.1 则spring版本需3.1以上
spring版本为3.2 quartz版本为2.2.1 如果使用了quartz2.2.1 则spring版本需3.1以上
1、spring配置文件中引入注册bean
2、LoadTask.java（初始化加载数据库任务）<bean id="schedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean" />
<bean id="loadTask" class="*.quartz.LoadTask" init-method="initTask" />
3、TaskService.javapublic class LoadTask {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private TaskService taskService;
public void initTask() throws SchedulerException {
// 可执行的任务列表
List<QuartzJobBean> taskList = taskService.getTaskList();
logger.info("初始化加载定时任务......");
for (QuartzJobBean job : taskList) {
taskService.addJob(job);
}
}
}
4、TaskUtils.javaService(value = "taskService")
public class TaskService {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private SchedulerFactoryBean schedulerFactoryBean;
@Reference(registry = "real-registry")
private DataExchangeModuleService moduleService;
/**
* 获取单个任务
* @param jobName
* @param jobGroup
* @return
* @throws SchedulerException
*/
public QuartzJobBean getJob(String jobName,String jobGroup) throws SchedulerException{
QuartzJobBean job = null;
Scheduler scheduler = schedulerFactoryBean.getScheduler();
TriggerKey triggerKey = TriggerKey.triggerKey(jobName, jobGroup);
CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
if (null != trigger) {
job = new QuartzJobBean();
job.setJobName(jobName);
job.setJobGroup(jobGroup);
job.setDescription("触发器:" + trigger.getKey());
job.setNextTime(trigger.getNextFireTime()); //下次触发时间
job.setPreviousTime(trigger.getPreviousFireTime());//上次触发时间
Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());
job.setJobStatus(triggerState.name());
if (trigger instanceof CronTrigger) {
CronTrigger cronTrigger = (CronTrigger) trigger;
String cronExpression = cronTrigger.getCronExpression();
job.setCronExpression(cronExpression);
}
}
return job;
}
/**
* 获取所有任务
* @return
* @throws SchedulerException
*/
public List<QuartzJobBean> getAllJobs() throws SchedulerException{
Scheduler scheduler = schedulerFactoryBean.getScheduler();
GroupMatcher<JobKey> matcher = GroupMatcher.anyJobGroup();
Set<JobKey> jobKeys = scheduler.getJobKeys(matcher);
List<QuartzJobBean> jobList = new ArrayList<QuartzJobBean>();
for (JobKey jobKey : jobKeys) {
List<? extends Trigger> triggers = scheduler.getTriggersOfJob(jobKey);
for (Trigger trigger : triggers) {
QuartzJobBean job = new QuartzJobBean();
job.setJobName(jobKey.getName());
job.setJobGroup(jobKey.getGroup());
job.setDescription("触发器:" + trigger.getKey());
job.setNextTime(trigger.getNextFireTime()); //下次触发时间
// trigger.getFinalFireTime();//最后一次执行时间
job.setPreviousTime(trigger.getPreviousFireTime());//上次触发时间
// trigger.getStartTime();//开始时间
// trigger.getEndTime();//结束时间
//触发器当前状态
Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());
job.setJobStatus(triggerState.name());
//
if (trigger instanceof CronTrigger) {
CronTrigger cronTrigger = (CronTrigger) trigger;
String cronExpression = cronTrigger.getCronExpression();
job.setCronExpression(cronExpression);
}
jobList.add(job);
}
}
return jobList;
}
/**
* 所有正在运行的job
*
* @return
* @throws SchedulerException
*/
public List<QuartzJobBean> getRunningJob() throws SchedulerException {
Scheduler scheduler = schedulerFactoryBean.getScheduler();
List<JobExecutionContext> executingJobs = scheduler.getCurrentlyExecutingJobs();
List<QuartzJobBean> jobList = new ArrayList<QuartzJobBean>(executingJobs.size());
for (JobExecutionContext executingJob : executingJobs) {
QuartzJobBean job = new QuartzJobBean();
JobDetail jobDetail = executingJob.getJobDetail();
JobKey jobKey = jobDetail.getKey();
Trigger trigger = executingJob.getTrigger();
job.setJobName(jobKey.getName());
job.setJobGroup(jobKey.getGroup());
job.setDescription("触发器:" + trigger.getKey());
Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());
job.setJobStatus(triggerState.name());
if (trigger instanceof CronTrigger) {
CronTrigger cronTrigger = (CronTrigger) trigger;
String cronExpression = cronTrigger.getCronExpression();
job.setCronExpression(cronExpression);
}
jobList.add(job);
}
return jobList;
}
/**
* 查询任务列表
* @return
*/
public List<QuartzJobBean> getTaskList(){
List<QuartzJobBean> jobs = new ArrayList<QuartzJobBean>();
List<DataExchangeModuleBO> taskList = moduleService.findAll();
QuartzJobBean job = null;
for(DataExchangeModuleBO bo:taskList){
job = getTask(bo);
if(job!=null){
jobs.add(job);
}
}
return jobs;
}
/**
* 查询任务列表
* @return
*/
public QuartzJobBean getTask(DataExchangeModuleBO bo){
QuartzJobBean job = null;
if(bo!=null){
job = new QuartzJobBean();
job.setJobId(String.valueOf(bo.getId()));
job.setJobName(bo.getModuleName());
job.setJobGroup(bo.getSystemName());
job.setJobStatus(bo.getStatus());//初始状态
job.setCronExpression(bo.getCron());
job.setSpringId(bo.getSpringId());
job.setConcurrent(bo.getConcurrent());
job.setJobClass(bo.getClazzName());
job.setMethodName(bo.getMethodName());
job.setDescription(bo.getSystemName()+"->"+bo.getModuleName()+"->"+bo.getInterfaceInfo());
}
return job;
}
/**
* 添加任务
*
* @param scheduleJob
* @throws SchedulerException
*/
public boolean addJob(QuartzJobBean job) throws SchedulerException {
if (job == null || !QuartzJobBean.STATUS_RUNNING.equals(job.getJobStatus())) {
return false;
}
if(!TaskUtils.isValidExpression(job.getCronExpression())){
logger.error("时间表达式错误（"+job.getJobName()+","+job.getJobGroup()+"）,"+job.getCronExpression());
return false;
}else{
Scheduler scheduler = schedulerFactoryBean.getScheduler();
// 任务名称和任务组设置规则： // 名称：task_1 .. // 组 ：group_1 ..
TriggerKey triggerKey = TriggerKey.triggerKey(job.getJobName(), job.getJobGroup());
CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
// 不存在，创建一个
if (null == trigger) {
//是否允许并发执行
Class<? extends Job> clazz = QuartzJobBean.CONCURRENT_IS.equals(job.isConcurrent()) ? QuartzJobFactory.class : QuartzJobFactoryDisallowConcurrentExecution.class;
JobDetail jobDetail = JobBuilder.newJob(clazz).withIdentity(job.getJobName(), job.getJobGroup()).build();
jobDetail.getJobDataMap().put("scheduleJob", job);
// 表达式调度构建器
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(job.getCronExpression());
// 按新的表达式构建一个新的trigger
trigger = TriggerBuilder.newTrigger().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();
scheduler.scheduleJob(jobDetail, trigger);
} else { // trigger已存在，则更新相应的定时设置
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(job.getCronExpression());
// 按新的cronExpression表达式重新构建trigger
trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();
// 按新的trigger重新设置job执行
scheduler.rescheduleJob(triggerKey, trigger);
}
}
return true;
}
/**
* 暂停任务
* @param scheduleJob
* @return
*/
public boolean pauseJob(QuartzJobBean scheduleJob){
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
try {
scheduler.pauseJob(jobKey);
return true;
} catch (SchedulerException e) {
}
return false;
}
/**
* 恢复任务
* @param scheduleJob
* @return
*/
public boolean resumeJob(QuartzJobBean scheduleJob){
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
try {
scheduler.resumeJob(jobKey);
return true;
} catch (SchedulerException e) {
}
return false;
}
/**
* 删除任务
*/
public boolean deleteJob(QuartzJobBean scheduleJob){
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
try{
scheduler.deleteJob(jobKey);
return true;
} catch (SchedulerException e) {
}
return false;
}
/**
* 立即执行一个任务
* @param scheduleJob
* @throws SchedulerException
*/
public void testJob(QuartzJobBean scheduleJob) throws SchedulerException{
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.triggerJob(jobKey);
}
/**
* 更新任务时间表达式
* @param scheduleJob
* @throws SchedulerException
*/
public void updateCronExpression(QuartzJobBean scheduleJob) throws SchedulerException{
Scheduler scheduler = schedulerFactoryBean.getScheduler();
TriggerKey triggerKey = TriggerKey.triggerKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
//获取trigger，即在spring配置文件中定义的 bean id="myTrigger"
CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
//表达式调度构建器
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(scheduleJob.getCronExpression());
//按新的cronExpression表达式重新构建trigger
trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();
//按新的trigger重新设置job执行
scheduler.rescheduleJob(triggerKey, trigger);
}
5、QuartzJobFactory.javapublic class TaskUtils {
private final static Logger logger = LoggerFactory.getLogger(TaskUtils.class);
/**
* 通过反射调用scheduleJob中定义的方法
*
* @param scheduleJob
*/
public static void invokMethod(QuartzJobBean scheduleJob) {
Object object = null;
Class<?> clazz = null;
//springId不为空先按springId查找bean
if (StringUtils.isNotBlank(scheduleJob.getSpringId())) {
object = SpringUtils.getBean(scheduleJob.getSpringId());
} else if (StringUtils.isNotBlank(scheduleJob.getJobClass())) {//按jobClass查找
try {
clazz = Class.forName(scheduleJob.getJobClass());
object = clazz.newInstance();
} catch (Exception e) {
e.printStackTrace();
}
}
if (object == null) {
logger.error("任务名称 = [" + scheduleJob.getJobName() + "]---------------未启动成功，请检查执行类是否配置正确！！！");
return;
}
clazz = object.getClass();
Method method = null;
try {
method = clazz.getDeclaredMethod(scheduleJob.getMethodName());
} catch (NoSuchMethodException e) {
logger.error("任务名称 = [" + scheduleJob.getJobName() + "]---------------未启动成功，请检查执行类的方法名是否设置错误！！！");
} catch (SecurityException e) {
e.printStackTrace();
}
if (method != null) {
try {
method.invoke(object);
} catch (IllegalAccessException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IllegalArgumentException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (InvocationTargetException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
/**
* 判断cron时间表达式正确性
* @param cronExpression
* @return
*/
public static boolean isValidExpression(final String cronExpression){
// CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
CronTriggerImpl trigger = new CronTriggerImpl();
try {
trigger.setCronExpression(cronExpression);
Date date = trigger.computeFirstFireTime(null);
return date != null && date.after(new Date());
} catch (ParseException e) {
}
return false;
}
public static void main(String[] args){
System.out.println(isValidExpression("0 0/1 * * * ?"));
}
/*
* 任务运行状态
*/
public enum TASK_STATE{
NONE("NONE","未知"),
NORMAL("NORMAL", "正常运行"),
PAUSED("PAUSED", "暂停状态"),
COMPLETE("COMPLETE",""),
ERROR("ERROR","错误状态"),
BLOCKED("BLOCKED","锁定状态");
private TASK_STATE(String index,String name) {
this.name = name;
this.index = index;
}
private String index;
private String name;
public String getName() {
return name;
}
public String getIndex() {
return index;
}
}
}
6、QuartzJobFactoryDisallowConcurrentExecution.java/**
* Job实现类 无状态
* 若此方法上一次还未执行完，而下一次执行时间轮到时则该方法也可并发执行
* @author root
*/
public class QuartzJobFactory implements Job {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
QuartzJobBean scheduleJob = (QuartzJobBean)context.getMergedJobDataMap().get("scheduleJob");
logger.info("运行任务名称 = [" + scheduleJob.getJobName() + "]");
TaskUtils.invokMethod(scheduleJob);
}
}
7、QuartzJobBean.java/**
* Job有状态实现类，不允许并发执行
* 若一个方法一次执行不完下次轮转时则等待该方法执行完后才执行下一次操作
* 主要是通过注解：@DisallowConcurrentExecution
* @author root
*
*/
@DisallowConcurrentExecution
public class QuartzJobFactoryDisallowConcurrentExecution implements Job {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
QuartzJobBean scheduleJob = (QuartzJobBean)context.getMergedJobDataMap().get("scheduleJob");
logger.info("运行任务名称 = [" + scheduleJob.getJobName() + "]");
TaskUtils.invokMethod(scheduleJob);
}
}
8、DECMService.javapublic static final String STATUS_RUNNING = "1";
public static final String STATUS_NOT_RUNNING = "0";
public static final String CONCURRENT_IS = "1";
public static final String CONCURRENT_NOT = "0";
/** 任务id */
private String jobId;
/** 任务名称 */
private String jobName;
/** 任务分组，任务名称+组名称应该是唯一的 */
private String jobGroup;
/** 任务初始状态 0禁用 1启用 2删除*/
private String jobStatus;
/** 任务是否有状态（并发） */
private String isConcurrent = "1";
/** 任务运行时间表达式 */
private String cronExpression;
/** 任务描述 */
private String description;
/** 任务调用类在spring中注册的bean id，如果spingId不为空，则按springId查找 */
private String springId;
/** 任务调用类名，包名+类名，通过类反射调用 ，如果spingId为空，则按jobClass查找 */
private String jobClass;
/** 任务调用的方法名 */
private String methodName;
/** 启动时间 */
private Date startTime;
/** 前一次运行时间 */
private Date previousTime;
/** 下次运行时间 */
private Date nextTime;
此类就是所有具体要调用的任务方法都写在此服务类中。
相关 [spring quartz 管理] 推荐：
spring quartz 集群配置
- - CSDN博客推荐文章Quartz 是一个开源的作业调度框架，它完全由 Java 写成，并设计用于 J2SE 和 J2EE 应用中. 它提供了巨大的灵活性而不牺牲简单性. 你能够用它来为执行一个作业而创建简单的或复杂的调度. 在项目中有大量的后台任务需要调度执行，如构建索引、统计报表、周期同步数据等等，要求任务调度系统具备高可用性、负载均衡特性，使用Quartz 会很方便.
quartz spring 实现动态定时任务
- - 企业架构 - ITeye博客在实际项目应用中经常会用到定时任务，可以通过quartz和spring的简单配置即可完成，但如果要改变任务的执行时间、频率，废弃任务等就需要改变配置甚至代码需要重启服务器，这里介绍一下如何通过quartz与spring的组合实现动态的改变定时任务的状态的一个实现. 参考文章： http://www.meiriyouke.net/?p=82.
Quartz任务监控管理 (1)
- - Java - 编程语言 - ITeye博客Quartz任务监控管理，类似Windows任务管理器，可以获得运行时的实时监控，查看任务运行状态，动态增加任务，暂停、恢复、移除任务等. 对于动态增加任务，可以参加我的前一篇文章《Quartz如何在Spring动态配置时间》，本文在前文的基础上扩展，增加暂停、恢复、移除任务等功能，实现Quartz任务监控管理.
Spring实现后台的任务调度TimerTask和Quartz
- - CSDN博客互联网推荐文章最近整后台，涉及到两个后台调度的问题. 一是以时间间隔为条件的轮询调度；. 运用场景：每隔5分钟抓取数据；. 二是一某个时间点为条件的轮询调度；. 运用场景：后台日志货报表生成上传，每个周一生成上一周的，每个月初生成上一月. 其实按周来执行调度，用前面一个场景也可以实现，但是按月生成，因为每月时间不固定，必须动态判断和执行.
spring quartz学习总结： cluster的配置和示例
- - 开源软件 - ITeye博客 在前面一篇 文章里我们讨论了quartz和spring quartz的基本流程以及配置，这里针对一些quartz应用的场景和配置重点解读一下quartz的cluster配置和应用. 在前面的执行quartz任务的环境里，我们都是在单独的一台机器上执行任务. 这种单点执行的方式存在着一些问题.
Spring 任务调度Quartz的cron表达式
- - ITeye博客Spring支持基于Quartz的任务调度，那么其cron表达式类似于Linux的crontab，有7个字符构成，详情如下：. 表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五. 表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即等同于10,11,12.
Spring+Quartz实现动态添加定时任务
- - 编程语言 - ITeye博客quartz集群分布式(并发)部署解决方案-Spring
- - 企业架构 - ITeye博客项目中使用分布式并发部署定时任务，多台跨JVM，按照常理逻辑每个JVM的定时任务会各自运行，这样就会存在问题，多台分布式JVM机器的应用服务同时干活，一个是加重服务负担，另外一个是存在严重的逻辑问题，. 比如需要回滚的数据，就回滚了多次，刚好quartz提供很好的解决方案. 集群分布式并发环境中使用QUARTZ定时任务调度，会在各个节点会上报任务，存到数据库中，执行时会从数据库中取出触发器来执行，如果触发器的名称和执行时间相同，则只有一个节点去执行此任务.
spring实现对quartz的动态增删改及启动、停止操作
- - 编程语言 - ITeye博客通过spring的这里用到spring的 org.springframework.scheduling.quartz.SchedulerFactoryBean 可以轻松实现对quartz中定时任务的管理. * @param triggerGroupName 触发器组名. 时间设置，参考quartz说明文档.