SpringBoot集成Quartz动态定时任务

电玩女神 2023-10-06 17:33 12阅读 0赞

### 1、pom.xml ###

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-quartz</artifactId>
    		</dependency>

### 2、调度任务类 ###

package com.xx.xx.job;
    
    import java.util.Map;
    
    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;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.scheduling.quartz.SchedulerFactoryBean;
    import org.springframework.stereotype.Component;
    
    @Component
    public class CronScheduleJob {
    
    	@Autowired
    	private SchedulerFactoryBean schedulerFactoryBean;
    
    	/**
    	 * 添加一个定时任务
    	 *
    	 * @param jobName          任务名
    	 * @param jobGroupName     任务组名
    	 * @param triggerName      触发器名
    	 * @param triggerGroupName 触发器组名
    	 * @param cron             时间设置，参考quartz说明文档
    	 * @param params           任务参数
    	 */
    	public void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, String cron, Map<String, Object> params) throws Exception {
    		// 任务名，任务组，任务执行类
    		JobDetail job = JobBuilder.newJob(ScheduledJob.class).withIdentity(jobName, jobGroupName).build();
    		// 触发器,触发器名,触发器组
    		TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger().withIdentity(triggerName, triggerGroupName);
    		// 触发器时间设定
    		CronTrigger trigger = triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron)).build();
    		// 任务参数
    		job.getJobDataMap().putAll(params);
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		// 调度容器设置Job和Trigger
    		scheduler.scheduleJob(job, trigger);
    	}
    
    
    	/**
    	 * 执行一次
    	 *
    	 * @param jobName          任务名
    	 * @param jobGroupName     任务组名
    	 * @param triggerName      触发器名
    	 * @param triggerGroupName 触发器组名
    	 * @param params           任务参数
    	 */
    	public void onceJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Map<String, Object> params) throws Exception {
    		// 任务名，任务组，任务执行类
    		JobDetail job = JobBuilder.newJob(ScheduledJob.class).withIdentity(jobName, jobGroupName).build();
    		// 触发器,触发器名,触发器组
    		TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger().withIdentity(triggerName, triggerGroupName);
    		// 触发器间隔时间和重复时间设定,10这个参数代表指定一个以秒为单位的重复间隔,0这个参数代表指定触发器将重复的次数,总执行次数=重复次数+1
    		SimpleTrigger trigger = triggerBuilder.startNow().withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(10).withRepeatCount(0)).build();
    		//还可以指定开始执行时间，还可以指定间隔时间，比如cron表达式不能写出每隔50秒执行一次，可以用这种方式。
    		//Date date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").parse("2021-05-06 17:10:00");
    		//SimpleTrigger trigger = triggerBuilder.startAt(date).withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(10).withRepeatCount(2)).build();
    		// 任务参数
    		job.getJobDataMap().putAll(params);
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		// 调度容器设置Job和Trigger
    		scheduler.scheduleJob(job, trigger);
    	}
    
    
    	/**
    	 * 修改一个任务的触发时间
    	 *
    	 * @param triggerName      触发器名
    	 * @param triggerGroupName 触发器组名
    	 * @param cron             时间设置，参考quartz说明文档
    	 */
    	public void updateJob(String triggerName, String triggerGroupName, String cron) throws Exception {
    		TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
    		if (trigger == null) {
    			return;
    		}
    		String oldCron = trigger.getCronExpression();
    		if (!oldCron.equalsIgnoreCase(cron)) {
    			// 触发器,触发器名,触发器组
    			TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger().withIdentity(triggerName, triggerGroupName);
    			// 触发器时间设定
    			trigger = triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron)).build();
    			// 修改一个任务的触发时间
    			scheduler.rescheduleJob(triggerKey, trigger);
    		}
    	}
    
    	/**
    	 * 移除一个任务
    	 * 
    	 * @param jobName          任务名
    	 * @param jobGroupName     任务组名
    	 * @param triggerName      触发器名
    	 * @param triggerGroupName 触发器组名
    	 */
    	public void deleteJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName) throws Exception {
    		TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		// 停止触发器
    		scheduler.pauseTrigger(triggerKey);
    		// 移除触发器
    		scheduler.unscheduleJob(triggerKey);
    		// 删除任务
    		scheduler.deleteJob(JobKey.jobKey(jobName, jobGroupName));
    	}
    
    	/**
    	 * 暂停job
    	 *
    	 * @param jobName      任务名称
    	 * @param jobGroupName 任务所在组名称
    	 */
    	public void pauseJob(String jobName, String jobGroupName) throws Exception {
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		scheduler.pauseJob(JobKey.jobKey(jobName, jobGroupName));
    	}
    
    	/**
    	 * 恢复job
    	 *
    	 * @param jobName      任务名称
    	 * @param jobGroupName 任务所在组名称
    	 */
    	public void resumeJob(String jobName, String jobGroupName) throws Exception {
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		scheduler.resumeJob(JobKey.jobKey(jobName, jobGroupName));
    	}
    
    	/**
    	 * 启动所有定时任务
    	 *
    	 */
    	public void startAllJobs() throws Exception {
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		scheduler.start();
    	}
    
    	/**
    	 * 关闭所有定时任务
    	 */
    	public void shutdownAllJobs() throws Exception {
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		if (!scheduler.isShutdown()) {
    			scheduler.shutdown();
    		}
    	}
    
    	/*
    	 * 获取任务是否存在
    	 * STATE_BLOCKED 4 阻塞 
    	 * STATE_COMPLETE 2 完成 
    	 * STATE_ERROR 3 错误 
    	 * STATE_NONE -1 不存在 
    	 * STATE_NORMAL 0 正常 
    	 * STATE_PAUSED 1 暂停
    	 *
    	 */
    	public Boolean isExists(String triggerName, String triggerGroupName) throws Exception {
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		return scheduler.getTriggerState(TriggerKey.triggerKey(triggerName, triggerGroupName)) == Trigger.TriggerState.NONE;
    	}
    
    
    	@PostConstruct // 构造函数之后执行
    	public void init() {
    		System.out.println("启动以前的定时任务");
    		//Spring容器加载之后，启动以前的定时任务
    		Scheduler scheduler = schedulerFactoryBean.getScheduler();
    		System.out.println(scheduler);
    	}
    
    }

### 3、任务实现类 ###

package com.xx.xx.job;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    
    import org.quartz.Job;
    import org.quartz.JobDataMap;
    import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    
    public class ScheduledJob implements Job {
    
    	@Override
    	public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
    		SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    		// 传入的参数
    		JobDataMap mergedJobDataMap = jobExecutionContext.getMergedJobDataMap();
    		int id = mergedJobDataMap.getInt("id");
    		System.out.println(id + "  ---->  " + dateFormat.format(new Date()));
    	}
    }

### 4、请求 ###

package com.xx.xx.controller;
    
    import java.util.HashMap;
    import java.util.Map;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.ustcinfo.robot.job.CronScheduleJob;
    
    @RestController
    public class TestController {
    	private final Logger log = LoggerFactory.getLogger(TestController.class);
    
    	@Autowired
    	public CronScheduleJob scheduleJobs;
    
    	// http://localhost:8080/add?id=1
    	@GetMapping("/add")
    	public void add(HttpServletRequest request, HttpServletResponse response, String id) {
    		log.info(">>>>>>>>>>>>>>>新增<<<<<<<<<<<<<");
    		try {
    			String jobName = "job" + id;
    			String jobGroupName = "group";
    			String triggerName = "trigger" + id;
    			String triggerGroupName = "group";
    			String cron = "0/2 * * * * ?";
    			Map<String, Object> params = new HashMap<>();
    			params.put("id", id);
    			scheduleJobs.addJob(jobName, jobGroupName, triggerName, triggerGroupName, cron, params);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    
    	}
    
    	// http://localhost:8080/update?id=1
    	@GetMapping("/update")
    	public void update(HttpServletRequest request, HttpServletResponse response, String id) {
    		log.info(">>>>>>>>>>>>>>>修改<<<<<<<<<<<<<");
    		try {
    			String triggerName = "trigger" + id;
    			String triggerGroupName = "group";
    			String cron = "0/3 * * * * ?";
    			scheduleJobs.updateJob(triggerName, triggerGroupName, cron);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}
    
    	// http://localhost:8080/delete?id=1
    	@GetMapping("/delete")
    	public void delete(HttpServletRequest request, HttpServletResponse response, String id) {
    		log.info(">>>>>>>>>>>>>>>删除<<<<<<<<<<<<<");
    		try {
    			String jobName = "job" + id;
    			String jobGroupName = "group";
    			String triggerName = "trigger" + id;
    			String triggerGroupName = "group";
    			scheduleJobs.deleteJob(jobName, jobGroupName, triggerName, triggerGroupName);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}
    
    	// http://localhost:8080/pause?id=1
    	@GetMapping("/pause")
    	public void pause(HttpServletRequest request, HttpServletResponse response, String id) {
    		log.info(">>>>>>>>>>>>>>>暂停<<<<<<<<<<<<<");
    		try {
    			String jobName = "job" + id;
    			String jobGroupName = "group";
    			scheduleJobs.pauseJob(jobName, jobGroupName);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}
    
    	// http://localhost:8080/resume?id=1
    	@GetMapping("/resume")
    	public void resume(HttpServletRequest request, HttpServletResponse response, String id) {
    		log.info(">>>>>>>>>>>>>>>恢复<<<<<<<<<<<<<");
    		try {
    			String jobName = "job" + id;
    			String jobGroupName = "group";
    			scheduleJobs.resumeJob(jobName, jobGroupName);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}
    
    }