Spring+quartz 实现定时任务job集群配置【原】

阳光穿透心脏的1/2处 2022-05-28 11:26 213阅读 0赞

##    为什么要有集群定时任务? ##

因为如果多server都触发相同任务,又同时执行,那在99%的场景都是不适合的.比如银行每晚24:00都要汇总营业额.像下面3台server同时进行汇总,最终计算结果可能是真实结果的3倍,那对银行来说是无法想象的,完全不可接受.

![756542-20160830221028965-917017180.png][]

## 集群定时任务工作原理 ##

所以为了解决以上问题,每个server把将要及正在运行的job所有状态都即时同步到中央数据库,然后再次触发调用时从数据库中分析是否已有别的server正在运行相同job (同名同定时时间点的job属于相当job),如果相同job正在别的server运行,那么当前server忽略本次运行的job.

Quartz的 Task（11 张表）实例化采用数据库存储，基于数据库引擎及 High-Available 的策略（集群的一种策略）自动协调每个节点的 Quartz。

## 相关下载 ##

[quartz-1.8.6][]

[项目源码样例 ![o_8939611_172151091000_2.jpg][]][o_8939611_172151091000_2.jpg 1]

git地址: https://git.oschina.net/KingBoBo/SpringQuartzCluster.git

## 相关文件 ##

### ClusterJob.java ###

说明:集群下工作的Job,仅是实现了Serializable的Bean.

![复制代码][copycode.gif]

package king.quartz.job;
    
    import java.io.Serializable;
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    
    /**
     * 可序列化的集群job
     * @author King
     *
     */
    public class ClusterJob implements Serializable {
        public static int i = 0;
    
        private static Log log = LogFactory.getLog(ClusterJob.class);
    
        public void execute() throws InterruptedException {
            log.debug("begin begin begin begin begin begin begin begin ! job = "+ ++i);
            System.out.print("job = "+i+" is running ");
            for(int j = 1 ; j <= 5;j++){
       //运行5秒
                System.out.print( j +" ");
                Thread.sleep(1*1000);
            }
            System.out.println();
            log.debug("end end end end end end end end end end end end ! job = "+ i);
        }
    
    }

![复制代码][copycode.gif]

### 被修改后的MethodInvokingJobDetailFactoryBean ###

因为spring自带的org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean的invoke()方法不能序列化job,导致无法把序列化后的信息写到表中,这可以算是spring的一个bug.

所以有民间大神修改后的MethodInvokingJobDetailFactoryBean,该Bean的invoke()方法可使job序列化,2拿来直接上手用吧(注意按包路径要和applicationContext-quartz.xml文件中的路径一致)

![ContractedBlock.gif][]

### web.xml ###

![复制代码][copycode.gif]

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
      <display-name>SpringQuartzCluster</display-name>
      <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
      </welcome-file-list>
      <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:applicationContext-quartz.xml</param-value>
      </context-param>
      <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
      </listener>
      <servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
      </servlet>
      <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
      </servlet-mapping>
      <session-config>
        <session-timeout>60</session-timeout>
      </session-config>
    </web-app>

![复制代码][copycode.gif]

### applicationContext-quartz.xml ###

正常情况应该从applicationContext.xml的总配置文件中import该applicationContext-quartz.xml. 由于小项目,直接作为总配置文件

![复制代码][copycode.gif]

<?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:aop="http://www.springframework.org/schema/aop"
        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd"
        default-lazy-init="false" default-autowire="byName">
    
        
        <bean id="clusterJob" class="king.quartz.job.ClusterJob" />
    
        
        <bean id="clusterJobDetail"
            class="king.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
            
            <property name="concurrent" value="false" />
            <property name="shouldRecover" value="true" />
            <property name="targetObject" ref="clusterJob" />
            <property name="targetMethod" value="execute" />
        </bean>
        
        
        <bean id="clusterCronTriggerBean" class="org.springframework.scheduling.quartz.CronTriggerBean">
            <property name="jobDetail" ref="clusterJobDetail" />
            <property name="cronExpression" value="0/7 * * * * ? *" /> 
        </bean>
    
        
        <bean id="clusterSchedulerFactoryBean"
            class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
            
            <property name="configLocation" value="classpath:quartz.properties" />
                 
            <property name="startupDelay" value="1" />    
                
            <property name="autoStartup" value="true" />  
            <property name="applicationContextSchedulerContextKey" value="applicationContextKey" />
            <property name="triggers">
                <list>
                    <ref bean="clusterCronTriggerBean" /> 
                </list>
            </property>
        </bean>
    
    </beans>

![复制代码][copycode.gif]

### quartz.properties ###

该配置文件一定要放在classpath目录下,因为SchedulerFactoryBean直接引用了configuration配置,所以还要配置相关数据源,见尾部Configure DataSource,其它保持原样即可,当然如果要调优的话里面参数肯定可以........

![复制代码][copycode.gif]

#============================================================================
    # Configure Main Scheduler Properties  
    #============================================================================
    org.quartz.scheduler.instanceName = DefaultQuartzScheduler
    org.quartz.scheduler.instanceId = AUTO
    org.quartz.scheduler.rmi.export = false
    org.quartz.scheduler.rmi.proxy = false
    org.quartz.scheduler.wrapJobExecutionInUserTransaction = false
    
    #============================================================================
    # Configure ThreadPool  
    #============================================================================
    org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
    org.quartz.threadPool.threadCount = 10
    org.quartz.threadPool.threadPriority = 5
    org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true
    
    #============================================================================
    # Configure JobStore  
    #============================================================================
    org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
    org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.oracle.OracleDelegate
    org.quartz.jobStore.misfireThreshold = 60000
    org.quartz.jobStore.useProperties = false
    org.quartz.jobStore.tablePrefix = QRTZ_
    org.quartz.jobStore.dataSource = myDS
    
    org.quartz.jobStore.isClustered = true
    org.quartz.jobStore.clusterCheckinInterval = 15000
    
    #============================================================================
    # Configure DataSource
    #============================================================================
    org.quartz.dataSource.myDS.driver = oracle.jdbc.driver.OracleDriver
    org.quartz.dataSource.myDS.URL = jdbc:oracle:thin:@10.15.22.117:1521:DWXDBDEV
    org.quartz.dataSource.myDS.user = U_IPCIS_POLICY_PLATFORM
    org.quartz.dataSource.myDS.password = 11
    org.quartz.dataSource.myDS.maxConnections = 10
    #org.quartz.dataSource.myDS.driver = oracle.jdbc.driver.OracleDriver
    #org.quartz.dataSource.myDS.URL = jdbc:oracle:thin:@LonelyTear-PC:1521:ORACLEDB
    #org.quartz.dataSource.myDS.user = bobo
    #org.quartz.dataSource.myDS.password = b
    #org.quartz.dataSource.myDS.maxConnections = 10

![复制代码][copycode.gif]

###  Main方法入口 ###

![复制代码][copycode.gif]

package king.quartz.main;
    
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    public class Main {
    
        public static void main(String[] args) {
            //下面的非web形式直接加载可能会导致job同时加载并执行2次,原因不明(历史印象是用了log4j的日志会导致该情况)
            //只能做普通测试用,最好在Tomcat等容器中以web形式运行,且指明docBase路径
            new ClassPathXmlApplicationContext("applicationContext-quartz.xml");
        }
    
    }

![复制代码][copycode.gif]

当我们启动2次Main方法,最终只有一个Main会运行,如下:

![复制代码][copycode.gif]

job = 65 is running 1 2 3 4 5 
    job = 66 is running 1 2 3 4 5 
    job = 67 is running 1 2 3 4 5 
    job = 68 is running 1 2 3 4 5 
    job = 69 is running 1 2 3 4 5 
    job = 70 is running 1 2 3 4 5 
    job = 71 is running 1 2 3 4 5

![复制代码][copycode.gif]

##  sql ##

特别注意下面的sql版本要和squartz完全一致,在解压后的quartz\\quartz-1.8.6\\docs\\dbTables文件夹在都有

### tables\_mysql\_innodb.sql ###

mysql对应数据表,拉下来全导入执行一遍

![ContractedBlock.gif][]

###  tables\_oracle.sql ###

oracle对应数据表,拉下来全导入执行一遍

![ContractedBlock.gif][]

### 遇见异常 ###

#### 异常一 No row exists in table QRTZ\_LOCKS for lock named: TRIGGER\_ACCESS. ####

该异常产生原因是,我项目中用的是quartz-1.8.6的jar,但由于quartz版本差异过大,在不知情的情况下从官网down了最新的quartz-2.2.3且把2.2.3的dbTables文件夹下的tables\_oracle.sql导了进来.所以最终和1.8.6的表结构不一致.

就目前来看quartz-2.2.3的tables\_oracle.sql比1.8.6的合理很多,1.8.6建表始化时还会建一些尴尬的外键关联,这是让我极不喜欢的一点.

异常如下,请点击展开

![ContractedBlock.gif][]

####  异常二 在xml配置中把定时任务的配置全删了,竟然还是执行了 ####

这是spring的一个bug，所以需要去查询这三张表,它们储存了定时任务,把相关的定时任务删了即可

delete  from  QRTZ_CRON_TRIGGERS where TRIGGER_NAME = 'echannel.synchronizeJobTrigger';
    
    delete  from  QRTZ_TRIGGERS where TRIGGER_NAME = 'echannel.synchronizeJobTrigger';
    
    delete  from QRTZ_JOB_DETAILS where job_name = 'echannel.synchronize.content';

####  其它无关紧要的资料 ####

##### SimpleTriggerBean #####

简易版Spring触发器,功能和org.springframework.scheduling.quartz.CronTriggerBean相似

![ContractedBlock.gif][]

## 参考 ##

[Spring(单机)定时任务的几种实现][Spring]

[Spring+quartz集群配置，Spring定时任务集群，quartz定时任务集群][Spring_quartz_Spring_quartz](强烈推荐)

[quartz集群分布式(并发)部署解决方案-Spring][quartz_-Spring]

[Spring中定时任务Quartz集群配置学习][Spring_Quartz]

[Spring+Quartz 集群][Spring_Quartz 1]

[spring结合Quartz的集群功能实现][spring_Quartz]

[spring+Quartz集群环境下配置详解][spring_Quartz 1]

本文原创,转载请说明出处 by 金墨痴 [http://www.cnblogs.com/whatlonelytear/p/5823837.html][http_www.cnblogs.com_whatlonelytear_p_5823837.html] [  
][Link 1]

> 作者：[whatlonelytear][]  
> 本文地址：[https://www.cnblogs.com/whatlonelytear/p/5823837.html][whatlonelytear]  
> 欢迎转载，请在明显位置给出出处及链接。

[756542-20160830221028965-917017180.png]: /images/20220528/0ae6132d762f4833b5011080bfac170a.png
[quartz-1.8.6]: http://d2zwv9pap9ylyd.cloudfront.net/quartz-1.8.6.tar.gz
[o_8939611_172151091000_2.jpg]: /images/20220528/6fc1cc20dc1946bc84cc8bba7e08d289.png
[o_8939611_172151091000_2.jpg 1]: http://pan.baidu.com/s/1bpLu9Gz
[copycode.gif]: /images/20220528/bf7eed82776c45c39db50be526d9cb0a.png
[ContractedBlock.gif]: /images/20220528/9a5daa4d45f347c0824262d70f545864.png
[Spring]: http://gong1208.iteye.com/blog/1773177
[Spring_quartz_Spring_quartz]: http://fanshuyao.iteye.com/blog/2309702
[quartz_-Spring]: http://www.tuicool.com/articles/B3qeUrB
[Spring_Quartz]: http://blog.csdn.net/zxl315/article/details/10830105
[Spring_Quartz 1]: http://soulshard.iteye.com/blog/337886
[spring_Quartz]: http://www.cnblogs.com/wuhao1991/p/4332446.html
[spring_Quartz 1]: http://www.52itstyle.com/thread-890-1-1.html
[http_www.cnblogs.com_whatlonelytear_p_5823837.html]: http://www.cnblogs.com/whatlonelytear/p/5823837.html
[Link 1]: http://www.cnblogs.com/whatlonelytear/p/5841152.html
[whatlonelytear]: https://www.cnblogs.com/whatlonelytear/p/5823837.html