Spring整合Quartz

最新推荐文章于 2024-07-03 13:02:21 发布

原创最新推荐文章于 2024-07-03 13:02:21 发布 · 172 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Quartz #Spring

Quartz 专栏收录该内容

7 篇文章

订阅专栏

本文详细介绍如何在Spring框架中整合Quartz实现定时任务的配置与管理。通过定义Job、Trigger及Scheduler，实现不同频率的任务调度。文章包含具体配置示例及测试代码。

Spring整合Quartz

依赖：

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <springframework.version>4.2.6.RELEASE</springframework.version>
    <quartz.version>2.2.3</quartz.version>
  </properties>


  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context-support</artifactId>
      <version>${springframework.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>${springframework.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${springframework.version}</version>
    </dependency>
    <dependency>
      <groupId>org.quartz-scheduler</groupId>
      <artifactId>quartz</artifactId>
      <version>${quartz.version}</version>
    </dependency>
  </dependencies>

applicationContext.xml

<?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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
         http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
         http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task.xsd">

        <!--
                Spring整合Quartz进行配置遵循下面的步骤：
                1. 定义工作任务Job
                2. 定义触发器Trigger，并将触发器与工作任务绑定
                3. 定义调度器，并将Trigger注册到Scheduler
        -->

        <!-- 1：定义任务的bean，这里使用JobDetailFactoryBean，也可以使用MethodInvokingJobDetailFactoryBean，配置类似 -->
        <bean name="myJob" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
                <!-- 指定Job的名称 -->
                <property name="name" value="job1"/>
                <!-- 指定Job分组 -->
                <property name="group" value="group1"/>
                <!-- 指定具体的Job类 -->
                <property name="jobClass" value="pers.zhang.quartz.MyJob"/>
                <!-- 如果为false，当没有活动的触发器与之关联时会在调度器中删除该任务（可选） -->
                <property name="durability" value="true"/>
                <!-- （可选）
                        指定spring容器的key，如果不设定在job中的jobmap中是获取不到spring容器的
                        其实现了ApplicationContextAware，则其中的setApplicationContext方法会得到当前
                        的工厂对象，且将工厂对象存在了类的一个属性『applicationContext』中，源码如下：

                        getJobDataMap().put(this.applicationContextJobDataKey, this.applicationContext);
                        则在Job的jobMap中可以获取工厂对象，如果需要可以调用：
                        (ApplicationContext)jobDataMap.get("applicationContext2021");
                  -->
                <property name="applicationContextJobDataKey" value="applicationContext2021"/>
        </bean>

        <bean name="myJob2" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
                <property name="name" value="job2"/>
                <property name="group" value="group2"/>
                <property name="jobClass" value="pers.zhang.quartz.MyJob2"/>
                <property name="durability" value="true"/>
                <property name="applicationContextJobDataKey" value="applicationContext2021"/>
        </bean>

        <!-- 2：定义触发器的bean，定义一个Cron的Trigger，一个触发器只能和一个任务进行绑定 -->
        <bean id="crontrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
                <!-- 指定Trigger名称 -->
                <property name="name" value="myTrigger"/>
                <!-- 指定Trigger的组 -->
                <property name="group" value="myGroup"/>
                <!-- 指定Trigger绑定的Job -->
                <property name="jobDetail" ref="myJob"/>
                <!-- 指定Cron的表达式（5秒一次） -->
                <property name="cronExpression" value="*/5 * * * * ?"/>
        </bean>

        <bean id="crontrigger2" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
                <!-- 指定Trigger名称 -->
                <property name="name" value="myTrigger2"/>
                <!-- 指定Trigger的组 -->
                <property name="group" value="myGroup2"/>
                <!-- 指定Trigger绑定的Job -->
                <property name="jobDetail" ref="myJob2"/>
                <!-- 指定Cron的表达式（10秒一次） -->
                <property name="cronExpression" value="*/10 * * * * ?"/>
        </bean>

        <!-- 3：定义调度器，并将Trigger注册到调度器中 -->
        <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
                <property name="triggers">
                        <list>
                                <ref bean="crontrigger"/>
                                <ref bean="crontrigger2"/>
                        </list>
                </property>
                <!-- 添加quartz配置，如下两种方式均可 -->
<!--                <property name="configLocation" value="classpath:quartz.properties"></property>-->
                <property name="quartzProperties">
                        <value>
                               # 指定调度器名称，实际类型为：QuartzScheduler
                               org.quartz.scheduler.instanceName = MyScheduler
                               # 指定连接池
                               org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
                               # 连接池线程数量
                               org.quartz.threadPool.threadCount = 11
                               # 优先级
                               org.quartz.threadPool.threadPriority = 5
                               # 不持久化
                               org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore
                        </value>
                </property>
        </bean>

</beans>

Job

public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("MyJob执行" + new Date());
    }
}


public class MyJob2 implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("MyJob2执行" + new Date());
    }
}

测试：启动ApplicationContext定时任务即开始运行

public class quartzTest {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");

    }
}

打印：

MyJob执行Fri Apr 10 22:23:30 CST 2020
MyJob2执行Fri Apr 10 22:23:30 CST 2020
MyJob执行Fri Apr 10 22:23:35 CST 2020
MyJob执行Fri Apr 10 22:23:40 CST 2020
MyJob2执行Fri Apr 10 22:23:40 CST 2020

调度器常用API

public class quartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        StdScheduler  scheduler = (StdScheduler) context.getBean("scheduler");


        TimeUnit.SECONDS.sleep(10);
        
        //暂停Trigger
        scheduler.pauseTrigger(TriggerKey.triggerKey("myTrigger", "myGroup"));
        //恢复Trigger
        scheduler.resumeTrigger(TriggerKey.triggerKey("myTrigger", "myGroup"));
        //暂停任务
        scheduler.pauseJob(JobKey.jobKey("myjob1", "group1"));
        //恢复任务
        scheduler.resumeJob(JobKey.jobKey("myjob1", "group1"));
        
        //暂停整组任务
        scheduler.pauseJobs(GroupMatcher.groupEquals("group1"));
        //恢复
        scheduler.resumeJobs(GroupMatcher.groupEquals("group1"));

    }
}