Spring Schedule Task動態改寫Cron配置方式

Posted on 2021-11-01 by WalkonNet

Spring Schedule Task動態改寫Cron配置

使用Spring @Scheduled標簽可以很簡單地定義Scheduled Task，但是有時我們需要在程序裡動態地改寫Cron的配置。

什麼時候呢？

額，比如：

老板覺得Cron配置太難看瞭，想直接這樣：10：15

Scheduling Tasks的常規使用

兩個標簽： @EnableScheduling， @Scheduled

@SpringBootApplication
@EnableScheduling
public class SchedulingTasksApplication {
 public static void main(String[] args) {
  SpringApplication.run(SchedulingTasksApplication.class);
 }
}

public class ScheduleTaskSimpleJob {
    @Scheduled(cron = "0 15 10 * * ?")
    public void scheduleCronTask() {    
        long now = System.currentTimeMillis() / 1000;
        System.out.println(
        "schedule tasks using cron jobs - " + now);
    }
}

動態改寫Cron

Implements SchedulingConfigurer就可以，想怎麼改怎麼改。
public class ScheduleTaskSimpleJob implements SchedulingConfigurer {    
    public void scheduleCronTask() {    
        long now = System.currentTimeMillis() / 1000;
        System.out.println(
        "schedule tasks using cron jobs - " + now);
    }
    @Override
 public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
  taskRegistrar.addTriggerTask(new Runnable() {
   @Override
   public void run() {
    scheduleCronTask();
   }
  }, new Trigger() {
   @Override
   public Date nextExecutionTime(TriggerContext triggerContext) {
    //TODO 將時間配置10：15轉換為cron
    String cron = "0 15 10 * * ?";       
    CronTrigger trigger = new CronTrigger(cron);    
    Date nextExecDate = trigger.nextExecutionTime(triggerContext);
    return nextExecDate;
   }
  });  
 }
}

@Scheduled定時任務動態修改cron參數

Spring框架自3.0版本起，自帶瞭任務調度功能，好比是一個輕量級的Quartz，而且使用起來也方便、簡單，且不需要依賴其他的JAR包。秉承著Spring的一貫風格，Spring任務調度的實現同時支持註解配置和XML配置兩種方式。

再來談談變態的項目需求：我們正在做一個智能數字電表的數據采集項目，項目最終會在多個工業園上線，每個工業園對電表數據的采集周期可以進行自定義，例如A工業園想每10分鐘采集一次數據，B工業園想每15分鐘采集一次數據。因為數據采集是個重復的周期性工作，那麼就可以考慮使用Spring框架的定時任務功能瞭。

按正常來講，修改定時任務的執行周期還不簡單，把服務停下來，改下任務的cron參數，再重啟服務就搞定瞭。但有沒有一種可能，在不停服務的情況下，就可以動態的修改任務的cron參數呢？完全是有可能的！

先來看下Spring常規定時任務的配置

如下

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:task="http://www.springframework.org/schema/task"
 xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="
  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd 
  http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task.xsd 
  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd ">
 
 <context:component-scan base-package="com.pes_soft.task.demo" />
 
 <!-- Spring註解方式配置調度任務 -->
 <task:executor id="executor" pool-size="3"/>
 <task:scheduler id="scheduler" pool-size="3"/>
 <task:annotation-driven executor="executor" scheduler="scheduler"/>
</beans>

註意：配置Spring定時任務時，需要在Spring配置文件的xml頭部加入

xmlns:task=”http://www.springframework.org/schema/task”和xsi:schemaLocation位置中加入

http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task.xsd

然後是註解式任務邏輯代碼SpringStaticCronTask.java

package com.pes_soft.task.demo; 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
 
@Lazy(false)
@Component
public class SpringStaticCronTask {
 private static final Logger logger = LoggerFactory.getLogger(SpringStaticCronTask.class);
 
 @Scheduled(cron="0/5 * * * * ?")
 public void staticCronTask() {
  logger.debug("staticCronTask is running...");
        }
}

上述任務適用於具有固定任務周期的任務，若要修改任務執行周期，隻能走“停服務→修改任務執行周期→重啟服務”這條路。

下面來看看可以在不停服務的情況下動態修改任務周期的實現

步驟如下：

在定時任務類上增加@EnableScheduling註解，並實現SchedulingConfigurer接口。（值得註意的是：@EnableScheduling對Spring的版本要求比較高，一開始使用的3.2.6版本時一直未成功，後來改成4.2.5版本就可以瞭）

設置一個靜態變量cron，用於存放任務執行周期參數。

另辟一線程，用於模擬實際業務中外部原因修改瞭任務執行周期。

設置任務觸發器，觸發任務執行，其中就可以修改任務的執行周期。

完整的SpringDynamicCronTask.java代碼如下：

package com.pes_soft.task.demo; 
import java.util.Date; 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
 
@Lazy(false)
@Component
@EnableScheduling
public class SpringDynamicCronTask implements SchedulingConfigurer {
 private static final Logger logger = LoggerFactory.getLogger(SpringDynamicCronTask.class);
 private static String cron;
 public SpringDynamicCronTask() {
 cron = "0/5 * * * * ?";
  
  // 開啟新線程模擬外部更改瞭任務執行周期
  new Thread(new Runnable() {
   @Override
   public void run() {
    try {
     Thread.sleep(15 * 1000);
    } catch (InterruptedException e) {
     e.printStackTrace();
    }
    
    cron = "0/10 * * * * ?";
    System.err.println("cron change to: " + cron);
   }
  }).start();
 }
 
 @Override
 public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
  taskRegistrar.addTriggerTask(new Runnable() {
   @Override
   public void run() {
    // 任務邏輯
    logger.debug("dynamicCronTask is running...");
   }
  }, new Trigger() {
   @Override
   public Date nextExecutionTime(TriggerContext triggerContext) {
    // 任務觸發，可修改任務的執行周期
    CronTrigger trigger = new CronTrigger(cron);
                Date nextExec = trigger.nextExecutionTime(triggerContext);
                return nextExec;
   }
  });
 }
}

將demo運行起來，查看任務執行情況，可以觀察到任務的執行周期由5秒變成瞭10秒，期間服務並未停止。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

Spring Schedule Task動態改寫Cron配置方式

目錄