Quartz專題(三)-SprinBoot和Quart整合

Quartz是一款開源的定時任務調度框架，本文主要記錄一下在工作中使用springboot整合quartz實現定時任務調度管理的用例。內容主要有：springboot整合quartz相關配置、實現基於simpleTrigger的定時任務、實現基於cronTrigger的定時任務。
Quartz官網：http://www.quartz-scheduler.org/

1.導入依賴

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.quartz.springboot</groupId>
	<artifactId>quartz-springboot</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.2.RELEASE</version>
		<relativePath /> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
	
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-thymeleaf</artifactId>
		</dependency>
		
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

		<!--Quartz任務調度的包 -->
		<dependency>
			<groupId>org.quartz-scheduler</groupId>
			<artifactId>quartz</artifactId>
			<version>2.2.1</version>
		</dependency>
		<dependency>
			<groupId>org.quartz-scheduler</groupId>
			<artifactId>quartz-jobs</artifactId>
			<version>2.2.1</version>
		</dependency>

	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>

2.新建SpringBoot啓動類

package com.bruce;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

3.新建quartz的作業類

public class Job1 implements Job{

	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
		System.out.println("作業1:這裏就是寫業務邏輯的地方....");
	}

}

4.新建quartz的配置類

package com.bruce;

import java.util.Date;

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.SchedulerException;
import org.quartz.TriggerBuilder;
import org.quartz.TriggerKey;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;

import com.bruce.job.Job1;

@Configuration
public class QuartzScheduler {

	@Autowired
	private Scheduler scheduler;

	/**
	 * 要啓動的任務1
	 * 
	 * @param scheduler
	 * @throws SchedulerException
	 */
	private void startJob1(Scheduler scheduler) throws SchedulerException {
		// 通過JobBuilder構建JobDetail實例，JobDetail規定只能是實現Job接口的實例
		// JobDetail 是具體Job實例
		// 開發的時候你要改變的地方 也只有下面的class ---> Job1.class
		JobDetail jobDetail = JobBuilder.newJob(Job1.class).withIdentity("job1", "group1").build();
		// 基於表達式構建觸發器
		// 下面的表達式很重要
		CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
		// CronTrigger表達式觸發器 繼承於Trigger
		// TriggerBuilder 用於構建觸發器實例
		CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("job1", "group1").withSchedule(cronScheduleBuilder).build();
		scheduler.scheduleJob(jobDetail, cronTrigger);
	}

	/**
	 * 01-開始執行所有任務
	 * 
	 * @throws SchedulerException
	 */
	public void startJob() throws SchedulerException {
		startJob1(scheduler);
		scheduler.start();
	}

	/**
	 * 02-獲取Job信息
	 */
	public String getJobInfo(String name, String group) throws SchedulerException {
		TriggerKey triggerKey = new TriggerKey(name, group);
		CronTrigger cronTrigger = (CronTrigger) scheduler.getTrigger(triggerKey);
		return String.format("time:%s,state:%s", cronTrigger.getCronExpression(), scheduler.getTriggerState(triggerKey).name());
	}

	/**
	 * 03-暫停某個任務
	 */
	public void pauseJob(String name, String group) throws SchedulerException {
		JobKey jobKey = new JobKey(name, group);
		JobDetail jobDetail = scheduler.getJobDetail(jobKey);
		if (jobDetail == null)
			return;
		scheduler.pauseJob(jobKey);
	}

	/**
	 * 04-恢復所有任務
	 * 
	 * @throws SchedulerException
	 */
	public void resumeAllJob() throws SchedulerException {
		scheduler.resumeAll();
	}

	/**
	 * 05-修改某個任務的執行時間
	 */
	public boolean modifyJob(String name, String group, String time) throws SchedulerException {
		Date date = null;
		TriggerKey triggerKey = new TriggerKey(name, group);
		CronTrigger cronTrigger = (CronTrigger) scheduler.getTrigger(triggerKey);
		String oldTime = cronTrigger.getCronExpression();
		if (!oldTime.equalsIgnoreCase(time)) {
			CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(time);
			CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(name, group).withSchedule(cronScheduleBuilder).build();
			date = scheduler.rescheduleJob(triggerKey, trigger);
		}
		return date != null;
	}

	/**
	 * 06-刪除某個任務
	 */
	public void deleteJob(String name, String group) throws SchedulerException {
		JobKey jobKey = new JobKey(name, group);
		JobDetail jobDetail = scheduler.getJobDetail(jobKey);
		if (jobDetail == null)
			return;
		scheduler.deleteJob(jobKey);
	}

	/**
	 * 07-暫停所有任務
	 * @throws SchedulerException
	 */
	public void pauseAllJob() throws SchedulerException {
		scheduler.pauseAll();
	}
}

5.新建quartz的監聽器類

package com.bruce;

import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.impl.StdSchedulerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.ContextRefreshedEvent;

@Configuration
public class ApplicationStartQuartzJobListener implements ApplicationListener<ContextRefreshedEvent> {

    @Autowired
    private QuartzScheduler quartzScheduler;

    /**
     * 初始啓動quartz
     */
    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        try {
            quartzScheduler.startJob();
            System.out.println("任務已經啓動...");
        } catch (SchedulerException e) {
            e.printStackTrace();
        }
    }

    /**
     * 初始注入scheduler
     * @return
     * @throws SchedulerException
     */
    @Bean
    public Scheduler scheduler() throws SchedulerException{
        SchedulerFactory schedulerFactoryBean = new StdSchedulerFactory();
        return schedulerFactoryBean.getScheduler(); 
    }
}

6.控制器類

package com.bruce.controller;

import org.quartz.SchedulerException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.bruce.QuartzScheduler;

@RestController
@RequestMapping("/quartz")
public class QuartzApiController {

	@Autowired
	private QuartzScheduler quartzScheduler;

	@RequestMapping("/start")
	public void startQuartzJob() {
		try {
			quartzScheduler.startJob();
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
	}

	@RequestMapping("/info")
	public String getQuartzJob(String name, String group) {
		String info = null;
		try {
			info = quartzScheduler.getJobInfo(name, group);
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
		return info;
	}

	@RequestMapping("/modify")
	public boolean modifyQuartzJob(String name, String group, String time) {
		boolean flag = true;
		try {
			flag = quartzScheduler.modifyJob(name, group, time);
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
		return flag;
	}

	@RequestMapping(value = "/pause")
	public void pauseQuartzJob(String name, String group) {
		try {
			quartzScheduler.pauseJob(name, group);
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
	}

	@RequestMapping(value = "/pauseAll")
	public void pauseAllQuartzJob() {
		try {
			quartzScheduler.pauseAllJob();
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
	}

	@RequestMapping(value = "/delete")
	public void deleteJob(String name, String group) {
		try {
			quartzScheduler.deleteJob(name, group);
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
	}

	@RequestMapping(value = "/resumeAllJob")
	public void resumeAllJob() {
		try {
			quartzScheduler.resumeAllJob();
		} catch (SchedulerException e) {
			e.printStackTrace();
		}
	}
}