SpringBoot+Quartz學習實現定時任務控制Trigger的增加、啟用、刪除、休眠
SpringBoot+Quartz學習實現定時任務控制Trigger的增加、啟用、刪除、休眠
標籤(空格分隔): SpringBoot Quartz
文章目錄
SpringTask
SpringBoot主類加入
@EnableScheduling
註解,啟用定時任務的配置
固定等待時間@Scheduled(fixedDelay = 時間間隔)
固定間隔時間@Scheduled(fixedRate = 時間間隔)
第一次執行延遲時間,配合上面兩個使用@Scheduled(initialDelay = 1000 * 10,fixedDelay = 1000 * 2) Cron表示式
@Scheduled(cron = cron表示式)`
Cron表示式
s m h d M W Y(年可選)
| 欄位 | 值 | 允許符號 |
|:
| 秒(s)| 0-59 | ,-*/
| 分(m)| 0-59 | ,-*/
| 時(h)| 0-23 | ,-*/
| 日(d)| 1-31 | ,-*/?LW
| 月(M)| 1-12或JAN-DEC | ,-*/
| 星期(W)| 1-7或SUN-SAT | ,-*/?L#
| 年(Y)| 1970-2099 | ,-*/
|符號 | 含義 |
|:
| * | 表示任意值 |
| ? | 只能用於d和W兩個域,未說明的值 |
| - | 表示範圍 |
| / | 表示頻度 |
| , | 表示列出列舉值 |
| L | 表示最後,用於M和W
| W | 用於M,表示工作日,並在最近的工作日觸發
| LW | 表示某月最後一個工作日
| # | 用於W域,確定這個月第幾個周幾
例子:
*/5 * * * * ? 每隔5秒執行一次
0 0 5-15 * * ? 每天5-15點整點觸發
0 0/5 14,18 * * ? 在每天下午2點到2:55期間和下午6點到6:55期間的每5分鐘觸發
0 0 23 L * ? 每月最後一天23點執行一次
0 15 10 ? * 6L 每月的最後一個星期五上午10:15觸發
0 15 10 LW * ?" 每個月最後一個工作日的10點15分0秒觸發任務
0 15 10 ? * 5#3" 每個月第三週的星期四的10點15分0秒觸發任務
Spring Quartz實現定時任務
- pom.xml新增依賴
<!-- quartz -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
- 配置yml
spring:
# Quartz
quartz:
properties:
org:
quartz:
scheduler:
instanceName: myScheduler
instanceId: AUTO
jobStore:
isClustered: false
threadPool:
class: org.quartz.simpl.SimpleThreadPool
threadCount: 10
threadPriority: 5
threadsInheritContextClassLoaderOfInitializingThread: true
#job-store方式
job-store-type: jdbc
# datasource
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/etmptest?useUnicode=true&characterEncoding=utf8&autoReconnect=true&failOverReadOnly=false&useSSL=false
username: root
password: ${dev-db-passwd}
druid:
connection-properties: config.decrypt=true;config.decrypt.key=${dev-db-passwd-publickey}
- 編寫Job類
@DisallowConcurrentExecution
public class DefaultJob extends QuartzJobBean {
private static final Logger logger = LoggerFactory.getLogger(DefaultJob.class);
@Override
protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
Trigger trigger = context.getTrigger();
String triggerName = trigger.getKey().getName();
logger.info("開始定時任務:{},開始時間{}", triggerName, new Date());
//Todo trigger要做什麼任務
logger.info("結束定時任務:{},結束時間{}", triggerName, new Date());
}
}
- 編寫Quartz工具類
@Component
@Transactional(rollbackFor = Exception.class)
public class QuartzManager {
private static final Logger logger = LoggerFactory.getLogger(QuartzManager.class);
/**
* 注入任務排程器
*/
@Autowired
private Scheduler scheduler;
//注入DefaultJob類
@Bean
public JobDetail jobDetail() {
return JobBuilder.newJob(DefaultJob.class).withIdentity("defaultJob").storeDurably().build();
}
/**
* 新增SimpleTrigger
*/
public void addSimppleTrigger(String triggerName,Date startDate, Long repeatInterval, Long repeatCount){
try {
// 觸發器
TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
// 觸發器名,觸發器組
triggerBuilder.withIdentity(triggerName, Scheduler.DEFAULT_GROUP);
//triggerBuilder.startNow();
// 觸發器時間設定
triggerBuilder.withSchedule(simpleSchedule()
.withIntervalInSeconds(repeatInterval.intValue())
.withRepeatCount(repeatCount.intValue()))
.startAt(startDate);
triggerBuilder.forJob(jobDetail());
// 建立Trigger物件
SimpleTrigger trigger = (SimpleTrigger) triggerBuilder.build();
scheduler.addJob(jobDetail(), true);
// 排程容器設定JobDetail和Trigger
scheduler.scheduleJob(trigger);
}catch (Exception e) {
logger.error("新增Simple定時器失敗!", e);
throw new OccurLocationAwareException("新增Simple定時器失敗!",e);
}
logger.info("新增Simple定時器成功!");
}
/**
* 新增CronTrigger
*/
public void addCronTrigger(String triggerName, String cron) {
try {
// 觸發器
TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
// 觸發器名,觸發器組
triggerBuilder.withIdentity(triggerName, Scheduler.DEFAULT_GROUP);
triggerBuilder.startNow();
// 觸發器時間設定
triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
triggerBuilder.forJob(jobDetail());
// 建立Trigger物件
CronTrigger trigger = (CronTrigger) triggerBuilder.build();
scheduler.addJob(jobDetail(), true);
// 排程容器設定JobDetail和Trigger
scheduler.scheduleJob(trigger);
} catch (Exception e) {
logger.error("新增cron定時器失敗!", e);
throw new OccurLocationAwareException("新增cron定時器失敗!",e);
}
logger.info("新增cron定時器成功!");
}
/**
* 暫停Trigger
*/
public void pauseTrigger(String triggerName) {
try {
logger.info("休眠定時器:" + triggerName);
TriggerKey triggerKey = new TriggerKey(triggerName, Scheduler.DEFAULT_GROUP);
//停止觸發器
scheduler.pauseTrigger(triggerKey);
} catch (Exception e) {
logger.info("休眠定時器失敗!");
throw new OccurLocationAwareException("休眠定時器失敗!",e);
}
logger.info("休眠定時器成功!");
}
/**
* 恢復Trigger
*
* @param triggerName
* @throws Exception
*/
public void resumeTrigger(String triggerName) {
try {
logger.info("啟用定時器:" + triggerName);
TriggerKey triggerKey = new TriggerKey(triggerName, Scheduler.DEFAULT_GROUP);
//重啟觸發器
scheduler.resumeTrigger(triggerKey);
} catch (Exception e) {
logger.info("啟用定時器失敗!");
throw new OccurLocationAwareException("啟用定時器失敗!",e);
}
logger.info("啟用定時器成功!");
}
/**
* 刪除Trigger
*/
public boolean removeTrigger(String triggerName) {
try {
logger.info("移除定時器:" + triggerName);
TriggerKey triggerKey = new TriggerKey(triggerName, Scheduler.DEFAULT_GROUP);
//停止觸發器
scheduler.pauseTrigger(triggerKey);
//移除觸發器
return scheduler.unscheduleJob(triggerKey);
} catch (Exception e) {
logger.error("移除定時器失敗!", e);
throw new OccurLocationAwareException("移除定時器失敗!",e);
}
}
}
- Controller呼叫
@RestController
@RequestMapping("/trigger")
public class TriggerController {
@Autowired
private QuartzManager manager;
/**
* @desc 新增SimpleTrigger
*/
@PostMapping("/addSimple")
public ResultBody addSimpleTrigger(@Valid @RequestBody TriggerParam triggerParam) {
manager.addSimppleTrigger(triggerParam.getTriggerName(),triggerParam.getStartDate(),triggerParam.getRepeatInterval(), triggerParam.getRepeatCount());
return new ResultBody<String>();
}
/**
* @desc 新增CronTrigger
*/
@PostMapping("/addCron")
public ResultBody addCronTrigger(@Valid @RequestBody TriggerParam triggerParam {
manager.addCronTrigger(triggerParam.getTriggerName(), triggerParam.getCronExpression());
return new ResultBody<String>();
}
/**
* @desc 啟用Trigger
*/
@PostMapping("/resume")
public ResultBody resume(@Valid @RequestBody TriggerParam triggerParam) {
String triggerName = triggerParam.getTriggerName();
manager.resumeTrigger(triggerName);
return new ResultBody<String>();
}
/**
* @desc 暫停Trigger
*/
@PostMapping("/pause")
public ResultBody pause(@Valid @RequestBody TriggerParam triggerParam) {
String triggerName = triggerParam.getTriggerName();
manager.pauseTrigger(triggerName);
return new ResultBody<String>();
}
/**
* @desc 刪除Trigger
*/
@PostMapping("/delete")
public ResultBody delete(@Valid @RequestBody TriggerParam triggerParam) {
String triggerName = triggerParam.getTriggerName();
manager.removeTrigger(triggerName);
return new ResultBody<String>();
}
}
如何用Quartz呼叫Trigger先這樣,後面有時間再整理從前端到後端如何實現自定義Job和Trigger的控制