前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Quartz与Spring集成—— SchedulerFactoryBean的初始化分析「建议收藏」

Quartz与Spring集成—— SchedulerFactoryBean的初始化分析「建议收藏」

作者头像
全栈程序员站长
发布2022-08-31 21:15:58
6690
发布2022-08-31 21:15:58
举报

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

前言

Quartz是一个开源的定时调度框架,支持集群部署。我们可以通过其Java API来使用它,或者通过Spring来配置与管理,也可以结合使用两种方式。本文重点分析Quartz2.2.3与Spring4.3.0.RELEASE集成时的初始化过程。

SchedulerFactoryBean

与Spring集成时通常需要在Spring配置文件中加入SchedulerFactoryBean这个工厂Bean,例如:

代码语言:javascript
复制
    <bean id="schedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="overwriteExistingJobs" value="true"/>
        <property name="configLocation" value="classpath:quartz.properties"/>
    </bean>

再来看看SchedulerFactoryBean的类定义:

代码语言:javascript
复制
public class SchedulerFactoryBean extends SchedulerAccessor implements FactoryBean<Scheduler>, BeanNameAware,
		ApplicationContextAware, InitializingBean, DisposableBean, SmartLifecycle {

从中看到其实现了FactoryBean、BeanNameAware、ApplicationContextAware、InitializingBean、DisposableBean等常用接口,这些接口的具体意义本文不作赘述,不了解的可以专门研究下Spring的原理和源码实现。根据Spring的原理我们知道,如果Bean本身实现了InitializingBean接口,那么在Spring加载解析BeanDefinition,并初始化Bean后会调用SchedulerFactoryBean的afterPropertiesSet方法,这里只会挑出其中的关键代码进行分析。

初始化SchedulerFactory

在afterPropertiesSet中首先会初始化SchedulerFactory,代码如下:

代码语言:javascript
复制
		// Create SchedulerFactory instance...
		SchedulerFactory schedulerFactory = BeanUtils.instantiateClass(this.schedulerFactoryClass);
		initSchedulerFactory(schedulerFactory);

属性schedulerFactoryClass的默认值是StdSchedulerFactory.class,因此这里默认会初始化StdSchedulerFactory,用户也可以使用Spring的配置文件修改schedulerFactoryClass的值为其他SchedulerFactory接口的实现(比如RemoteScheduler或者继承RemoteMBeanScheduler的子类)。在使用Spring的BeanUtils工具类对SchedulerFactory实例化后,调用initSchedulerFactory方法(见代码清单1)对SchedulerFactory初始化。

代码清单1 初始化SchedulerFactory

代码语言:javascript
复制
	private void initSchedulerFactory(SchedulerFactory schedulerFactory) throws SchedulerException, IOException {
		if (!(schedulerFactory instanceof StdSchedulerFactory)) {
			if (this.configLocation != null || this.quartzProperties != null ||
					this.taskExecutor != null || this.dataSource != null) {
				throw new IllegalArgumentException(
						"StdSchedulerFactory required for applying Quartz properties: " + schedulerFactory);
			}
			// Otherwise assume that no initialization is necessary...
			return;
		}

		Properties mergedProps = new Properties();

		if (this.resourceLoader != null) {
			mergedProps.setProperty(StdSchedulerFactory.PROP_SCHED_CLASS_LOAD_HELPER_CLASS,
					ResourceLoaderClassLoadHelper.class.getName());
		}

		if (this.taskExecutor != null) {
			mergedProps.setProperty(StdSchedulerFactory.PROP_THREAD_POOL_CLASS,
					LocalTaskExecutorThreadPool.class.getName());
		}
		else {
			// Set necessary default properties here, as Quartz will not apply
			// its default configuration when explicitly given properties.
			mergedProps.setProperty(StdSchedulerFactory.PROP_THREAD_POOL_CLASS, SimpleThreadPool.class.getName());
			mergedProps.setProperty(PROP_THREAD_COUNT, Integer.toString(DEFAULT_THREAD_COUNT));
		}

		if (this.configLocation != null) {
			if (logger.isInfoEnabled()) {
				logger.info("Loading Quartz config from [" + this.configLocation + "]");
			}
			PropertiesLoaderUtils.fillProperties(mergedProps, this.configLocation);
		}

		CollectionUtils.mergePropertiesIntoMap(this.quartzProperties, mergedProps);

		if (this.dataSource != null) {
			mergedProps.put(StdSchedulerFactory.PROP_JOB_STORE_CLASS, LocalDataSourceJobStore.class.getName());
		}

		// Make sure to set the scheduler name as configured in the Spring configuration.
		if (this.schedulerName != null) {
			mergedProps.put(StdSchedulerFactory.PROP_SCHED_INSTANCE_NAME, this.schedulerName);
		}

		((StdSchedulerFactory) schedulerFactory).initialize(mergedProps);
	}

仔细阅读initSchedulerFactory方法,可以理解其初始化过程如下:

  1. 对于非StdSchedulerFactory的其他SchedulerFactory,需要对参数进行检查;
  2. 设置内置的属性并存入mergedProps这个字典中。这些属性包括:
    • org.quartz.scheduler.classLoadHelper.class:用于Quartz与Spring集成时加载Spring资源;
    • org.quartz.threadPool.class:执行Quartz中Task的线程池;
    • org.quartz.threadPool.threadCount:执行Quartz中Task的线程池的线程数量。
  3. 加载configLocation属性指定的属性文件中的属性并合并到mergedProps中,这说明属性文件中的配置可以覆盖内置的属性参数。
  4. 向mergedProps中设置其它属性:
    • org.quartz.jobStore.class:作业持久化存储的类,值为LocalDataSourceJobStore;
    • org.quartz.scheduler.instanceName:值为Spring配置文件中设置的值;
  5. 调用StdSchedulerFactory的initialize方法进一步初始化,实质上不过是创建PropertiesParser对mergedProps进行包装(见代码清单2);

代码清单2 StdSchedulerFactory的initialize实现

代码语言:javascript
复制
    public void initialize(Properties props) throws SchedulerException {        if (propSrc == null) {            propSrc = "an externally provided properties instance.";        }        this.cfg = new PropertiesParser(props);    }

初始化后的动作

在SchedulerFactory初始化完成后,还会执行代码清单3中代码,其步骤归纳如下:

  1. 使用ThreadLocal技术持有resourceLoader、taskExecutor、dataSource、nonTransactionalDataSource;
  2. 调用createScheduler方法创建调度器(具体内容请阅读《Quartz与Spring集成——创建调度器》一文);
  3. 调用populateSchedulerContext,指定调度上下文(SchedulerContext)的属性和它有的Spring的ApplicationContext;
  4. 给调度器设置作业工厂类JobFactory;
  5. 调用registerListeners方法注册有关调度、作业、触发器等内容的监听器(见代码清单4);
  6. 调用registerJobsAndTriggers方法注册作业和触发器(具体内容将会在另一篇博文单独介绍);

代码清单3 初始化后的动作

代码语言:javascript
复制
	this.scheduler = createScheduler(schedulerFactory, this.schedulerName);
	populateSchedulerContext();

	if (!this.jobFactorySet && !(this.scheduler instanceof RemoteScheduler)) {
		// Use AdaptableJobFactory as default for a local Scheduler, unless when
		// explicitly given a null value through the "jobFactory" bean property.
		this.jobFactory = new AdaptableJobFactory();
	}
	if (this.jobFactory != null) {
		if (this.jobFactory instanceof SchedulerContextAware) {
			((SchedulerContextAware) this.jobFactory).setSchedulerContext(this.scheduler.getContext());
		}
		this.scheduler.setJobFactory(this.jobFactory);
	}
 	//省略次要代码
	registerListeners();
	registerJobsAndTriggers();

代码清单4 注册监听器

代码语言:javascript
复制
	protected void registerListeners() throws SchedulerException {
		ListenerManager listenerManager = getScheduler().getListenerManager();
		if (this.schedulerListeners != null) {
			for (SchedulerListener listener : this.schedulerListeners) {
				listenerManager.addSchedulerListener(listener);
			}
		}
		if (this.globalJobListeners != null) {
			for (JobListener listener : this.globalJobListeners) {
				listenerManager.addJobListener(listener);
			}
		}
		if (this.globalTriggerListeners != null) {
			for (TriggerListener listener : this.globalTriggerListeners) {
				listenerManager.addTriggerListener(listener);
			}
		}
	}

总结

对于熟悉Java的开发人员而言,任何Java对象(基本对象和复合对象)在使用之前都需要初始化,Quartz作为一个大的组件,其本身也是一个对象。从SchedulerFactoryBean的类定义中,我们可以看到其充分利用了Spring提供的各种扩展接口,以便于在调度上下文中使用Spring支持的丰富功能。在SchedulerFactory的初始化过程中,我们看到SchedulerFactoryBean支持多种注入属性,而且这些属性可以覆盖内置的属性设置,使用者可以根据自身需要进行配置。另外通过configLocation属性指定属性文件,可以在单独的属性文件中配置属性,当要配置的属性很多时,可以避免xml配置臃肿。添加对调度、作业及触发器等内容的监听器添加,以便于感兴趣的组件,在以上内容发生变化时,进行一些操作。这种方式也能够将其他组件与SchedulerFactoryBean之间的关系进行解耦。

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/142186.html原文链接:https://javaforall.

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022年5月2,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • SchedulerFactoryBean
    • 初始化SchedulerFactory
      • 初始化后的动作
      • 总结
      领券
      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档