Quartz實現動態定時任務

awen7916發表於2015-12-24

一、 說明

     由於最近工作要實現定時任務的執行,而且要求定時週期是不固定的,所以就用到了quartz來實現這個功能;

     spring3.1以下的版本必須使用quartz1.x系列,3.1以上的版本才支援quartz 2.x,不然會出錯。至於原因,則是spring對於quartz的支援實 現,org.springframework.scheduling.quartz.CronTriggerBean繼承了 org.quartz.CronTrigger,在quartz1.x系列中org.quartz.CronTrigger是個類,而在 quartz2.x系列中org.quartz.CronTrigger變成了介面,從而造成無法用spring的方式配置quartz的觸發器 (trigger)。

     我使用的quartz版本是2.2.1 。

     最終實現的功能:

      1) 專案啟動時,可執行的定時任務啟動,按時執行相應的邏輯 ;

     2)  可新增新任務,刪除任務,更新任務,暫停任務,恢復任務 ;

二、 新增quartz包

    我使用Gradle構建專案,加包時只需下面一行即可:

   compile "org.quartz-scheduler:quartz:2.2.1"

三、 配置及使用

      1.  配置任務排程器 (對應的檔名為quartz-task.xml)  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 <?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.0.xsd"
 default-lazy-init="false">
 <!-- 排程器 -->
    <bean name="schedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"
       <!-- 通過applicationContextSchedulerContextKey屬性配置spring上下文 -->    
        <property name="applicationContextSchedulerContextKey">    
            <value>applicationContext</value>    
        </property>   
    </bean>  
    <!--載入可執行的任務-->
    <bean id="loadTask" class="com.quartz.LoadTask" init-method="initTask" />
 
</beans>

    2. 伺服器啟動時載入,在web.xml檔案裡配置

1
2
3
4
<context-param>
  <param-name>contextConfigLocation</param-name>
  <param-value>classpath:quartz-task.xml</param-value>
 </context-param>

   3. 載入可執行任務的類LoadTask.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 public class LoadTask {
 public void initTask() throws Exception {
  Scheduler scheduler = schedulerFactoryBean.getScheduler();
  // 可執行的任務列表
  Collection<Task> taskList = taskService.findTask();
  for (Task task : taskList) {
   // 任務名稱和任務組設定規則:
   // 名稱:task_1 ..
   // 組 :group_1 ..
   TriggerKey triggerKey = TriggerKey.triggerKey(
     "task_" + task.getId(), "group_" + task.getId());
   CronTrigger trigger = (CronTrigger) scheduler
     .getTrigger(triggerKey);
   // 不存在,建立一個
   if (null == trigger) {
    JobDetail jobDetail = JobBuilder
      .newJob(QuartzJobFactory.class)
      .withIdentity("task_" + task.getId(),
        "group_" + task.getId()).build();
    jobDetail.getJobDataMap().put("scheduleJob", task);
    // 表示式排程構建器
    CronScheduleBuilder scheduleBuilder = CronScheduleBuilder
      .cronSchedule(getCronExpression());
    // 按新的表示式構建一個新的trigger
    trigger = TriggerBuilder
      .newTrigger()
      .withIdentity("task_" + task.getId(),
        "group_" + task.getId())
      .withSchedule(scheduleBuilder).build();
    scheduler.scheduleJob(jobDetail, trigger);
   else {
    // trigger已存在,則更新相應的定時設定
    CronScheduleBuilder scheduleBuilder = CronScheduleBuilder
      .cronSchedule(taskService.getCronExpression());
    // 按新的cronExpression表示式重新構建trigger
    trigger = trigger.getTriggerBuilder().withIdentity(triggerKey)
      .withSchedule(scheduleBuilder).build();
    // 按新的trigger重新設定job執行
    scheduler.rescheduleJob(triggerKey, trigger);
   }
  }
 }
 @Autowired
 private SchedulerFactoryBean schedulerFactoryBean;
 @Autowired
 private  TaskService taskService;
}

   4. 排程任務的入口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 public class QuartzTaskFactory implements Job {
  
 @Override
 public void execute(JobExecutionContext context)
   throws JobExecutionException {
  // TODO Auto-generated method stub
  try {
   System.out.println("任務執行...");
   Task task = (Task) context.getMergedJobDataMap().get(
     "scheduleJob");
   System.out.println("任務名稱: [" + task.getTaskName() + "]");
   //在這裡執行你的任務...
   catch (Exception e) {
   e.printStackTrace();
  }
 }
}

   5. 暫停任務

1
2
3
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.pauseJob(jobKey);

   6. 恢復任務

1
2
3
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.resumeJob(jobKey);

  7. 刪除任務

1
2
3
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.deleteJob(jobKey);

   8. 立即執行任務

1
2
3
Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.triggerJob(jobKey);

   9. 更新任務(時間表示式)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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);

四、時間表示式說明

  

欄位 允許值 允許的特殊字元

秒 0-59 , – * /

分 0-59 , – * /

小時 0-23 , – * /

日期 1-31 , – * ? / L W C

月份 1-12 或者 JAN-DEC , – * /

星期 1-7 或者 SUN-SAT , – * ? / L C #

年(可選) 留空, 1970-2099 , – * /

表示式意義

"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期間的每1分鐘觸發

"0 0/5 14 * * ?" 在每天下午2點到下午2:55期間的每5分鐘觸發

"0 0/5 14,18 * * ?" 在每天下午2點到2:55期間和下午6點到6:55期間的每5分鐘觸發

"0 0-5 14 * * ?" 在每天下午2點到下午2:05期間的每1分鐘觸發

"0 10,44 14 ? 3 WED" 每年三月的星期三的下午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" 每月的第三個星期五上午10:15觸發

每天早上6點

0 6 * * *

每兩個小時

0 */2 * * *

晚上11點到早上8點之間每兩個小時,早上八點

0 23-7/2,8 * * *

每個月的4號和每個禮拜的禮拜一到禮拜三的早上11點

0 11 4 * 1-3

1月1日早上4點

0 4 1 1 *

ok,定時任務已經正確執行....

相關文章