quartz储存方式之JDBC JobStoreTX

这篇单单记录一下个人配置使用quartz的JDBC JobStoreTX的过程以及其中遇到的问题，这里的quartz是version2.2.1，数据库使用的MySQL。

JDBCJobStore储存是速度比较慢的，但是也不至于很坏，通过JDBCJobStore储存于数据库的方式适用于Oracle,PostgreSQL, mysql, MS SQLServer, HSQLDB, DB2等数据库。

1) 建表

在下载的文件的docs/dbTables目录下有对应建表语句，如果没有对应于应用的就自己改动来适应。这些个表都有"QRTZ"前缀，可以作为区别于别的命名。

2) 选定事务

如果你不需要绑定其他事务处理，你可以选择quartz的事务，其通过JobStoreTX来管理，这也是常用的选择，当然如果你要和你的应用容器一起管理，那你可以使用quartz的

JobStoreCMT，quartz通过JobStoreCMT来的使用来让你的应用容器管理quartz的事务。

3) 创建数据源

一个是提供一个connection，让quartz可以连接到数据库，另一个是提供的JNDI的方式，让quartz可以从所在容器中获取到。

使用JDBC连接方式(假设你使用的是StdSchedulerFactory)：

首先：
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
或者
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreCMT

这里当然选择JobStoreTX。

其次：
选定JDBC代理类，quartz里提供了StdJDBCDelegate，如果这个不能正常工作的，你可以选用其他代理类(在org.quar.impl.jdbcjobstore package或者其子包中可以找到)，包括DB2v6Delegate (for DB2 version 6 and earlier), HSQLDBDelegate (for HSQLDB),MSSQLDelegate (for Microsoft SQLServer), PostgreSQLDelegate (for PostgreSQL),
WeblogicDelegate (for using JDBC drivers made by WebLogic), OracleDelegate (for using oracle)等等。
并这样配置：
org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate

第三：
指定前缀
org.quartz.jobStore.tablePrefix = QRTZ_

第四：
指定数据源名称：
org.quartz.jobStore.dataSource = myDS

第五：定义ConnectionProvider的实现类

这里我找了一下，quartz提供了一个org.quartz.utils.PoolingConnectionProvider，于是，我就有了如下配置：

org.quartz.dataSource.myDS.connectionProvider.class:org.quartz.utils.PoolingConnectionProvider

第六：配置数据源属性

org.quartz.dataSource.myDS.driver: com.mysql.jdbc.Driver
org.quartz.dataSource.myDS.url: jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=utf-8
org.quartz.dataSource.myDS.user: root
org.quartz.dataSource.myDS.password: root
org.quartz.dataSource.myDS.maxConnections = 30

完事，使用最简单的一个例子来跑跑，可是报错了……

Caused by: Java.lang.InstantiationException: org.quartz.utils.PoolingConnectionProvider
at java.lang.Class.newInstance(Unknown Source)
at org.quartz.impl.StdSchedulerFactory.instantiate(StdSchedulerFactory.java:936)
... 3 more

跟了一下源码得到详细一点的原因：

ConnectionProvider cp = null;
                try {
                    cp = (ConnectionProvider) loadHelper.loadClass(cpClass).newInstance();
                } catch (Exception e) {
                    initException = new SchedulerException("ConnectionProvider class '" + cpClass
                            + "' could not be instantiated.", e);
                    throw initException;
                }

红色那行报的：

org.eclipse.debug.core.DebugException: com.sun.jdi.ClassNotLoadedException: Type has not been loaded occurred while retrieving component type of array.

百度了一把，没什么收获，看看文档，只说定义自己的这个类，但是为啥，也没有代码，为什么不告诉直接用上述的那个provider呢？

直接测试一下loadclass("org.quartz.utils.PoolingConnectionProvider");是没有问题的，那就是newInstance();的时候有问题咯。靠谱的还是JDK文档，立马去看一下，果然有收获：创建此Class 对象所表示的类的一个新实例。如同用一个带有一个空参数列表的 new 表达式实例化该类。如果该类尚未初始化，则初始化这个类。

如同空参数……

肯定是那个provider没有提供无参构造……再去看看呢，果然没有，好吧，我承认我懒了那么一丢丢。

那我再找找有没有其他的用于设置这个的吧，居然没有找到（估计没有找仔细），还是得定义一个自己的provider，没事，就参考这个provider，还是用C3P0来定义呗。

定义好后，来试试，果然顶用。以下是我的可运行代码：

quartz.properties

1. # Default Properties file for use by StdSchedulerFactory
2. # to create a Quartz Scheduler Instance, if a different
3. # properties file is not explicitly specified.
4. #
5. org.quartz.scheduler.instanceName: DefaultQuartzScheduler
6. org.quartz.scheduler.rmi.export: false
7. org.quartz.scheduler.rmi.proxy: false
8. org.quartz.scheduler.wrapJobExecutionInUserTransaction: false
9. org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
10. org.quartz.threadPool.threadCount: 10
11. org.quartz.threadPool.threadPriority: 5
12. org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: false
13. org.quartz.jobStore.misfireThreshold: 60000
14. org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX
15. org.quartz.jobStore.driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate
16. org.quartz.jobStore.tablePrefix: QRTZ_
17. org.quartz.jobStore.dataSource: myDS
18. org.quartz.dataSource.myDS.connectionProvider.class: org.quartz.examples.example17.MyPoolingconnectionProvider
19. org.quartz.dataSource.myDS.driver: com.mysql.jdbc.Driver
20. org.quartz.dataSource.myDS.url: jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=utf-8
21. org.quartz.dataSource.myDS.user: root
22. org.quartz.dataSource.myDS.password: root
23. org.quartz.dataSource.myDS.maxConnections： 30

MyPoolingconnectionProvider.java

1. package org.quartz.examples.example17;
2. import java.beans.PropertyVetoException;
3. import java.sql.Connection;
4. import java.sql.SQLException;
5. import org.quartz.SchedulerException;
6. import org.quartz.utils.ConnectionProvider;
7. import com.mchange.v2.c3p0.ComboPooledDataSource;
8. /**
9. *
10. * @author wz
11. *
12. */
13. public class MyPoolingconnectionProvider implements ConnectionProvider {
14. /** Default maximum number of database connections in the pool. */
15. public static final int DEFAULT_DB_MAX_CONNECTIONS = 10;
16. /** Default maximum number of database connections in the pool. */
17. public static final int DEFAULT_DB_MAX_CACHED_STATEMENTS_PER_CONNECTION = 120;
18. private String driver;
19. private String url;
20. private String user;
21. private String password;
22. private int maxConnections;
23. private int maxCachedStatementsPerConnection;
24. private int maxIdleSeconds;
25. private String validationQuery;
26. private int idleConnectionValidationSeconds;
27. private boolean validateOnCheckout;
28. private String discardIdleConnectionsSeconds;
29. private ComboPooledDataSource datasource;
30. /**
31. * 无参构造，必须要有[没有其他构造的话也可以不写]
32. */
33. public MyPoolingconnectionProvider() {
34. }
35. public Connection getConnection() throws SQLException {
36. return datasource.getConnection();
37. }
38. public void shutdown() throws SQLException {
39. datasource.close();
40. }
41. /**
42. * 初始化方法，应该在调用其setter后调用
43. */
44. public void initialize() throws SQLException {
45. if (this.url == null) {
46. throw new SQLException("DBPool could not be created: DB URL cannot be null");
47. }
48. if (this.driver == null) {
49. throw new SQLException("DBPool driver could not be created: DB driver class name cannot be null!");
50. }
51. if (this.maxConnections < 0) {
52. throw new SQLException("DBPool maxConnectins could not be created: Max connections must be greater than zero!");
53. }
54. datasource = new ComboPooledDataSource();
55. try {
56. datasource.setDriverClass(this.driver);
57. } catch (PropertyVetoException e) {
58. try {
59. throw new SchedulerException("Problem setting driver class name on datasource: " + e.getMessage(), e);
60. } catch (SchedulerException e1) {
61. }
62. }
63. datasource.setJdbcUrl(this.url);
64. datasource.setUser(this.user);
65. datasource.setPassword(this.password);
66. datasource.setMaxPoolSize(this.maxConnections);
67. datasource.setMinPoolSize(1);
68. datasource.setMaxIdleTime(maxIdleSeconds);
69. datasource.setMaxStatementsPerConnection(this.maxCachedStatementsPerConnection);
70. if (this.validationQuery != null) {
71. datasource.setPreferredTestQuery(this.validationQuery);
72. if (!validateOnCheckout)
73. datasource.setTestConnectionOnCheckin(true);
74. else
75. datasource.setTestConnectionOnCheckout(true);
76. datasource.setIdleConnectionTestPeriod(this.idleConnectionValidationSeconds);
77. }
78. }
79. /*-------------------------------------------------
80. *
81. * setters 如果有必要，你可以添加一些getter
82. * ------------------------------------------------
83. */
84. public void setDriver(String driver) {
85. this.driver = driver;
86. }
87. public void setUrl(String url) {
88. this.url = url;
89. }
90. public void setUser(String user) {
91. this.user = user;
92. }
93. public void setPassword(String password) {
94. this.password = password;
95. }
96. public void setMaxConnections(int maxConnections) {
97. this.maxConnections = maxConnections;
98. }
99. public void setMaxCachedStatementsPerConnection(int maxCachedStatementsPerConnection) {
100. this.maxCachedStatementsPerConnection = maxCachedStatementsPerConnection;
101. }
102. public void setMaxIdleSeconds(int maxIdleSeconds) {
103. this.maxIdleSeconds = maxIdleSeconds;
104. }
105. public void setValidationQuery(String validationQuery) {
106. this.validationQuery = validationQuery;
107. }
108. public void setIdleConnectionValidationSeconds(int idleConnectionValidationSeconds) {
109. this.idleConnectionValidationSeconds = idleConnectionValidationSeconds;
110. }
111. public void setValidateOnCheckout(boolean validateOnCheckout) {
112. this.validateOnCheckout = validateOnCheckout;
113. }
114. public void setDiscardIdleConnectionsSeconds(String discardIdleConnectionsSeconds) {
115. this.discardIdleConnectionsSeconds = discardIdleConnectionsSeconds;
116. }
117. public void setDatasource(ComboPooledDataSource datasource) {
118. this.datasource = datasource;
119. }
120. protected ComboPooledDataSource getDataSource() {
121. return datasource;
122. }
123. }

SimpleExample.java

1. package org.quartz.examples.example17;
2. import java.util.Date;
3. import org.quartz.DateBuilder;
4. import org.quartz.JobBuilder;
5. import org.quartz.JobDetail;
6. import org.quartz.Scheduler;
7. import org.quartz.SchedulerFactory;
8. import org.quartz.TriggerBuilder;
9. import org.quartz.impl.StdSchedulerFactory;
10. import org.quartz.impl.triggers.SimpleTriggerImpl;
11. import org.slf4j.Logger;
12. import org.slf4j.LoggerFactory;
13. public class SimpleExample
14. {
15. public void run()
16. throws Exception
17. {
18. Logger log = LoggerFactory.getLogger(SimpleExample.class);
19. log.info("------- Initializing ----------------------");
20. //通过调度器工厂获取调度器，初始化工程时须指定其使用我们自己的配置文件
21. SchedulerFactory sf = new StdSchedulerFactory("org/quartz/examples/example17/quartz.properties");
22. Scheduler sched = sf.getScheduler();
23. //这儿clear一下，因为使用数据库储存方式时，shutdown的时候没有清除，第二次运行会报Job is already exist
24. sched.clear();
25. log.info("------- Initialization Complete -----------");
26. Date runTime = DateBuilder.evenMinuteDate(new Date());
27. log.info("------- Scheduling Job  -------------------");
28. //创建任务详情
29. JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();
30. //创建触发器
31. SimpleTriggerImpl trigger = (SimpleTriggerImpl)TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").startAt(new Date()).build();
32. trigger.setRepeatCount(5);
33. trigger.setRepeatInterval(3000);
34. log.info("------- Starttime =  "+trigger.getStartTime()+" -----------------");
35. //调度器、触发器、任务，三者关联
36. sched.scheduleJob(job, trigger);
37. log.info(job.getKey() + " will run at: " + runTime);
38. //调度启动
39. sched.start();
40. log.info("------- Started Scheduler -----------------");
41. log.info("------- Waiting 1 minute... -------------");
42. try
43. {
44. Thread.sleep(60000L);
45. }
46. catch (Exception e)
47. {
48. }
49. log.info("------- Shutting Down ---------------------");
50. //调度关闭
51. sched.shutdown(true);
52. log.info("------- Shutdown Complete -----------------");
53. }
54. public static void main(String[] args) throws Exception
55. {
56. SimpleExample example = new SimpleExample();
57. example.run();
58. }
59. }

当然，运行example之前，得先添加mysql的driver的包，然后在mysql里建立一个叫“quartz”的database，并将docs/dbTables下的tables_mysql.sql脚本运行一下以建表。

注意：

1) org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX，这个配置在这儿当然是用这个，

而org.quartz.jobStore.driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate则根据你的数据，通常使用当前这个，如果这个不适用就去quartz里org.quar.impl.jdbcjobstore包或其子包下找找，如还是未能满足需求，就自己实现一个。

2) org.quartz.jobStore.tablePrefix: QRTZ_，这个是quartz默认的，tables_mysql.sql以及一些其他操作（比如clear等）的代码都这样写了，所以就不要去修改了。

3) org.quartz.jobStore.dataSource: myDS这个的“键”必须是org.quartz.jobStore.dataSource，而“值”随你取，但必须有。

4) dataSource的属性配置，如下几个（可以自己添加其他的对应修改provider）：

1. org.quartz.dataSource.myDS.connectionProvider.class: org.quartz.examples.example17.MyPoolingconnectionProvider
2. org.quartz.dataSource.myDS.driver: com.mysql.jdbc.Driver
3. org.quartz.dataSource.myDS.url: jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=utf-8
4. org.quartz.dataSource.myDS.user: root
5. org.quartz.dataSource.myDS.password: root
6. org.quartz.dataSource.myDS.maxConnections: 30

它们的“键”必须是

1. org.quartz.dataSource."+yourdatasourcename+"."+yourProvider#datamembername

原因如下：

1. String[] dsNames = cfg.getPropertyGroups(PROP_DATASOURCE_PREFIX);
2. for (int i = 0; i < dsNames.length; i++) {
3. PropertiesParser pp = new PropertiesParser(cfg.getPropertyGroup(
4. PROP_DATASOURCE_PREFIX + "." + dsNames[i], true));
5. String cpClass = pp.getStringProperty(PROP_CONNECTION_PROVIDER_CLASS, null);
6. // custom connectionProvider...
7. if(cpClass != null) {
8. ConnectionProvider cp = null;
9. try {
10. cp = (ConnectionProvider) loadHelper.loadClass(cpClass).newInstance();
11. } catch (Exception e) {
12. initException = new SchedulerException("ConnectionProvider class '" + cpClass
13. + "' could not be instantiated.", e);
14. throw initException;
15. }
16. try {
17. // remove the class name, so it isn't attempted to be set
18. pp.getUnderlyingProperties().remove(
19. PROP_CONNECTION_PROVIDER_CLASS);
20. setBeanProps(cp, pp.getUnderlyingProperties());
21. cp.initialize();
22. } catch (Exception e) {
23. initException = new SchedulerException("ConnectionProvider class '" + cpClass
24. + "' props could not be configured.", e);
25. throw initException;
26. }
27. dbMgr = DBConnectionManager.getInstance();
28. dbMgr.addConnectionProvider(dsNames[i], cp);
29. }