spring 整合 quertz 並實現定時器頁面動態配置功能，支持腳本參數配置
阿新 • • 發佈：2019-03-18
nts implement cti () xtu ng- man con exists
背景
- Java定時任務的實現技術主流的有三種，Java自帶的Java.util.Time類、Quartz、Spring3.0以後自帶的task。下面我們使用的是Quartz。
- 項目中如果需要一個定時任務，我們首先需要開發一個job，然後在xml中配置，接著發布使用。考慮以下幾個問題：
- 如果發布後這個定時任務的時間需要改變一下怎麽辦
- 這個定時任務需要參數，但是現在參數發生了改變怎麽辦
- 一個邏輯可以啟動好幾個定時任務，只是參數和時間不一樣，那麽我們是不是要在xml中復用同一個job，配置多個定時任務呢。
- 根據以上問題，我們可以考慮實現定時器的時間和參數動態配置，保存在數據庫中，項目啟動時去數據庫加載數據，初始化定時任務。當參數發生改變，我們使用調度器改變任務參數。這樣我們就可以實現腳本的靈活復用、腳本時間動態配置和定時任務參數的動態配置
- 以下配置基於maven和spring mvc
步驟
1、在POM文件中加入依賴
<dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.2.1</version> </dependency>
2、配置quartz.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd"> <bean id="startQuertz" lazy-init="true"autowire="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> </bean> <bean id="quartzManager" class="com.hello.quartz.QuartzManager" lazy-init="false" init-method="startJobs" > <property name="scheduler" ref="startQuertz" /> </bean> </beans>
3、在applicationContext.xml 加入quartz的依賴
<import resource="quartz.xml" />
4、創建任務調度器QuartzManager
package com.cnc.ci.cs.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.Trigger; import org.quartz.TriggerBuilder; import org.quartz.TriggerKey; public class QuartzManager { private Scheduler scheduler; public Scheduler getScheduler() { return scheduler; } public void setScheduler(Scheduler scheduler) { this.scheduler = scheduler; } /** * 功能： 添加一個定時任務 * @param jobName 任務名,可以是JOB class文件的首字母小寫 * @param jobGroupName 任務組名 * @param triggerName 觸發器名，在job執行時JobExecutionContext參數中可以獲取到值,((CronTriggerImpl) ((JobExecutionContextImpl) jobExecutionContext).getTrigger()).getName() * @param triggerGroupName 觸發器組名 * @param jobClass 任務的類類型 TestJob.class * @param cron 時間設置 表達式 */ public void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Class jobClass, String cron, Object... objects) { try { //校驗觸發器是否已經存在，如果存在，不再創建。註意，每個觸發器的triggerName應該不一樣 if (scheduler.checkExists(TriggerKey.triggerKey(triggerName, triggerGroupName))) { return; } // 任務名，任務組，任務執行類 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 void modifyJobTime(String jobName, String jobGroupName, String triggerName, String triggerGroupName, String cron) { try { 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 void removeJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName) { try { 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 void startJobs() { try { scheduler.start(); } catch (Exception e) { throw new RuntimeException(e); } } /** * 功能：關閉所有定時任務 */ public void shutdownJobs() { try { if (!scheduler.isShutdown()) { scheduler.shutdown(); } } catch (Exception e) { throw new RuntimeException(e); } } }
5、初始化定時任務
通過ApplicationListener接口監聽ContextRefreshedEvent事件，當所有的bean都初始化完成並被成功裝載後會觸發該事件，實現ApplicationListener<ContextRefreshedEvent>接口可以收到監聽動作，並執行程序
package com.cnc.ci.cs.quartz; import com.cnc.ci.cs.timerjob.TestJob; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.ApplicationListener; import org.springframework.context.event.ContextRefreshedEvent; import org.springframework.stereotype.Component; import com.cnc.portal.spring.SpringContextHolder; @Component public class ModJobManager implements ApplicationListener<ContextRefreshedEvent> { private static final Logger LOGGER = LoggerFactory.getLogger(ModJobManager.class); public void init() { LOGGER.info("初始化job!"); //通過spring上下文獲取quartzManager，SpringContextHolder 類見下一個文件 QuartzManager quartzManager = (QuartzManager) SpringContextHolder.getBean("quartzManager"); quartzManager.addJob("testJob", "testJob", "testJob1", "testJob1", TestJob.class, "0 0/2 * * * ?"); } @Override public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) { init(); } }
package com.hello.util; import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.stereotype.Component; @Component public class SpringContextHolder implements ApplicationContextAware { // Spring應用上下文環境 public static ApplicationContext applicationContext; /** * 實現ApplicationContextAware接口的回調方法。設置上下文環境 * * @param applicationContext */ @Override public void setApplicationContext(ApplicationContext applicationContext) { SpringContextUtil.applicationContext = applicationContext; } /** * @return ApplicationContext */ public static ApplicationContext getApplicationContext() { return applicationContext; } /** * 獲取對象 * * @param name * @return Object * @throws BeansException */ public static Object getBean(String name) throws BeansException { return applicationContext.getBean(name); } }
6、測試JOB
package com.cnc.ci.cs.timerjob; import org.quartz.Job; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.quartz.impl.JobExecutionContextImpl; import org.quartz.impl.triggers.CronTriggerImpl; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; @Component public class TestJob implements Job { private static final Logger LOGGER = LoggerFactory.getLogger(EmailSendJob.class); @Override public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException { //獲取trigger名字，trigger 名字+group 是觸發器的唯一標識 LOGGER.info(((CronTriggerImpl) ((JobExecutionContextImpl) jobExecutionContext).getTrigger()).getName()); //獲取觸發器的時間 LOGGER.info(((CronTriggerImpl) ((JobExecutionContextImpl) jobExecutionContext).getTrigger()).getCronExpression()); //業務邏輯 } }
spring 整合 quertz 並實現定時器頁面動態配置功能，支持腳本參數配置