spring4.3.7整合quartz2.2.3
阿新 • • 發佈：2019-01-13
因專案需要，在SSM中整合quartz，其中遇到了幾處很坑的地方，作為記錄，方便以後檢視。
專案背景：
Maven構建專案：Spring4.3.7、Shiro1.3.2、Quartz2.2.3，資料庫用的是MySQL 5.6.36
1. 首先引入Quartz的jar包
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<version>2.2.3</version 2. 在資料庫中建立Quartz相關的表
tables_mysql_innodb.sql 這些表在官網上可以下載，http://www.quartz-scheduler.org/downloads/
#
# In your Quartz properties file, you'll need to set
# org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate
#
#
# By: Ron Cordell - roncordell
# I didn't see this anywhere, so I thought I'd post it here. This is 然後向qrtz_locks表中插入幾條資料，要不會報錯。
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]
INSERT INTO `qrtz_locks` VALUES ('scheduler', 'TRIGGER_ACCESS');
INSERT INTO `qrtz_locks` VALUES ('scheduler', 'JOB_ACCESS');
INSERT INTO `qrtz_locks` VALUES ('scheduler', 'CALENDAR_ACCESS');
INSERT INTO `qrtz_locks` VALUES ('scheduler', 'STATE_ACCESS');
INSERT INTO `qrtz_locks` VALUES ('scheduler', 'MISFIRE_ACCESS');3. 新建Quartz相關的配置檔案：quartz.properties
官網的配置檔案持久化用的是Oracle資料庫，我這裡用的是MySQL，略作修改。
# 官網配置：http://www.quartz-scheduler.org/documentation/quartz-2.2.x/configuration/ConfigJDBCJobStoreClustering.html
#===================================================================
# Configure Main Scheduler Properties
#===================================================================
org.quartz.scheduler.instanceName: quartzScheduler
org.quartz.scheduler.instanceId = AUTO
#===================================================================
# Configure ThreadPool
#===================================================================
org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount: 2
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
org.quartz.jobStore.misfireThreshold: 60000
#===================================================================
# Configure JobStore
#===================================================================
#持久化配置
org.quartz.jobStore.class:org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass:org.quartz.impl.jdbcjobstore.StdJDBCDelegate
org.quartz.jobStore.useProperties:false
#===================================================================
#havent cluster spring
#===================================================================
#叢集配置
org.quartz.jobStore.isClustered = false
#資料庫表字首
org.quartz.jobStore.tablePrefix:qrtz_
#===================================================================
# Configure Datasources
#===================================================================
#JDBC驅動 Sping去管理dataSource ，這裡不在配置資料來源資訊，如需要可以單獨配置資料來源
#org.quartz.dataSource.qzDS.driver:com.mysql.jdbc.Driver
#org.quartz.dataSource.qzDS.URL:jdbc:mysql://localhost:3306/quartz_test
#org.quartz.dataSource.qzDS.user:root
#org.quartz.dataSource.qzDS.password:root
#org.quartz.dataSource.qzDS.maxConnection:104. 整合Spring和Quartz
在applicationContext.xml檔案中新增
<bean id="customJobFactory" class="com.demo.job.CustomJobFactory"></bean>
<bean name="quartzScheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean" >
<property name="dataSource" ref ="dataSource" />
<!-- 可選，QuartzScheduler 啟動時更新己存在的Job，這樣就不用每次修改targetObject後刪除qrtz_job_details表對應記錄了 -->
<property name="overwriteExistingJobs" value="true" />
<!-- 必須的，QuartzScheduler 延時啟動，應用啟動完後 QuartzScheduler 再啟動 -->
<property name="startupDelay" value="2" />
<!-- 重要：customJobFactory 是為了解決Spring quartz Job不能依賴注入。 -->
<property name="jobFactory" ref="customJobFactory"></property>
<!-- applicationContextSchedulerContextKey：配置這個可以獲取spring容器中的context -->
<property name="applicationContextSchedulerContextKey" value="applicationContextKey"/>
<property name="configLocation" value="classpath:quartz.properties"/>
</bean>CustomJobFactory.java的程式碼如下：
package com.demo.job;
import org.quartz.spi.TriggerFiredBundle;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.scheduling.quartz.SpringBeanJobFactory;
public class CustomJobFactory extends SpringBeanJobFactory{
@Autowired
private AutowireCapableBeanFactory capableBeanFactory;
@Override
protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
//呼叫父類的方法
Object jobInstance = super.createJobInstance(bundle);
//進行注入
capableBeanFactory.autowireBean(jobInstance);
return jobInstance;
}
}5. 新增定時任務（作為示例service只寫了一個方法，介面就不寫了）
package com.demo.service.impl;
import java.util.Date;
import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.TriggerBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.demo.service.QuartzService;
@Service
public class QuartzServiceImpl implements QuartzService{
private static Logger _log = LoggerFactory.getLogger(QuartzServiceImpl.class);
@Autowired
private Scheduler quartzScheduler;
@Override
public void runOnce(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Class cls,
Object data) {
try {
// 獲取排程器
Scheduler sched = quartzScheduler;
// 建立一項作業
JobDetail job = JobBuilder.newJob(cls)
.withIdentity(jobName, jobGroupName).build();
// 傳入引數
job.getJobDataMap().put("data", data);
// 建立一個觸發器
SimpleTrigger trigger = TriggerBuilder.newTrigger()
.withIdentity(triggerName, triggerGroupName)
.withSchedule(SimpleScheduleBuilder
.simpleSchedule()
.withIntervalInSeconds(1)
//重複執行的次數，因為加入任務的時候馬上執行了，所以不需要重複，否則會多一次。
.withRepeatCount(0))
.build();
// 告訴排程器使用該觸發器來安排作業
sched.scheduleJob(job, trigger);
// 啟動
if (!sched.isShutdown()) {
sched.start();
_log.info("開始執行runOnce，時間：{}", new Date());
}
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}6. 定時任務，具體的業務邏輯
@Autowired注入，想資料庫中新增一條資料，需要配置customJobFactory，上邊有提到。
package com.demo.job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.quartz.QuartzJobBean;
import com.demo.common.result.AppResultConstant;
import com.demo.exception.AppException;
import com.demo.service.DiscountCouponService;
public class DiscountCouponJob extends QuartzJobBean{
private static Logger _log = LoggerFactory.getLogger(DiscountCouponJob.class);
@Autowired
private DiscountCouponService discountCouponService;
@Override
protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
Object object = context.getJobDetail().getJobDataMap().get("data");
if (!(object instanceof Integer)) {
_log.error("引數格式不正確，應為：Integer，實際傳參：{}", object);
throw new AppException(AppResultConstant.INVALID_DATA);
}
Integer userId = Integer.parseInt(object.toString());
discountCouponService.insertRegisterdiscountCoupon(userId);
_log.info("新增新手優惠券成功！userId：{}", userId);
}
}重點來了！！
如果你的專案中用到了shiro，專案是起不來的，初始化quartzScheduler這個bean錯誤，因為shiro-quartz預設是對Quartz1.6版本的實現，所以一直會報一下錯誤：
unknow column ‘IS_VOLATILE’ in ‘where clause’
因為高版本的Quartz，比如quartz-2.0.2以後的版本資料庫表結構變了，沒有IS_VOLATILE這個欄位了，所以要在shiro-quartz中排出對quartz的依賴，在pom.xml檔案中修改：
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-quartz</artifactId>
<version>${shiro.version}</version>
<!-- 解決shiro和quartz的衝突問題 -->
<exclusions>
<exclusion>
<groupId>org.opensymphony.quartz</groupId>
<artifactId>quartz</artifactId>
</exclusion>
</exclusions>
</dependency>總結：普通的Spring和Quartz的整合並不費時間，主要是專案中用到了Shiro，卡了一兩天。
實際上，在pom.xml檔案中看到shiro-quartz時我還有點疑問，但並沒有深究，但問題就出在細節上了。
下面貼出spring相關的jar包
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
<maven.compiler.compilerVersion>1.7</maven.compiler.compilerVersion>
<spring.version>4.3.7.RELEASE</spring.version>
<mybatis.version>3.4.2</mybatis.version>
<mybatis-spring.version>1.3.1</mybatis-spring.version>
<mybatis-pagehelper.version>5.0.1</mybatis-pagehelper.version>
<mybatis-generator.version>1.3.5</mybatis-generator.version>
<mybatis-ehcache.version>1.0.0</mybatis-ehcache.version>
<ehcache.version>2.10.0</ehcache.version>
<shiro.version>1.3.2</shiro.version>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
</dependency>
<!-- spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jms</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- spring security -->
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-web</artifactId>
<version>${spring-security.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-config</artifactId>
<version>${spring-security.version}</version>
</dependency>
<!--spring-session -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
<version>1.3.0.RELEASE</version>
</dependency>
<!-- quartz 任務排程 -->
<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>
<!-- shiro -->
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-core</artifactId>
<version>${shiro.version}</version>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-web</artifactId>
<version>${shiro.version}</version>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-quartz</artifactId>
<version>${shiro.version}</version>
<!-- 解決shiro和quartz的衝突問題 -->
<exclusions>
<exclusion>
<groupId>org.opensymphony.quartz</groupId>
<artifactId>quartz</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-spring</artifactId>
<version>${shiro.version}</version>
</dependency>
<!-- mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>${mybatis-spring.version}</version>
</dependency>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>${mybatis-pagehelper.version}</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version