使用 Quartz 實現任務的動態管理

原文地址：http://blog.csdn.net/shawearn1027/article/details/51457495

【寫在前面】

　　1. 本文中使用的 Quartz 版本爲 1.8.6；

　　2. 本文不會對 Quartz 做太多介紹；

　　3. 本文不會對代碼做過多解釋，因爲大部分已經在代碼的註釋中說明過了；

　　4. 目前官網上最新的 Quartz 版本爲 2.2.3，最新版的接口與本文所採用的 1.8.6 接口並不相同，使用本例代碼請注意 Quartz 版本問題；

　　5. Quartz 官網地址：http://www.quartz-scheduler.org/

　　6. 本文爲作者原創，轉載請註明文章出處：http://blog.csdn.net/shawearn1027

【正文】

1. 定義對任務的管理的接口：

package com.shawearn.quartz.util;

import java.text.ParseException;

import org.quartz.SchedulerException;

/**
 * 定時任務工具類，用於管理定時任務；
 * 
 * @author Shawearn
 *
 */
public interface QuartzUtil {

	/**
	 * 添加一個定時任務，使用傳入的任務名、任務羣組名、觸發器名、觸發器羣組名；
	 * 
	 * @param jobName 任務名；
	 * @param jobGroupName 任務的羣組名；
	 * @param triggerName 觸發器名；
	 * @param triggerGroupName 觸發器羣組名；
	 * @param jobClass 任務類；
	 * @param cronExpression cron表達式，用於指定任務的執行時間，參考 Quartz 說明文檔；
	 * @throws SchedulerException 
	 * @throws ParseException 
	 */
	public void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Class jobClass, String cronExpression) throws SchedulerException, ParseException;
	
	/**
	 * 修改任務的執行時間；
	 * 
	 * @param jobName 任務名；
	 * @param jobGroupName 任務的羣組名；
	 * @param triggerName 觸發器名；
	 * @param triggerGroupName 觸發器羣組名；
	 * @param cronExpression cron表達式，用於指定任務的執行時間，參考 Quartz 說明文檔；
	 * @throws SchedulerException 
	 * @throws ParseException 
	 */
	public void modifyJobTime(String jobName, String jobGroupName, String triggerName, String triggerGroupName, String cronExpression) throws SchedulerException, ParseException;
	
	/**
	 * 移除指定任務；
	 * 
	 * @param jobName 任務名；
	 * @param jobGroupName 任務的羣組名；
	 * @param triggerName 觸發器名；
	 * @param triggerGroupName 觸發器羣組名；
	 * @throws SchedulerException 
	 */
	public void removeJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName) throws SchedulerException;

	/**
	 * 啓動所有定時任務；
	 * @throws SchedulerException 
	 */
	public void startAllJobs() throws SchedulerException;

	/**
	 * 關閉所有定時任務；
	 * @throws SchedulerException 
	 */
	public void shutdownAllJobs() throws SchedulerException;
	
	/**
	 * 暫停指定任務；
	 * 
	 * @param jobName 任務名；
	 * @param jobGroupName 任務的羣組名；
	 * @throws SchedulerException 
	 */
	public void pauseJob(String jobName, String jobGroupName) throws SchedulerException;
	
	/**
	 * 恢復指定任務；
	 * 
	 * @param jobName 任務名；
	 * @param jobGroupName 任務的羣組名；
	 * @throws SchedulerException 
	 */
	public void resumeJob(String jobName, String jobGroupName) throws SchedulerException;
}

2. 實現對任務進行動態管理的接口方法：

package com.shawearn.quartz.util;

import java.text.ParseException;

import javax.annotation.Resource;

import org.quartz.CronTrigger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.springframework.stereotype.Service;

@Service("quartzUtil")
public class QuartzUtilImpl implements QuartzUtil {

	@Resource
	SchedulerFactory schedulerFactory;
	
	@Override
	public void addJob(String jobName, String jobGroupName, String triggerName,
			String triggerGroupName, Class jobClass, String cronExpression) throws SchedulerException, ParseException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 獲取 Quartz 任務類實例 jobDetail；
		JobDetail jobDetail = new JobDetail(jobName, jobGroupName, jobClass);
		// 獲取 Quartz 觸發器實例 trigger；
		CronTrigger trigger = new CronTrigger(triggerName, triggerGroupName, cronExpression);
		// 調度任務；
		scheduler.scheduleJob(jobDetail, trigger);
		// 如果調度器未被關閉，則啓動調度器；
		if (!scheduler.isShutdown()) {
			scheduler.start();
		}
	}
	
	@Override
	public void modifyJobTime(String jobName, String jobGroupName,
			String triggerName, String triggerGroupName, String cronExpression) throws SchedulerException, ParseException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 從調度器中獲取指定羣組的指定名稱的觸發器實例；
		CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerName, triggerGroupName);
		// 對獲取的觸發器進行判空操作；
		if (trigger == null) {
			return;
		}
		String oldCronExpression = trigger.getCronExpression();
		// 如果新的執行時間與舊的執行時間相同，則返回，不繼續下一步的操作；
		if (oldCronExpression.equalsIgnoreCase(cronExpression)) {
			return;
		}
		// 獲取任務信息；
		JobDetail jobDetail = scheduler.getJobDetail(jobName, jobGroupName);
		// 獲取到任務類；
		Class jobClass = jobDetail.getJobClass();
		// 移除舊的任務；
		this.removeJob(jobName, jobGroupName, triggerName, triggerGroupName);
		// 添加新任務；
		this.addJob(jobName, jobGroupName, triggerName, triggerGroupName, jobClass, cronExpression);
	}
	
	@Override
	public void removeJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName) throws SchedulerException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 暫停定時器；
		scheduler.pauseTrigger(triggerName, triggerGroupName);
		// 取消任務調度；
		scheduler.unscheduleJob(jobName, jobGroupName);
		// 刪除任務；
		scheduler.deleteJob(jobName, jobGroupName);
	}
	
	@Override
	public void startAllJobs() throws SchedulerException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 如果調度器未被關閉，則啓動調度器；
		if (!scheduler.isShutdown()) {
			scheduler.start();
		}
	}
	
	@Override
	public void shutdownAllJobs() throws SchedulerException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 如果調度器未被關閉，關閉調度器；
		if (!scheduler.isShutdown()) {
			scheduler.shutdown();
		}
	}
	
	@Override
	public void pauseJob(String jobName, String jobGroupName) throws SchedulerException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 暫停調度器中的指定任務；
		scheduler.pauseJob(jobName, jobGroupName);
	}
	
	@Override
	public void resumeJob(String jobName, String jobGroupName) throws SchedulerException {
		// 獲得 Quartz 的調度器實例 scheduler；
		Scheduler scheduler = schedulerFactory.getScheduler();
		// 恢復調度器中的指定任務；
		scheduler.resumeJob(jobName, jobGroupName);
	}

}

3. 實現作業類，作業類需要實現 org.quartz.Job 類，處於篇幅考慮，此處只貼出 MyJob1 類的代碼，其他作業類與 MyJob1 類似；

package com.shawearn.quartz.util;

import java.util.Date;

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

/**
 * 作業類；
 * 
 * @author Shawearn
 * 
 */
public class MyJob1 implements Job {

	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
		// 在此處定義任務所要執行的操作，本例中爲在控制檯輸出一串字符串；
		System.out.println("MyJob1.execute() : " + new Date());
	}

}

4. JUnit 測試類

package com.shawearn.test;

import java.text.ParseException;
import org.junit.BeforeClass;
import org.junit.Test;
import org.quartz.SchedulerException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.shawearn.quartz.util.MyJob1;
import com.shawearn.quartz.util.MyJob2;
import com.shawearn.quartz.util.MyJob3;
import com.shawearn.quartz.util.QuartzUtil;

public class TestService {
	public static BeanFactory beanFactory = null;
	public static QuartzUtil quartzUtil = null;
	
	@BeforeClass
	public static void init() {
		beanFactory = new ClassPathXmlApplicationContext("applicationContext.xml");
		quartzUtil = (QuartzUtil) beanFactory.getBean("quartzUtil");
	}
	
	@Test
	public void test() {
		String jobName1 = "MyJob1";
		String jobName2 = "MyJob2";
		String jobName3 = "MyJob3";
		
		try {
			System.out.println("開啓定時任務 " + jobName1 + "，每秒執行一次！");
			quartzUtil.addJob(jobName1, "1", "1", "1", MyJob1.class, "0/1 * * * * ?");
			Thread.sleep(5000);
			
			System.out.println("修改定時任務 " + jobName1 + "，每兩秒執行一次！");
			quartzUtil.modifyJobTime(jobName1, "1", "1", "1", "0/2 * * * * ?");
			Thread.sleep(5000);
			
			System.out.println("開啓定時任務 MyJob2，每秒執行一次！");
			quartzUtil.addJob(jobName2, "1", "2", "1", MyJob2.class, "0/1 * * * * ?");
			Thread.sleep(5000);
			
			System.out.println("移除定時任務 " + jobName1);
			quartzUtil.removeJob(jobName1, "1", "1", "1");
			Thread.sleep(5000);
			
			System.out.println("開啓定時任務 MyJob3，每三秒執行一次！");
			quartzUtil.addJob(jobName3, "1", "3", "1", MyJob3.class, "0/3 * * * * ?");
			Thread.sleep(5000);
			
			
			Thread.sleep(1000000000);
			
		} catch (SchedulerException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ParseException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
}