Quartz任务中调用Spring容器中bean及动态调度任务-SchedulerFactoryBean「建议收藏」

大家好，又见面了，我是你们的朋友全栈君。

Quartz 是开源任务调度框架中的翘首，它提供了强大任务调度机制，同时保持了使用的简单性。Quartz 允许开发人员灵活地定义触发器的调度时间表，并可以对触发器和任务进行关联映射。此外，Quartz提供了调度运行环境的持久化机制，可以保存并恢复调度现场，即使系统因故障关闭，任务调度现场数据并不会丢失。此外，Quartz还提供了组件式的侦听器、各种插件、线程池等功能。 

Spring为创建Quartz的Scheduler、Trigger和JobDetail提供了便利的FactoryBean类，以便能够在Spring 容器中享受注入的好处。此外Spring还提供了一些便利工具类直接将Spring中的Bean包装成合法的任务。Spring进一步降低了使用Quartz的难度，能以更具Spring风格的方式使用Quartz。概括来说它提供了两方面的支持： 
1)为Quartz的重要组件类提供更具Bean风格的扩展类； 
2)提供创建Scheduler的BeanFactory类，方便在Spring环境下创建对应的组件对象，并结合Spring容器生命周期进行启动和停止的动作。 

第一步： 配置SchedulerFactoryBean 
Quartz的SchedulerFactory是标准的工厂类，不太适合在Spring环境下使用。此外，为了保证Scheduler能够感知Spring容器的生命周期，完成自动启动和关闭的操作，必须让Scheduler和Spring容器的生命周期相关联。以便在Spring容器启动后，Scheduler自动开始工作，而在Spring容器关闭前，自动关闭Scheduler。为此，Spring提供SchedulerFactoryBean，这个FactoryBean大致拥有以下的功能： 
1)以更具Bean风格的方式为Scheduler提供配置信息； 
2)让Scheduler和Spring容器的生命周期建立关联，相生相息； 
3)通过属性配置部分或全部代替Quartz自身的配置文件。 
spring容器中的bean只能放到SchedulerContext里面传入job中。 

原文地址：https://www.iteye.com/blog/john-kong19-1162423

Java代码 

<bean name="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean" >  
                <!-- 注入数据源 -->    
        <property name="dataSource">    
            <ref bean="dataSource" />    
        </property>  
        <property name="transactionManager" ref="txManager">  
        </property>  
                <!-- 延迟30秒启动Scheduler -->    
        <property name="startupDelay" value="30"></property>  
        <property name="schedulerContextAsMap">    
            <map>    
        <!-- spring 管理的service需要放到这里，才能够注入成功 -->    
                <description>schedulerContextAsMap</description>    
                <entry key="jobService" value-ref="jobService"/>  
            </map>    
        </property>  
                <!-- 通过applicationContextSchedulerContextKey属性配置spring上下文 -->    
        <property name="applicationContextSchedulerContextKey">    
            <value>applicationContext</value>    
        </property>   
    </bean>  

SchedulerFactoryBean属性介绍： 
●triggers：triggers属性为Trigger[]类型，可以通过该属性注册多个Trigger 
●calendars：类型为Map，通过该属性向Scheduler注册Calendar； 
●jobDetails：类型为JobDetail[]，通过该属性向Scheduler注册JobDetail； 
●autoStartup：SchedulerFactoryBean在初始化后是否马上启动Scheduler，默认为true。如果设置为false，需要手工启动Scheduler； 
●startupDelay：在SchedulerFactoryBean初始化完成后，延迟多少秒启动Scheduler，默认为0，表示马上启动。如果并非马上拥有需要执行的任务，可通过startupDelay属性让Scheduler延迟一小段时间后启动，以便让Spring能够更快初始化容器中剩余的Bean； 

SchedulerFactoryBean的一个重要功能是允许你将Quartz配置文件中的信息转移到Spring配置文件中，带来的好处是，配置信息的集中化管理，同时我们不必熟悉多种框架的配置文件结构。回忆一个Spring集成JPA、Hibernate框架，就知道这是Spring在集成第三方框架经常采用的招数之一。SchedulerFactoryBean通过以下属性代替框架的自身配置文件： 
●dataSource：当需要使用数据库来持久化任务调度数据时，你可以在Quartz中配置数据源，也可以直接在Spring中通过dataSource指定一个Spring管理的数据源。如果指定了该属性，即使quartz.properties中已经定义了数据源，也会被此dataSource覆盖； 
●transactionManager：可以通过该属性设置一个Spring事务管理器。在设置dataSource时，Spring强烈推荐你使用一个事务管理器，否则数据表锁定可能不能正常工作； 
●nonTransactionalDataSource：在全局事务的情况下，如果你不希望Scheduler执行化数据操作参与到全局事务中，则可以通过该属性指定数据源。在Spring本地事务的情况下，使用dataSource属性就足够了； 
●quartzProperties：类型为Properties，允许你在Spring中定义Quartz的属性。其值将覆盖quartz.properties配置文件中的设置，这些属性必须是Quartz能够识别的合法属性，在配置时，你可以需要查看Quartz的相关文档。 

配置好数据源dataSource后，需要在Quartz的QRTZ_LOCKS表中插入以下数据： 
INSERT INTO QRTZ_LOCKS values(‘TRIGGER_ACCESS’); 
INSERT INTO QRTZ_LOCKS values(‘JOB_ACCESS’); 
否则会报 
org.springframework.beans.factory.BeanCreationException: Error creating bean with name ‘scheduler’ defined in file […\webapps\WEB-INF\classes\config\applicationContext-quartz.xml]: Invocation of init method failed; nested exception is org.quartz.SchedulerConfigException: Failure occured during job recovery. [See nested exception: org.quartz.impl.jdbcjobstore.LockException: Failure obtaining db row lock: No row exists in table QRTZ_LOCKS for lock named: TRIGGER_ACCESS [See nested exception: java.sql.SQLException: No row exists in table QRTZ_LOCKS for lock named: TRIGGER_ACCESS]]异常 

第二步 动态添加Job 

Java代码 

JobDetail jobDetail = new JobDetail("jobName", "jobGroup",  
            TestJob.class);  
    jobDetail.setDescription("Description");  
    CronTrigger trigger = new CronTrigger("TriggerName",  
            "TriggerGroup", "CronContent");  
    try {  
            if (!scheduler.isStarted()) {  
            scheduler.start();  
        }  
        scheduler.scheduleJob(jobDetail, trigger);  
     catch (SchedulerException e) {  
     } 

第三步 实现Job实现类 

Java代码 

public class TestJob extends QuartzJobBean {  
  
    @Override  
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {  
        Scheduler scheduler = (Scheduler) context.getScheduler();    
        String jobName = context.getJobDetail().getName();  
        String jobGroup = context.getJobDetail().getGroup();  
        //获取JobExecutionContext中的service对象    
        try {  
                        //获取JobExecutionContext中的service对象   
            SchedulerContext schCtx = context.getScheduler().getContext();  
                        //获取Spring中的上下文    
            ApplicationContext appCtx = (ApplicationContext)schCtx.get("applicationContext");  
            jobService= (JobService)appCtx.getBean("jobService");  
            ....  
        } catch (SchedulerException e1) {  
            // TODO 尚未处理异常  
            e1.printStackTrace();  
        }   
        }   
  
  
    };