盡可能的用聲明式處理軟件配置,其次才考慮編程式的方式。在上一篇《Quartz 框架快速入門(一)》中,如果我們要在 Job 啟動之后改變它的執行時間和頻度,必須去修改源代碼重新編譯。這種方式只適用于小的例子程序,但是對于一個大且復雜的系統,這就成了一個問題了。因此,假如能以聲明式部署 Quart Job 時,并且也是需求允許的情況下,你應該每次都選擇這種方式
·配置 quartz.properties 文件
文件 quartz.properties 定義了 Quartz 應用運行時行為,還包含了許多能控制 Quartz 運轉的屬性。這個文件應該放在classpath所指的路徑下,比如我們這個java工程,就將它和下面將介紹的jobs.xml一起放在項目根目錄下就是。如果不清楚就查看.classpath文件,它里面就配置了你的項目的classpath。
我們來看看最基礎的 quartz.properties 文件,并討論其中一些設置。下面是一個修剪版的 quartz.propertis文件
#============================================================================
# Configure Main Scheduler Properties
#============================================================================
org.quartz.scheduler.instanceName = TestScheduler
org.quartz.scheduler.instanceId = AUTO
#============================================================================
# Configure ThreadPool
#============================================================================
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount = 3
org.quartz.threadPool.threadPriority = 5
#============================================================================
# Configure JobStore
#============================================================================
org.quartz.jobStore.misfireThreshold = 60000
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore
#============================================================================
# Configure Plugins
#============================================================================
org.quartz.plugin.triggHistory.class = org.quartz.plugins.history.LoggingJobHistoryPlugin
org.quartz.plugin.jobInitializer.class = org.quartz.plugins.xml.JobInitializationPlugin
org.quartz.plugin.jobInitializer.fileNames = jobs.xml
org.quartz.plugin.jobInitializer.overWriteExistingJobs = true
org.quartz.plugin.jobInitializer.failOnFileNotFound = true
org.quartz.plugin.jobInitializer.scanInterval = 10
org.quartz.plugin.jobInitializer.wrapInUserTransaction = false
·調度器屬性
第一部分有兩行,分別設置調度器的實例名(instanceName) 和實例 ID (instanceId)。屬性 org.quartz.scheduler.instanceName 可以是你喜歡的任何字符串。它用來在用到多個調度器區分特定的調度器實例。多個調度器通常用在集群環境中。(Quartz 集群將會在第十一章,“Quartz 集群”中討論)。現在的話,設置如下的一個字符串就行:org.quartz.scheduler.instanceName = QuartzScheduler
實際上,這也是當你沒有該屬性配置時的默認值。
調度器的第二個屬性是 org.quartz.scheduler.instanceId。和 instaneName 屬性一樣,instanceId 屬性也允許任何字符串。這個值必須是在所有調度器實例中是唯一的,尤其是在一個集群當中。假如你想 Quartz 幫你生成這個值的話,可以設置為 AUTO。如果 Quartz 框架是運行在非集群環境中,那么自動產生的值將會是 NON_CLUSTERED。假如是在集群環境下使用 Quartz,這個值將會是主機名加上當前的日期和時間。大多情況下,設置為 AUTO 即可。
·線程池屬性
接下來的部分是設置有關線程必要的屬性值,這些線程在 Quartz 中是運行在后臺擔當重任的。threadCount 屬性控制了多少個工作者線程被創建用來處理 Job。原則上是,要處理的 Job 越多,那么需要的工作者線程也就越多。threadCount 的數值至少為 1。Quartz 沒有限定你設置工作者線程的最大值,但是在多數機器上設置該值超過100的話就會顯得相當不實用了,特別是在你的 Job 執行時間較長的情況下。這項沒有默認值,所以你必須為這個屬性設定一個值。
threadPriority 屬性設置工作者線程的優先級。優先級別高的線程比級別低的線程更優先得到執行。threadPriority 屬性的最大值是常量 java.lang.Thread.MAX_PRIORITY,等于10。最小值為常量 java.lang.Thread.MIN_PRIORITY,為1。這個屬性的正常值是 Thread.NORM_PRIORITY,為5。大多情況下,把它設置為5,這也是沒指定該屬性的默認值。
最后一個要設置的線程池屬性是 org.quartz.threadPool.class。這個值是一個實現了 org.quartz.spi.ThreadPool 接口的類的全限名稱。Quartz 自帶的線程池實現類是 org.quartz.smpl.SimpleThreadPool,它能夠滿足大多數用戶的需求。這個線程池實現具備簡單的行為,并經很好的測試過。它在調度器的生命周期中提供固定大小的線程池。你能根據需求創建自己的線程池實現,如果你想要一個隨需可伸縮的線程池時也許需要這么做。這個屬性沒有默認值,你必須為其指定值。
·作業存儲設置
作業存儲部分的設置描述了在調度器實例的生命周期中,Job 和 Trigger 信息是如何被存儲的。我們還沒有談論到作業存儲和它的目的;因為對當前例子是非必的,所以我們留待以后說明。現在的話,你所要了解的就是我們存儲調度器信息在內存中而不是在關系型數據庫中就行了。
把調度器信息存儲在內存中非常的快也易于配置。當調度器進程一旦被終止,所有的 Job 和 Trigger 的狀態就丟失了。要使 Job 存儲在內存中需通過設置 org.quartz.jobStrore.class 屬性為 org.quartz.simpl.RAMJobStore。假如我們不希望在 JVM 退出之后丟失調度器的狀態信息的話,我們可以使用關系型數據庫來存儲這些信息。這需要另一個作業存儲(JobStore) 實現,我們在后面將會討論到。第五章“Cron Trigger 和其他”和第六章“作業存儲和持久化”會提到你需要用到的不同類型的作業存儲實現。
·插件配置
在這個簡單的 quartz.properties 文件中最后一部分是你要用到的 Quart 插件的配置。插件常常在別的開源框架上使用到,比如 Apache 的 Struts 框架(見 http://struts.apache.org/)。
一個聲明式擴框架的方法就是通過新加實現了 org.quartz.spi.SchedulerPlugin 接口的類。SchedulerPlugin 接口中有給調度器調用的三個方法。
要在我們的例子中聲明式配置調度器信息,我們會用到一個 Quartz 自帶的叫做 org.quartz.plugins.xml.JobInitializationPlugin 的插件。
默認時,這個插件會在 classpath 中搜索名為 quartz_jobs.xml 的文件并從中加載 Job 和 Trigger 信息。在下下面中討論 quartz_jobs.xml 文件,這是我們所參考的非正式的 Job 定義文件。
·為插件修改 quartz.properties 配置
JobInitializationPlugin 找尋 quartz_jobs.xml 來獲得聲明的 Job 信息。假如你想改變這個文件名,你需要修改 quartz.properties 來告訴插件去加載那個文件。例如,假如你想要 Quartz 從名為 my_quartz_jobs.xml 的 XML 文件中加載 Job 信息,你不得不為插件指定這一文件
org.quartz.plugin.triggHistory.class = org.quartz.plugins.history.LoggingJobHistoryPlugin
org.quartz.plugin.jobInitializer.class = org.quartz.plugins.xml.JobInitializationPlugin
org.quartz.plugin.jobInitializer.fileNames = jobs.xml
org.quartz.plugin.jobInitializer.overWriteExistingJobs = true
org.quartz.plugin.jobInitializer.failOnFileNotFound = true
org.quartz.plugin.jobInitializer.scanInterval = 10
org.quartz.plugin.jobInitializer.wrapInUserTransaction = false
我們添加了屬性 org.quartz.plugin.jobInitializer.fileName 并設置該屬性值為我們想要的文件名。這個文件名要對 classloader 可見,也就是說要在 classpath 下。
當 Quartz 啟動后讀取 quartz.properties 文件,然后初始化插件。它會傳遞上面配置的所有屬性給插件,這時候插件也就得到通知去搜尋不同的文件。
下面就是目錄掃描例子的 Job 定義的 XML 文件。正如上一篇所示例子那樣,這里我們用的是聲明式途徑來配置 Job 和 Trigger 信息的
<?xml version='1.0' encoding='utf-8'?>
<quartz xmlns="http://www.opensymphony.com/quartz/JobSchedulingData"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opensymphony.com/quartz/JobSchedulingData
http://www.opensymphony.com/quartz/xml/job_scheduling_data_1_5.xsd"
version="1.5">
<job>
<job-detail>
<name>ScanDirectory</name>
<group>DEFAULT</group>
<description>
A job that scans a directory for files
</description>
<job-class>
com.vista.quartz.ScanDirectoryJob
</job-class>
<volatility>false</volatility>
<durability>false</durability>
<recover>false</recover>
<job-data-map allows-transient-data="true">
<entry>
<key>SCAN_DIR</key>
<value>D:\conf1</value>
</entry>
</job-data-map>
</job-detail>
<trigger>
<simple>
<name>scanTrigger</name>
<group>DEFAULT</group>
<job-name>ScanDirectory</job-name>
<job-group>DEFAULT</job-group>
<start-time>2008-09-03T14:43:00</start-time>
<!-- repeat indefinitely every 10 seconds -->
<repeat-count>-1</repeat-count>
<repeat-interval>10000</repeat-interval>
</simple>
</trigger>
</job>
</quartz>
在jobs.xml 中 <start-time> 的格式是:
<start-time>2008-09-03T14:43:00</start-time>
其中T隔開日期和時間,默認時區
或者:
<start-time>2008-09-03T14:43:00+08:00</start-time>
其中+08:00 表示東八區
<job> 元素描述了一個要注冊到調度器上的 Job,相當于我們在前面章節中使用 scheduleJob() 方法那樣。你所看到的<job-detail> 和 <trigger> 這兩個元素就是我們在代碼中以編程式傳遞給方法 schedulerJob() 的參數。前面本質上是與這里一樣的,只是現在用的是一種較流行聲明的方式。<trigger>元素也是非常直觀的:它使用前面同樣的屬性,但更簡單的建立一個 SimpleTrigger。因此僅僅是一種不同的(可論證的且更好的)方式做了上一篇代碼 中同樣的事情。顯然,你也可以支持多個 Job。在上一篇代碼 中我們編程的方式那么做的,也能用聲明的方式來支持
<?xml version='1.0' encoding='utf-8'?>
<quartz xmlns="http://www.opensymphony.com/quartz/JobSchedulingData"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opensymphony.com/quartz/JobSchedulingData
http://www.opensymphony.com/quartz/xml/job_scheduling_data_1_5.xsd"
version="1.5">
<job>
<job-detail>
<name>ScanDirectory1</name>
<group>DEFAULT</group>
<description>
A job that scans a directory for files
</description>
<job-class>
com.vista.quartz.ScanDirectoryJob
</job-class>
<volatility>false</volatility>
<durability>false</durability>
<recover>false</recover>
<job-data-map allows-transient-data="true">
<entry>
<key>SCAN_DIR</key>
<value>D:\dyk\Java\Tomcat\conf</value>
</entry>
</job-data-map>
</job-detail>
<trigger>
<simple>
<name>scanTrigger1</name>
<group>DEFAULT</group>
<job-name>ScanDirectory1</job-name>
<job-group>DEFAULT</job-group>
<start-time>2008-09-03T15:00:10</start-time>
<!-- repeat indefinitely every 10 seconds -->
<repeat-count>-1</repeat-count>
<repeat-interval>10000</repeat-interval>
</simple>
</trigger>
</job>
<job>
<job-detail>
<name>ScanDirectory2</name>
<group>DEFAULT</group>
<description>
A job that scans a directory for files
</description>
<job-class>
com.vista.quartz.ScanDirectoryJob
</job-class>
<volatility>false</volatility>
<durability>false</durability>
<recover>false</recover>
<job-data-map allows-transient-data="true">
<entry>
<key>SCAN_DIR</key>
<value>D:\dyk\Java\Tomcat\webapps\MyTest\WEB-INF</value>
</entry>
</job-data-map>
</job-detail>
<trigger>
<simple>
<name>scanTrigger2</name>
<group>DEFAULT</group>
<job-name>ScanDirectory2</job-name>
<job-group>DEFAULT</job-group>
<start-time>2008-09-03T15:00:20</start-time>
<!-- repeat indefinitely every 15 seconds -->
<repeat-count>-1</repeat-count>
<repeat-interval>15000</repeat-interval>
</simple>
</trigger>
</job>
</quartz>
最后我們來看看原來的代碼簡化成如何了:
package com.vista.quartz;
import java.util.Date;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.quartz.TriggerUtils;
import org.quartz.impl.StdSchedulerFactory;
public class SimpleScheduler
{
static Log logger = LogFactory.getLog(SimpleScheduler.class);
public static void main(String[] args)
{
SimpleScheduler simple = new SimpleScheduler();
try
{
// Create a Scheduler and schedule the Job
Scheduler scheduler = simple.createScheduler();
// Jobs can be scheduled after Scheduler is running
scheduler.start();
logger.info("Scheduler started at " + new Date());
}
catch (SchedulerException ex)
{
logger.error(ex);
}
}
public Scheduler createScheduler() throws SchedulerException
{//創建調度器
return StdSchedulerFactory.getDefaultScheduler();
}
}