Quartz的集成

╰半夏微凉° 2023-07-21 09:00 30阅读 0赞

1.创建springBoot项目

2.引入Quartz相关依赖

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>4.3.18.RELEASE</version>
    </dependency>
    
    <dependency>
        <groupId>org.quartz-scheduler</groupId>
        <artifactId>quartz</artifactId>
        <version>2.2.3</version>
    </dependency>
    <dependency>
        <groupId>org.quartz-scheduler</groupId>
        <artifactId>quartz-jobs</artifactId>
        <version>2.2.3</version>
    </dependency>

3 在resources目录创建quartz.properties文件

org.quartz.scheduler.instanceName = MyScheduler
    org.quartz.scheduler.instanceId = AUTO
    org.quartz.scheduler.rmi.export = false
    org.quartz.scheduler.rmi.proxy = false
    org.quartz.scheduler.wrapJobExecutionInUserTransaction = false
    
    #线程池配置
    org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
    org.quartz.threadPool.threadCount = 10
    org.quartz.threadPool.threadPriority = 5
    org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true
    
    ##持久化配置
    #org.quartz.jobStore.misfireThreshold = 50000
    #org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
    ##支持集群
    #org.quartz.jobStore.isClustered = true
    #org.quartz.jobStore.useProperties:true
    #org.quartz.jobStore.clusterCheckinInterval = 15000
    ##使用weblogic连接Oracle驱动
    #org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.oracle.weblogic.WebLogicOracleDelegate
    ##org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate
    #org.quartz.jobStore.tablePrefix = QRTZ_
    #org.quartz.jobStore.dataSource = qzDS
    ##数据源连接信息，quartz默认使用c3p0数据源可以被自定义数据源覆盖
    #org.quartz.dataSource.qzDS.driver = oracle.jdbc.driver.OracleDriver
    #org.quartz.dataSource.qzDS.URL = jdbc:oracle:thin:@localhost:1521/XE
    #org.quartz.dataSource.qzDS.user = root
    #org.quartz.dataSource.qzDS.password = 123456
    #org.quartz.dataSource.qzDS.maxConnections = 10

4.QuartzConfiguration

package com.example.demo;
    
    import org.quartz.Scheduler;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.config.PropertiesFactoryBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.io.ClassPathResource;
    import org.springframework.scheduling.quartz.SchedulerFactoryBean;
    
    import java.io.IOException;
    
    /**
     * Author : 尤毅鹤
     * Date: 2020/04/02 11:01
     * Description: <描述>
     */
    @Configuration
    public class QuartzConfiguration {
        @Autowired
        private TaskJobFactory jobFactory;
    
        @Bean(name = "SchedulerFactory")
        public SchedulerFactoryBean schedulerFactoryBean() throws IOException {
            //获取配置属性
            PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();
            propertiesFactoryBean.setLocation(new ClassPathResource("/quartz.properties"));
            //在quartz.properties中的属性被读取并注入后再初始化对象
            propertiesFactoryBean.afterPropertiesSet();
            //创建SchedulerFactoryBean
            SchedulerFactoryBean factory = new SchedulerFactoryBean();
            factory.setQuartzProperties(propertiesFactoryBean.getObject());
            factory.setJobFactory(jobFactory);
            return factory;
        }
    
        /*
         * 通过SchedulerFactoryBean获取Scheduler的实例
         */
        @Bean(name = "scheduler")
        public Scheduler scheduler() throws IOException {
            return schedulerFactoryBean().getScheduler();
        }
    }

5.TaskJobFactory

package com.example.demo;
    
    import org.quartz.spi.TriggerFiredBundle;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
    import org.springframework.scheduling.quartz.AdaptableJobFactory;
    import org.springframework.stereotype.Component;
    
    /**
     * Author : 尤毅鹤
     * Date: 2020/04/02 10:54
     * Description: <描述>
     */
    @Component
    public class TaskJobFactory  extends AdaptableJobFactory {
        @Autowired
        private AutowireCapableBeanFactory capableBeanFactory;
    
        @Override
        protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
            //调用父类的方法
            Object jobInstance = super.createJobInstance(bundle);
            //进行注入
            capableBeanFactory.autowireBean(jobInstance);
            return jobInstance;
        }
    }

6.BaseTaskJob

package com.example.demo;
    
    import org.quartz.Job;
    import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    
    /**
     * Author : 尤毅鹤
     * Date: 2020/04/02 11:00
     * Description: <描述>
     */
    public interface BaseTaskJob extends Job {
        @Override
        void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException;
    }

7.TestQuartz

package com.example.demo;
    
    /**
     * Author : 尤毅鹤
     * Date: 2020/04/02 11:00
     * Description: <描述>
     */
    import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    @Component
    public class TestQuartz implements BaseTaskJob {
    
        Logger logger = LoggerFactory.getLogger(this.getClass());
    
        public  int i = 0;
    
        @Override
        public void execute(JobExecutionContext context) throws JobExecutionException {
            i++;
            logger.error("task2>>>>>>>  " + i);
    
            try {
    //            QuartzJobManager.getInstance().jobdelete(this.getClass().getSimpleName(),"ah");//执行完此任务就删除自己
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

8.QuartzJobManager

package com.example.demo;
    
    import org.quartz.*;
    import org.quartz.impl.matchers.GroupMatcher;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    import java.util.*;
    
    /**
     * Author : 尤毅鹤
     * Date: 2020/04/02 10:59
     * Description: <描述>
     */
    @Component
    public class QuartzJobManager {
        private static final Logger logger = LoggerFactory.getLogger(QuartzJobManager.class);
    
        private static QuartzJobManager jobUtil;
    
        @Autowired
        private Scheduler scheduler;
    
        public QuartzJobManager() {
            logger.info("init jobUtil");
            jobUtil = this;
        }
    
        public static QuartzJobManager getInstance() {
            logger.info("retun  JobCreateUtil");
            return QuartzJobManager.jobUtil;
        }
    
        /**
         * 创建job
         *
         * @param clazz          任务类
         * @param jobName        任务名称
         * @param jobGroupName   任务所在组名称
         * @param cronExpression cron表达式
         * @throws Exception
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void addJob(Class clazz, String jobName, String jobGroupName, String cronExpression) throws Exception {
    
            // 启动调度器
            scheduler.start();
    
            //构建job信息
            JobDetail jobDetail = JobBuilder.newJob(((BaseTaskJob) clazz.newInstance()).getClass()).withIdentity(jobName, jobGroupName).build();
    
            //表达式调度构建器(即任务执行的时间)
            CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
    
            //按新的cronExpression表达式构建一个新的trigger
            CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(jobName, jobGroupName)
                    .withSchedule(scheduleBuilder).build();
            scheduler.scheduleJob(jobDetail, trigger);
        }
    
    
        /**
         * 创建job，可传参
         *
         * @param clazz          任务类
         * @param jobName        任务名称
         * @param jobGroupName   任务所在组名称
         * @param cronExpression cron表达式
         * @param argMap         map形式参数
         * @throws Exception
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void addJob(Class clazz, String jobName, String jobGroupName, String cronExpression, Map<String, Object> argMap) throws Exception {
    
            // 启动调度器
            scheduler.start();
    
            //构建job信息
            JobDetail jobDetail = JobBuilder.newJob(((BaseTaskJob) clazz.newInstance()).getClass()).withIdentity(jobName, jobGroupName).build();
    
            //表达式调度构建器(即任务执行的时间)
            CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
    
            //按新的cronExpression表达式构建一个新的trigger
            CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(jobName, jobGroupName)
                    .withSchedule(scheduleBuilder).build();
    
            //获得JobDataMap，写入数据
            trigger.getJobDataMap().putAll(argMap);
    
            scheduler.scheduleJob(jobDetail, trigger);
        }
    
        /**
         * 暂停job
         *
         * @param jobName      任务名称
         * @param jobGroupName 任务所在组名称
         * @throws SchedulerException
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void pauseJob(String jobName, String jobGroupName) throws SchedulerException {
            scheduler.pauseJob(JobKey.jobKey(jobName, jobGroupName));
        }
    
        /**
         * 恢复job
         *
         * @param jobName      任务名称
         * @param jobGroupName 任务所在组名称
         * @throws SchedulerException
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void resumeJob(String jobName, String jobGroupName) throws SchedulerException {
    
            scheduler.resumeJob(JobKey.jobKey(jobName, jobGroupName));
        }
    
    
        /**
         * job 更新,只更新频率
         *
         * @param jobName        任务名称
         * @param jobGroupName   任务所在组名称
         * @param cronExpression cron表达式
         * @throws Exception
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void updateJob(String jobName, String jobGroupName, String cronExpression) throws Exception {
            TriggerKey triggerKey = TriggerKey.triggerKey(jobName, jobGroupName);
            // 表达式调度构建器
            CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
    
            CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
    
            // 按新的cronExpression表达式重新构建trigger
            trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();
    
            // 按新的trigger重新设置job执行
            scheduler.rescheduleJob(triggerKey, trigger);
    
        }
    
    
        /**
         * job 更新,更新频率和参数
         *
         * @param jobName        任务名称
         * @param jobGroupName   任务所在组名称
         * @param cronExpression cron表达式
         * @param argMap         参数
         * @throws Exception
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void updateJob(String jobName, String jobGroupName, String cronExpression, Map<String, Object> argMap) throws Exception {
            TriggerKey triggerKey = TriggerKey.triggerKey(jobName, jobGroupName);
            // 表达式调度构建器
            CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
    
            CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
    
            // 按新的cronExpression表达式重新构建trigger
            trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();
    
            //修改map
            trigger.getJobDataMap().putAll(argMap);
    
            // 按新的trigger重新设置job执行
            scheduler.rescheduleJob(triggerKey, trigger);
    
        }
    
        /**
         * job 更新,只更新更新参数
         *
         * @param jobName      任务名称
         * @param jobGroupName 任务所在组名称
         * @param argMap       参数
         * @throws Exception
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void updateJob(String jobName, String jobGroupName, Map<String, Object> argMap) throws Exception {
            TriggerKey triggerKey = TriggerKey.triggerKey(jobName, jobGroupName);
    
            CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
    
            //修改map
            trigger.getJobDataMap().putAll(argMap);
    
            // 按新的trigger重新设置job执行
            scheduler.rescheduleJob(triggerKey, trigger);
    
        }
    
    
        /**
         * job 删除
         *
         * @param jobName      任务名称
         * @param jobGroupName 任务所在组名称
         * @throws Exception
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void deleteJob(String jobName, String jobGroupName) throws Exception {
            scheduler.pauseTrigger(TriggerKey.triggerKey(jobName, jobGroupName));
            scheduler.unscheduleJob(TriggerKey.triggerKey(jobName, jobGroupName));
            scheduler.deleteJob(JobKey.jobKey(jobName, jobGroupName));
        }
    
    
        /**
         * 启动所有定时任务
         *
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void startAllJobs() {
            try {
                scheduler.start();
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        }
    
        /**
         * 关闭所有定时任务
         *
         * @author xujingyang
         * @date 2018/5/30.
         */
        public void shutdownAllJobs() {
            try {
                if (!scheduler.isShutdown()) {
                    scheduler.shutdown();
                }
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
    
    
        }
    
        /**
         * 获取所有任务列表
         *
         * @return
         * @throws SchedulerException
         */
        public List<Map<String, Object>> getAllJob() throws SchedulerException {
            GroupMatcher<JobKey> matcher = GroupMatcher.anyJobGroup();
            Set<JobKey> jobKeys = scheduler.getJobKeys(matcher);
            List<Map<String, Object>> jobList = new ArrayList<>();
            for (JobKey jobKey : jobKeys) {
                List<? extends Trigger> triggers = scheduler.getTriggersOfJob(jobKey);
                for (Trigger trigger : triggers) {
                    Map<String, Object> job = new HashMap<>();
                    job.put("jobName", jobKey.getName());
                    job.put("jobGroupName", jobKey.getGroup());
                    job.put("trigger", trigger.getKey());
                    Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());
                    job.put("jobStatus", triggerState.name());
                    if (trigger instanceof CronTrigger) {
                        CronTrigger cronTrigger = (CronTrigger) trigger;
                        String cronExpression = cronTrigger.getCronExpression();
                        job.put("cronExpression", cronExpression);
                    }
                    jobList.add(job);
                }
            }
            return jobList;
        }
    }

9.DemoApplicationTests

package com.example.demo;
    
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes = DemoApplication.class)
    class DemoApplicationTests {
    
        @Test
        void contextLoads() throws Exception {
            QuartzJobManager instance = QuartzJobManager.getInstance();
            instance.addJob(TestQuartz.class, "test","test","* * * * * ?");
            // QuartzJobManager.getInstance().addJob(Test.class, "test","test","* * * * * ?");
        }
    
    }