本文在提供完整代碼示例，可見 https://github.com/YunaiV/SpringBoot-Labs 的 lab-28 目錄。

原創(chuàng)不易，給點個 Star 嘿，一起沖鴨！

1. 概述

在產(chǎn)品的色彩斑斕的黑的需求中，有存在一類需求，是需要去定時執(zhí)行的，此時就需要使用到定時任務。例如說，每分鐘掃描超時支付的訂單，每小時清理一次日志文件，每天統(tǒng)計前一天的數(shù)據(jù)并生成報表，每個月月初的工資單的推送，每年一次的生日提醒等等。

其中，艿艿最喜歡“每個月月初的工資單的推送”，你呢？

在 JDK 中，內置了兩個類，可以實現(xiàn)定時任務的功能：

• java.util.Timer?：可以通過創(chuàng)建?java.util.TimerTask?調度任務，在同一個線程中串行執(zhí)行，相互影響。也就是說，對于同一個 Timer 里的多個 TimerTask 任務，如果一個 TimerTask 任務在執(zhí)行中，其它 TimerTask 即使到達執(zhí)行的時間，也只能排隊等待。因為 Timer 是串行的，同時存在 坑坑 ，所以后來 JDK 又推出了 ScheduledExecutorService ，Timer 也基本不再使用。

• java.util.concurrent.ScheduledExecutorService?：在 JDK 1.5 新增，基于線程池設計的定時任務類，每個調度任務都會被分配到線程池中并發(fā)執(zhí)行，互不影響。這樣，ScheduledExecutorService 就解決了 Timer 串行的問題。

在日常開發(fā)中，我們很少直接使用 Timer 或 ScheduledExecutorService 來實現(xiàn)定時任務的需求。主要有幾點原因：

• 它們僅支持按照指定頻率，不直接支持指定時間的定時調度，需要我們結合 Calendar 自行計算，才能實現(xiàn)復雜時間的調度。例如說，每天、每周五、2019-11-11 等等。

• 它們是進程級別，而我們?yōu)榱藢崿F(xiàn)定時任務的高可用，需要部署多個進程。此時需要等多考慮，多個進程下，同一個任務在相同時刻，不能重復執(zhí)行。

• 項目可能存在定時任務較多，需要統(tǒng)一的管理，此時不得不進行二次封裝。

所以，一般情況下，我們會選擇專業(yè)的調度任務中間件。

關于“任務”的叫法，也有叫“作業(yè)”的。在英文上，有 Task 也有 Job 。本質是一樣的，本文兩種都會用。

然后，一般來說是調度任務，定時執(zhí)行。所以胖友會在本文，或者其它文章中，會看到“調度”或“定時”的字眼兒。

在 Spring 體系中，內置了兩種定時任務的解決方案：

• 第一種，Spring Framework 的 Spring Task 模塊，提供了輕量級的定時任務的實現(xiàn)。

• 第二種，Spring Boot 2.0 版本，整合了 Quartz 作業(yè)調度框架，提供了功能強大的定時任務的實現(xiàn)。

  注：Spring Framework 已經(jīng)內置了 Quartz 的整合。Spring Boot 1.X 版本未提供 Quartz 的自動化配置，而 2.X 版本提供了支持。

在 Java 生態(tài)中，還有非常多優(yōu)秀的開源的調度任務中間件：

• Elastic-Job

  唯品會基于 Elastic-Job 之上，演化出了 Saturn 項目。

• Apache DolphinScheduler

• XXL-JOB

目前國內采用 Elastic-Job 和 XXL-JOB 為主。從艿艿了解到的情況，使用 XXL-JOB 的團隊會更多一些，主要是上手較為容易，運維功能更為完善。

本文，我們會按照 Spring Task、Quartz、XXL-JOB 的順序，進行分別入門。而在文章的結尾，會簡單聊聊分布式定時任務的實現(xiàn)原理。

2. 快速入門 Spring Task

示例代碼對應倉庫：lab-28-task-demo 。

考慮到實際場景下，我們很少使用 Spring Task ，所以本小節(jié)會寫的比較簡潔。如果對 Spring Task 比較感興趣的胖友，可以自己去閱讀 《Spring Framework Documentation —— Task Execution and Scheduling》 文檔，里面有 Spring Task 相關的詳細文檔。

在本小節(jié)，我們會使用 Spring Task 功能，實現(xiàn)一個每 2 秒打印一行執(zhí)行日志的定時任務。

2.1 引入依賴

在?pom.xml?文件中，引入相關依賴。

<?xml?version="1.0"?encoding="UTF-8"?> <project?xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0?http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.1.RELEASE</version><relativePath/>?<!--?lookup?parent?from?repository?--></parent><modelVersion>4.0.0</modelVersion><artifactId>lab-28-task-demo</artifactId><dependencies><!--?實現(xiàn)對?Spring?MVC?的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency></dependencies></project>

因為 Spring Task 是 Spring Framework 的模塊，所以在我們引入?spring-boot-starter-web?依賴后，無需特別引入它。

同時，考慮到我們希望讓項目啟動時，不自動結束 JVM 進程，所以我們引入了?spring-boot-starter-web?依賴。

2.2 ScheduleConfiguration

在?cn.iocoder.springboot.lab28.task.config?包路徑下，創(chuàng)建 ScheduleConfiguration 類，配置 Spring Task 。代碼如下：

//?ScheduleConfiguration.java@Configuration @EnableScheduling public?class?ScheduleConfiguration?{ }

• 在類上，添加?@EnableScheduling?注解，啟動 Spring Task 的定時任務調度的功能。

2.3 DemoJob

在?cn.iocoder.springboot.lab28.task.job?包路徑下，創(chuàng)建 DemoJob 類，示例定時任務類。代碼如下：

//?DemoJob.java@Component public?class?DemoJob?{private?Logger?logger?=?LoggerFactory.getLogger(getClass());private?final?AtomicInteger?counts?=?new?AtomicInteger();@Scheduled(fixedRate?=?2000)public?void?execute()?{logger.info("[execute][定時第?({})?次執(zhí)行]",?counts.incrementAndGet());}}

• 在類上，添加?@Component?注解，創(chuàng)建 DemoJob Bean 對象。

• 創(chuàng)建?#execute()?方法，實現(xiàn)打印日志。同時，在該方法上，添加?@Scheduled?注解，設置每 2 秒執(zhí)行該方法。

雖然說，@Scheduled?注解，可以添加在一個類上的多個方法上，但是艿艿的個人習慣上，還是一個 Job 類，一個定時任務。😈

2.4 Application

創(chuàng)建?Application.java?類，配置?@SpringBootApplication?注解即可。代碼如下：

@SpringBootApplication public?class?Application?{public?static?void?main(String[]?args)?{SpringApplication.run(Application.class,?args);}}

運行 Application 類，啟動示例項目。輸出日志精簡如下：

#?初始化一個?ThreadPoolTaskScheduler?任務調度器 2019-11-30?18:02:58.415??INFO?83730?---?[???????????main]?o.s.s.c.ThreadPoolTaskScheduler??????????:?Initializing?ExecutorService?'taskScheduler'#?每?2?秒，執(zhí)行一次?DemoJob?的任務 2019-11-30?18:02:58.449??INFO?83730?---?[?pikaqiu-demo-1]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(1)?次執(zhí)行] 2019-11-30?18:03:00.438??INFO?83730?---?[?pikaqiu-demo-1]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(2)?次執(zhí)行] 2019-11-30?18:03:02.442??INFO?83730?---?[?pikaqiu-demo-2]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(3)?次執(zhí)行]

• 通過日志，我們可以看到，初始化一個 ThreadPoolTaskScheduler 任務調度器。之后，每 2 秒，執(zhí)行一次 DemoJob 的任務。

至此，我們已經(jīng)完成了 Spring Task 調度任務功能的入門。實際上，Spring Task 還提供了異步任務 ，這個我們在其它文章中，詳細講解。

下面「2.5 @Scheduled」和「2.6 應用配置文件」兩個小節(jié)，是補充知識，建議看看。

2.5 @Scheduled

@Scheduled?注解，設置定時任務的執(zhí)行計劃。

常用屬性如下：

• cron?屬性：Spring Cron 表達式。例如說，"0 0 12 * * ?"?表示每天中午執(zhí)行一次，"11 11 11 11 11 ?"?表示 11 月 11 號 11 點 11 分 11 秒執(zhí)行一次（哈哈哈）。更多示例和講解，可以看看 《Spring Cron 表達式》 文章。注意，以調用完成時刻為開始計時時間。

• fixedDelay?屬性：固定執(zhí)行間隔，單位：毫秒。注意，以調用完成時刻為開始計時時間。

• fixedRate?屬性：固定執(zhí)行間隔，單位：毫秒。注意，以調用開始時刻為開始計時時間。

• 這三個屬性，有點雷同，可以看看 《@Scheduled 定時任務的fixedRate、fixedDelay、cron 的區(qū)別》 ，一定要分清楚差異。

不常用屬性如下：

• initialDelay?屬性：初始化的定時任務執(zhí)行延遲，單位：毫秒。

• zone?屬性：解析 Spring Cron 表達式的所屬的時區(qū)。默認情況下，使用服務器的本地時區(qū)。

• initialDelayString?屬性：initialDelay?的字符串形式。

• fixedDelayString?屬性：fixedDelay?的字符串形式。

• fixedRateString?屬性：fixedRate?的字符串形式。

2.6 應用配置文件

在?application.yml?中，添加 Spring Task 定時任務的配置，如下：

spring:task:#?Spring?Task?調度任務的配置，對應?TaskSchedulingProperties?配置類scheduling:thread-name-prefix:?pikaqiu-demo-?#?線程池的線程名的前綴。默認為?scheduling-?，建議根據(jù)自己應用來設置pool:size:?10?#?線程池大小。默認為?1?，根據(jù)自己應用來設置shutdown:await-termination:?true?#?應用關閉時，是否等待定時任務執(zhí)行完成。默認為?false?，建議設置為?trueawait-termination-period:?60?#?等待任務完成的最大時長，單位為秒。默認為?0?，根據(jù)自己應用來設置

• 在?spring.task.scheduling?配置項，Spring Task 調度任務的配置，對應 TaskSchedulingProperties 配置類。

• Spring Boot TaskSchedulingAutoConfiguration 自動化配置類，實現(xiàn) Spring Task 的自動配置，創(chuàng)建 ThreadPoolTaskScheduler 基于線程池的任務調度器。本質上，ThreadPoolTaskScheduler 是基于 ScheduledExecutorService 的封裝，增強在調度時間上的功能。

注意，spring.task.scheduling.shutdown?配置項，是為了實現(xiàn) Spring Task 定時任務的優(yōu)雅關閉。我們想象一下，如果定時任務在執(zhí)行的過程中，如果應用開始關閉，把定時任務需要使用到的 Spring Bean 進行銷毀，例如說數(shù)據(jù)庫連接池，那么此時定時任務還在執(zhí)行中，一旦需要訪問數(shù)據(jù)庫，可能會導致報錯。

• 所以，通過配置?await-termination = true?，實現(xiàn)應用關閉時，等待定時任務執(zhí)行完成。這樣，應用在關閉的時，Spring 會優(yōu)先等待 ThreadPoolTaskScheduler 執(zhí)行完任務之后，再開始 Spring Bean 的銷毀。

• 同時，又考慮到我們不可能無限等待定時任務全部執(zhí)行結束，因此可以配置?await-termination-period = 60?，等待任務完成的最大時長，單位為秒。具體設置多少的等待時長，可以根據(jù)自己應用的需要。

3. 快速入門 Quartz 單機

示例代碼對應倉庫：lab-28-task-quartz-memory 。

在艿艿最早開始實習的時候，公司使用 Quartz 作為任務調度中間件。考慮到我們要實現(xiàn)定時任務的高可用，需要部署多個 JVM 進程。比較舒服的是，Quartz 自帶了集群方案。它通過將作業(yè)信息存儲到關系數(shù)據(jù)庫中，并使用關系數(shù)據(jù)庫的行鎖來實現(xiàn)執(zhí)行作業(yè)的競爭，從而保證多個進程下，同一個任務在相同時刻，不能重復執(zhí)行。

可能很多胖友對 Quartz 還不是很了解，我們先來看一段簡介：

FROM https://www.oschina.net/p/quartz

Quartz 是一個開源的作業(yè)調度框架，它完全由 Java 寫成，并設計用于 J2SE 和 J2EE 應用中。它提供了巨大的靈活性而不犧牲簡單性。你能夠用它來為執(zhí)行一個作業(yè)而創(chuàng)建簡單的或復雜的調度。

它有很多特征，如：數(shù)據(jù)庫支持，集群，插件，EJB 作業(yè)預構建，JavaMail 及其它，支持 cron-like 表達式等等。

在 Quartz 體系結構中，有三個組件非常重要：

• Scheduler ：調度器

• Trigger ：觸發(fā)器

• Job ：任務

不了解的胖友，可以直接看看 《Quartz 入門詳解》 文章。這里，艿艿就不重復贅述。

FROM https://medium.com/@ChamithKodikara/spring-boot-2-quartz-2-scheduler-integration-a8eaaf850805

Quartz 整體架構圖

Quartz 分成單機模式和集群模式。

• 本小節(jié)，我們先來學習下 Quartz 的單機模式，入門比較快。

• 下一下「5. 再次入門 Quartz 集群」 ，我們再來學習下 Quartz 的集群模式。在生產(chǎn)環(huán)境下，一定一定一定要使用 Quartz 的集群模式，保證定時任務的高可用。

😈 下面，讓我們開始遨游~

3.1 引入依賴

在?pom.xml?文件中，引入相關依賴。

<?xml?version="1.0"?encoding="UTF-8"?> <project?xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0?http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.1.RELEASE</version><relativePath/>?<!--?lookup?parent?from?repository?--></parent><modelVersion>4.0.0</modelVersion><artifactId>lab-28-task-quartz-memory</artifactId><dependencies><!--?實現(xiàn)對?Spring?MVC?的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--?實現(xiàn)對?Quartz?的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-quartz</artifactId></dependency></dependencies></project>

具體每個依賴的作用，胖友自己認真看下艿艿添加的所有注釋噢。

3.2 示例 Job

在?cn.iocoder.springboot.lab28.task.config.job?包路徑下，我們來創(chuàng)建示例 Job 。

創(chuàng)建 DemoJob01 類，示例定時任務 01 類。代碼如下：

//?DemoJob01.javapublic?class?DemoJob01?extends?QuartzJobBean?{private?Logger?logger?=?LoggerFactory.getLogger(getClass());private?final?AtomicInteger?counts?=?new?AtomicInteger();@Autowiredprivate?DemoService?demoService;@Overrideprotected?void?executeInternal(JobExecutionContext?context)?throws?JobExecutionException?{logger.info("[executeInternal][定時第?({})?次執(zhí)行,?demoService?為?({})]",?counts.incrementAndGet(),demoService);}}

• 繼承 QuartzJobBean 抽象類，實現(xiàn)?#executeInternal(JobExecutionContext context)?方法，執(zhí)行自定義的定時任務的邏輯。

• QuartzJobBean 實現(xiàn)了?org.quartz.Job?接口，提供了 Quartz 每次創(chuàng)建 Job 執(zhí)行定時邏輯時，將該 Job Bean 的依賴屬性注入。例如說，DemoJob01 需要?@Autowired?注入的?demoService?屬性。核心代碼如下：

  //?QuartzJobBean.javapublic?final?void?execute(JobExecutionContext?context)?throws?JobExecutionException?{try?{//?將當前對象，包裝成?BeanWrapper?對象BeanWrapper?bw?=?PropertyAccessorFactory.forBeanPropertyAccess(this);//?設置屬性到?bw?中MutablePropertyValues?pvs?=?new?MutablePropertyValues();pvs.addPropertyValues(context.getScheduler().getContext());pvs.addPropertyValues(context.getMergedJobDataMap());bw.setPropertyValues(pvs,?true);}?catch?(SchedulerException?ex)?{throw?new?JobExecutionException(ex);}//?執(zhí)行提供給子類實現(xiàn)的抽象方法this.executeInternal(context); }protected?abstract?void?executeInternal(JobExecutionContext?context)?throws?JobExecutionException;

  • 這樣一看，是不是清晰很多。不要懼怕中間件的源碼，好奇哪個類或者方法，就點進去看看。反正，又不花錢。

• counts?屬性，計數(shù)器。用于我們后面我們展示，每次 DemoJob01 都會被 Quartz 創(chuàng)建出一個新的 Job 對象，執(zhí)行任務。這個很重要，也要非常小心。

創(chuàng)建 DemoJob02 類，示例定時任務 02 類。代碼如下：

//?DemoJob02.javapublic?class?DemoJob02?extends?QuartzJobBean?{private?Logger?logger?=?LoggerFactory.getLogger(getClass());@Overrideprotected?void?executeInternal(JobExecutionContext?context)?throws?JobExecutionException?{logger.info("[executeInternal][我開始的執(zhí)行了]");}}

• 比較簡單，為了后面演示案例之用。

3.3 ScheduleConfiguration

在?cn.iocoder.springboot.lab28.task.config?包路徑下，創(chuàng)建 ScheduleConfiguration 類，配置上述的兩個示例 Job 。代碼如下：

//?ScheduleConfiguration.java@Configuration public?class?ScheduleConfiguration?{public?static?class?DemoJob01Configuration?{@Beanpublic?JobDetail?demoJob01()?{return?JobBuilder.newJob(DemoJob01.class).withIdentity("demoJob01")?//?名字為?demoJob01.storeDurably()?//?沒有?Trigger?關聯(lián)的時候任務是否被保留。因為創(chuàng)建?JobDetail?時，還沒?Trigger?指向它，所以需要設置為?true?，表示保留。.build();}@Beanpublic?Trigger?demoJob01Trigger()?{//?簡單的調度計劃的構造器SimpleScheduleBuilder?scheduleBuilder?=?SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5)?//?頻率。.repeatForever();?//?次數(shù)。//?Trigger?構造器return?TriggerBuilder.newTrigger().forJob(demoJob01())?//?對應?Job?為?demoJob01.withIdentity("demoJob01Trigger")?//?名字為?demoJob01Trigger.withSchedule(scheduleBuilder)?//?對應?Schedule?為?scheduleBuilder.build();}}public?static?class?DemoJob02Configuration?{@Beanpublic?JobDetail?demoJob02()?{return?JobBuilder.newJob(DemoJob02.class).withIdentity("demoJob02")?//?名字為?demoJob02.storeDurably()?//?沒有?Trigger?關聯(lián)的時候任務是否被保留。因為創(chuàng)建?JobDetail?時，還沒?Trigger?指向它，所以需要設置為?true?，表示保留。.build();}@Beanpublic?Trigger?demoJob02Trigger()?{//?基于?Quartz?Cron?表達式的調度計劃的構造器CronScheduleBuilder?scheduleBuilder?=?CronScheduleBuilder.cronSchedule("0/10?*?*?*?*???*");//?Trigger?構造器return?TriggerBuilder.newTrigger().forJob(demoJob02())?//?對應?Job?為?demoJob02.withIdentity("demoJob02Trigger")?//?名字為?demoJob02Trigger.withSchedule(scheduleBuilder)?//?對應?Schedule?為?scheduleBuilder.build();}}}

• 內部創(chuàng)建了 DemoJob01Configuration 和 DemoJob02Configuration 兩個配置類，分別配置 DemoJob01 和 DemoJob02 兩個 Quartz Job 。

• ==========?DemoJob01Configuration?==========

• #demoJob01()?方法，創(chuàng)建 DemoJob01 的 JobDetail Bean 對象。

• #demoJob01Trigger()?方法，創(chuàng)建 DemoJob01 的 Trigger Bean 對象。其中，我們使用 SimpleScheduleBuilder 簡單的調度計劃的構造器，創(chuàng)建了每 5 秒執(zhí)行一次，無限重復的調度計劃。

• ==========?DemoJob2Configuration?==========

• #demoJob2()?方法，創(chuàng)建 DemoJob02 的 JobDetail Bean 對象。

• #demoJob02Trigger()?方法，創(chuàng)建 DemoJob02 的 Trigger Bean 對象。其中，我們使用 CronScheduleBuilder 基于 Quartz Cron 表達式的調度計劃的構造器，創(chuàng)建了每第?10 秒執(zhí)行一次的調度計劃。這里，推薦一個 Quartz/Cron/Crontab 表達式在線生成工具 ，方便幫我們生成 Quartz Cron 表達式，并計算出最近 5 次運行時間。

😈 因為 JobDetail 和 Trigger 一般是成雙成對出現(xiàn)，所以艿艿習慣配置成一個 Configuration 配置類。

3.4 Application

創(chuàng)建?Application.java?類，配置?@SpringBootApplication?注解即可。代碼如下：

@SpringBootApplication public?class?Application?{public?static?void?main(String[]?args)?{SpringApplication.run(Application.class,?args);}}

運行 Application 類，啟動示例項目。輸出日志精簡如下：

#?創(chuàng)建了?Quartz?QuartzScheduler?并啟動 2019-11-30?23:40:05.123??INFO?92812?---?[???????????main]?org.quartz.impl.StdSchedulerFactory??????:?Using?default?implementation?for?ThreadExecutor 2019-11-30?23:40:05.130??INFO?92812?---?[???????????main]?org.quartz.core.SchedulerSignalerImpl????:?Initialized?Scheduler?Signaller?of?type:?class?org.quartz.core.SchedulerSignalerImpl 2019-11-30?23:40:05.130??INFO?92812?---?[???????????main]?org.quartz.core.QuartzScheduler??????????:?Quartz?Scheduler?v.2.3.2?created. 2019-11-30?23:40:05.131??INFO?92812?---?[???????????main]?org.quartz.simpl.RAMJobStore?????????????:?RAMJobStore?initialized. 2019-11-30?23:40:05.132??INFO?92812?---?[???????????main]?org.quartz.core.QuartzScheduler??????????:?Scheduler?meta-data:?Quartz?Scheduler?(v2.3.2)?'quartzScheduler'?with?instanceId?'NON_CLUSTERED'Scheduler?class:?'org.quartz.core.QuartzScheduler'?-?running?locally.NOT?STARTED.Currently?in?standby?mode.Number?of?jobs?executed:?0Using?thread?pool?'org.quartz.simpl.SimpleThreadPool'?-?with?10?threads.Using?job-store?'org.quartz.simpl.RAMJobStore'?-?which?does?not?support?persistence.?and?is?not?clustered.2019-11-30?23:40:05.132??INFO?92812?---?[???????????main]?org.quartz.impl.StdSchedulerFactory??????:?Quartz?scheduler?'quartzScheduler'?initialized?from?an?externally?provided?properties?instance. 2019-11-30?23:40:05.132??INFO?92812?---?[???????????main]?org.quartz.impl.StdSchedulerFactory??????:?Quartz?scheduler?version:?2.3.2 2019-11-30?23:40:05.132??INFO?92812?---?[???????????main]?org.quartz.core.QuartzScheduler??????????:?JobFactory?set?to:?org.springframework.scheduling.quartz.SpringBeanJobFactory@203dd56b 2019-11-30?23:40:05.158??INFO?92812?---?[???????????main]?o.s.s.quartz.SchedulerFactoryBean????????:?Starting?Quartz?Scheduler?now 2019-11-30?23:40:05.158??INFO?92812?---?[???????????main]?org.quartz.core.QuartzScheduler??????????:?Scheduler?quartzScheduler_$_NON_CLUSTERED?started.#?DemoJob01 2019-11-30?23:40:05.164??INFO?92812?---?[eduler_Worker-1]?c.i.springboot.lab28.task.job.DemoJob01??:?[executeInternal][定時第?(1)?次執(zhí)行,?demoService?為?(cn.iocoder.springboot.lab28.task.service.DemoService@23d75d74)] 2019-11-30?23:40:09.866??INFO?92812?---?[eduler_Worker-2]?c.i.springboot.lab28.task.job.DemoJob01??:?[executeInternal][定時第?(1)?次執(zhí)行,?demoService?為?(cn.iocoder.springboot.lab28.task.service.DemoService@23d75d74)] 2019-11-30?23:40:14.865??INFO?92812?---?[eduler_Worker-4]?c.i.springboot.lab28.task.job.DemoJob01??:?[executeInternal][定時第?(1)?次執(zhí)行,?demoService?為?(cn.iocoder.springboot.lab28.task.service.DemoService@23d75d74)]#?DemoJob02 2019-11-30?23:40:10.004??INFO?92812?---?[eduler_Worker-3]?c.i.springboot.lab28.task.job.DemoJob02??:?[executeInternal][我開始的執(zhí)行了] 2019-11-30?23:40:20.001??INFO?92812?---?[eduler_Worker-6]?c.i.springboot.lab28.task.job.DemoJob02??:?[executeInternal][我開始的執(zhí)行了] 2019-11-30?23:40:30.002??INFO?92812?---?[eduler_Worker-9]?c.i.springboot.lab28.task.job.DemoJob02??:?[executeInternal][我開始的執(zhí)行了]

• 項目啟動時，會創(chuàng)建了 Quartz QuartzScheduler 并啟動。

• 考慮到閱讀日志方便，艿艿這里把 DemoJob01 和 DemoJob02 的日志分開來了。

• 對于 DemoJob01 ，每 5 秒左右執(zhí)行一次。同時我們可以看到，demoService?成功注入，而?counts?每次都是 1 ，說明每次 DemoJob01 都是新創(chuàng)建的。

• 對于 DemoJob02 ，每第?10 秒執(zhí)行一次。

下面「3.5 應用配置文件」兩個小節(jié)，是補充知識，建議看看。

3.5 應用配置文件

在?application.yml?中，添加 Quartz 的配置，如下：

spring:#?Quartz?的配置，對應?QuartzProperties?配置類quartz:job-store-type:?memory?#?Job?存儲器類型。默認為?memory?表示內存，可選?jdbc?使用數(shù)據(jù)庫。auto-startup:?true?#?Quartz?是否自動啟動startup-delay:?0?#?延遲?N?秒啟動wait-for-jobs-to-complete-on-shutdown:?true?#?應用關閉時，是否等待定時任務執(zhí)行完成。默認為?false?，建議設置為?trueoverwrite-existing-jobs:?false?#?是否覆蓋已有?Job?的配置properties:?#?添加?Quartz?Scheduler?附加屬性，更多可以看?http://www.quartz-scheduler.org/documentation/2.4.0-SNAPSHOT/configuration.html?文檔org:quartz:threadPool:threadCount:?25?#?線程池大小。默認為?10?。threadPriority:?5?#?線程優(yōu)先級class:?org.quartz.simpl.SimpleThreadPool?#?線程池類型 #????jdbc:?#?這里暫時不說明，使用?JDBC?的?JobStore?的時候，才需要配置

• 在?spring.quartz?配置項，Quartz 的配置，對應 QuartzProperties 配置類。

• Spring Boot QuartzAutoConfiguration 自動化配置類，實現(xiàn) Quartz 的自動配置，創(chuàng)建 Quartz Scheduler(調度器) Bean 。

注意，spring.quartz.wait-for-jobs-to-complete-on-shutdown?配置項，是為了實現(xiàn) Quartz 的優(yōu)雅關閉，建議開啟。關于這塊，和我們在 Spring Task 的「2.6 應用配置文件」 提到的是一致的。

4. 再次入門 Quartz 集群

示例代碼對應倉庫：lab-28-task-quartz-memory 。

實際場景下，我們必然需要考慮定時任務的高可用，所以基本上，肯定使用 Quartz 的集群方案。因此本小節(jié)，我們使用 Quartz 的?JDBC?? ?存儲器 JobStoreTX ，并是使用 MySQL 作為數(shù)據(jù)庫。

如下是 Quartz 兩種存儲器的對比：

FROM https://blog.csdn.net/Evankaka/article/details/45540885

類型優(yōu)點缺點

RAMJobStore	不要外部數(shù)據(jù)庫，配置容易，運行速度快	因為調度程序信息是存儲在被分配給 JVM 的內存里面，所以，當應用程序停止運行時，所有調度信息將被丟失。另外因為存儲到JVM內存里面，所以可以存儲多少個 Job 和 Trigger 將會受到限制
JDBC 作業(yè)存儲	支持集群，因為所有的任務信息都會保存到數(shù)據(jù)庫中，可以控制事物，還有就是如果應用服務器關閉或者重啟，任務信息都不會丟失，并且可以恢復因服務器關閉或者重啟而導致執(zhí)行失敗的任務	運行速度的快慢取決與連接數(shù)據(jù)庫的快慢

艿艿：實際上，有方案可以實現(xiàn)兼具這兩種方式的優(yōu)點，我們在 「666. 彩蛋」 中來說。

另外，本小節(jié)提供的示例和 「3. 快速入門 Quartz 單機」 基本一致。😈 下面，讓我們開始遨游~

4.1 引入依賴

在?pom.xml?文件中，引入相關依賴。

<?xml?version="1.0"?encoding="UTF-8"?> <project?xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0?http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.10.RELEASE</version><relativePath/>?<!--?lookup?parent?from?repository?--></parent><modelVersion>4.0.0</modelVersion><artifactId>lab-28-task-quartz-jdbc</artifactId><dependencies><!--?實現(xiàn)對數(shù)據(jù)庫連接池的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-jdbc</artifactId></dependency><dependency>?<!--?本示例，我們使用?MySQL?--><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.48</version></dependency><!--?實現(xiàn)對?Spring?MVC?的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--?實現(xiàn)對?Quartz?的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-quartz</artifactId></dependency><!--?方便等會寫單元測試?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies></project>

• 和 「3.1 引入依賴」 基本一致，只是額外引入?spring-boot-starter-test?依賴，等會會寫兩個單元測試方法。

4.2 示例 Job

在?cn.iocoder.springboot.lab28.task.config.job?包路徑下，創(chuàng)建 DemoJob01 和 DemoJob02 類。代碼如下：

//?DemoJob01.java@DisallowConcurrentExecution public?class?DemoJob01?extends?QuartzJobBean?{private?Logger?logger?=?LoggerFactory.getLogger(getClass());@Autowiredprivate?DemoService?demoService;@Overrideprotected?void?executeInternal(JobExecutionContext?context)?{logger.info("[executeInternal][我開始的執(zhí)行了,?demoService?為?({})]",?demoService);}}//?DemoJob02.java@DisallowConcurrentExecution public?class?DemoJob02?extends?QuartzJobBean?{private?Logger?logger?=?LoggerFactory.getLogger(getClass());@Overrideprotected?void?executeInternal(JobExecutionContext?context)?{logger.info("[executeInternal][我開始的執(zhí)行了]");}}

• 相比 「3.2 示例 Job」 來說，在類上添加了 Quartz 的?@DisallowConcurrentExecution?注解，保證相同 JobDetail 在多個 JVM 進程中，有且僅有一個節(jié)點在執(zhí)行。

注意，不是以 Quartz Job 為維度，保證在多個 JVM 進程中，有且僅有一個節(jié)點在執(zhí)行，而是以 JobDetail 為維度。雖然說，絕大多數(shù)情況下，我們會保證一個 Job 和 JobDetail 是一一對應。😈 所以，搞不清楚這個概念的胖友，最好搞清楚這個概念。實在有點懵逼，保證一個 Job 和 JobDetail 是一一對應就對了。

而 JobDetail 的唯一標識是 JobKey ，使用?name?+?group?兩個屬性。一般情況下，我們只需要設置?name?即可，而 Quartz 會默認?group = DEFAULT?。

不過這里還有一點要補充，也是需要注意的，在 Quartz 中，相同 Scheduler 名字的節(jié)點，形成一個 Quartz 集群。在下文中，我們可以通過?spring.quartz.scheduler-name?配置項，設置 Scheduler 的名字。

【重要】為什么要說這個呢？因為我們要完善一下上面的說法：通過在 Job 實現(xiàn)類上添加?@DisallowConcurrentExecution?注解，實現(xiàn)在相同?Quartz Scheduler 集群中，相同?JobKey 的 JobDetail ，保證在多個 JVM 進程中，有且僅有一個節(jié)點在執(zhí)行。

4.3 應用配置文件

在?application.yml?中，添加 Quartz 的配置，如下：

spring:datasource:user:url:?jdbc:mysql://127.0.0.1:3306/lab-28-quartz-jdbc-user?useSSL=false&useUnicode=true&characterEncoding=UTF-8driver-class-name:?com.mysql.jdbc.Driverusername:?rootpassword:quartz:url:?jdbc:mysql://127.0.0.1:3306/lab-28-quartz-jdbc-quartz?useSSL=false&useUnicode=true&characterEncoding=UTF-8driver-class-name:?com.mysql.jdbc.Driverusername:?rootpassword:#?Quartz?的配置，對應?QuartzProperties?配置類quartz:scheduler-name:?clusteredScheduler?#?Scheduler?名字。默認為?schedulerNamejob-store-type:?jdbc?#?Job?存儲器類型。默認為?memory?表示內存，可選?jdbc?使用數(shù)據(jù)庫。auto-startup:?true?#?Quartz?是否自動啟動startup-delay:?0?#?延遲?N?秒啟動wait-for-jobs-to-complete-on-shutdown:?true?#?應用關閉時，是否等待定時任務執(zhí)行完成。默認為?false?，建議設置為?trueoverwrite-existing-jobs:?false?#?是否覆蓋已有?Job?的配置properties:?#?添加?Quartz?Scheduler?附加屬性，更多可以看?http://www.quartz-scheduler.org/documentation/2.4.0-SNAPSHOT/configuration.html?文檔org:quartz:#?JobStore?相關配置jobStore:#?數(shù)據(jù)源名稱dataSource:?quartzDataSource?#?使用的數(shù)據(jù)源class:?org.quartz.impl.jdbcjobstore.JobStoreTX?#?JobStore?實現(xiàn)類driverDelegateClass:?org.quartz.impl.jdbcjobstore.StdJDBCDelegatetablePrefix:?QRTZ_?#?Quartz?表前綴isClustered:?true?#?是集群模式clusterCheckinInterval:?1000useProperties:?false#?線程池相關配置threadPool:threadCount:?25?#?線程池大小。默認為?10?。threadPriority:?5?#?線程優(yōu)先級class:?org.quartz.simpl.SimpleThreadPool?#?線程池類型jdbc:?#?使用?JDBC?的?JobStore?的時候，JDBC?的配置initialize-schema:?never?#?是否自動使用?SQL?初始化?Quartz?表結構。這里設置成?never?，我們手動創(chuàng)建表結構。

• 配置項比較多，我們主要對比 「3.5 應用配置文件」 來看看。

• 在?spring.datasource?配置項下，用于創(chuàng)建多個數(shù)據(jù)源的配置。

  • user?配置，連接?lab-28-quartz-jdbc-user?庫。目的是，為了模擬我們一般項目，使用到的業(yè)務數(shù)據(jù)庫。

  • quartz?配置，連接?lab-28-quartz-jdbc-quartz?庫。目的是，Quartz 會使用單獨的數(shù)據(jù)庫。😈 如果我們有多個項目需要使用到 Quartz 數(shù)據(jù)庫的話，可以統(tǒng)一使用一個，但是要注意配置?spring.quartz.scheduler-name?設置不同的 Scheduler 名字，形成不同的 Quartz 集群。

• 在?spring.quartz?配置項下，額外增加了一些配置項，我們逐個來看看。

  • scheduler-name?配置，Scheduler 名字。這個我們在上文解釋了很多次了，如果還不明白，請拍死自己。

  • job-store-type?配置，設置了使用?"jdbc"?的 Job 存儲器。

  • properties.org.quartz.jobStore?配置，增加了 JobStore 相關配置。重點是，通過?dataSource?配置項，設置了使用名字為?"quartzDataSource"?的 DataSource 為數(shù)據(jù)源。😈 在 「4.4 DataSourceConfiguration」 中，我們會使用?spring.datasource.quartz?配置，來創(chuàng)建該數(shù)據(jù)源。

  • jdbc?配置項，雖然名字叫這個，主要是為了設置使用 SQL 初始化 Quartz 表結構。這里，我們設置?initialize-schema = never?，我們手動創(chuàng)建表結構。

咳咳咳，配置項確實有點多。如果暫時搞不明白的胖友，可以先簡單把?spring.datasource?數(shù)據(jù)源，修改成自己的即可。

4.4 初始化 Quartz 表結構

在 Quartz Download 地址，下載對應版本的發(fā)布包。解壓后，我們可以在?src/org/quartz/impl/jdbcjobstore/?目錄，看到各種數(shù)據(jù)庫的 Quartz 表結構的初始化腳本。這里，因為我們使用 MySQL ，所以使用?tables_mysql_innodb.sql?腳本。

在數(shù)據(jù)庫中執(zhí)行該腳本，完成初始化 Quartz 表結構。如下圖所示：

關于每個 Quartz 表結構的說明，可以看看 《Quartz 框架（二）——JobStore 數(shù)據(jù)庫表字段詳解》 文章。😈 實際上，也可以不看，哈哈哈哈。

我們會發(fā)現(xiàn)，每個表都有一個?SCHED_NAME?字段，Quartz Scheduler 名字。這樣，實現(xiàn)每個 Quartz 集群，數(shù)據(jù)層面的拆分。

4.5 DataSourceConfiguration

在?cn.iocoder.springboot.lab28.task.config?包路徑下，創(chuàng)建 DataSourceConfiguration 類，配置數(shù)據(jù)源。代碼如下：

//?DataSourceConfiguration.java@Configuration public?class?DataSourceConfiguration?{/***?創(chuàng)建?user?數(shù)據(jù)源的配置對象*/@Primary@Bean(name?=?"userDataSourceProperties")@ConfigurationProperties(prefix?=?"spring.datasource.user")?//?讀取?spring.datasource.user?配置到?DataSourceProperties?對象public?DataSourceProperties?userDataSourceProperties()?{return?new?DataSourceProperties();}/***?創(chuàng)建?user?數(shù)據(jù)源*/@Primary@Bean(name?=?"userDataSource")@ConfigurationProperties(prefix?=?"spring.datasource.user.hikari")?//?讀取?spring.datasource.user?配置到?HikariDataSource?對象public?DataSource?userDataSource()?{//?獲得?DataSourceProperties?對象DataSourceProperties?properties?=??this.userDataSourceProperties();//?創(chuàng)建?HikariDataSource?對象return?createHikariDataSource(properties);}/***?創(chuàng)建?quartz?數(shù)據(jù)源的配置對象*/@Bean(name?=?"quartzDataSourceProperties")@ConfigurationProperties(prefix?=?"spring.datasource.quartz")?//?讀取?spring.datasource.quartz?配置到?DataSourceProperties?對象public?DataSourceProperties?quartzDataSourceProperties()?{return?new?DataSourceProperties();}/***?創(chuàng)建?quartz?數(shù)據(jù)源*/@Bean(name?=?"quartzDataSource")@ConfigurationProperties(prefix?=?"spring.datasource.quartz.hikari")@QuartzDataSourcepublic?DataSource?quartzDataSource()?{//?獲得?DataSourceProperties?對象DataSourceProperties?properties?=??this.quartzDataSourceProperties();//?創(chuàng)建?HikariDataSource?對象return?createHikariDataSource(properties);}private?static?HikariDataSource?createHikariDataSource(DataSourceProperties?properties)?{//?創(chuàng)建?HikariDataSource?對象HikariDataSource?dataSource?=?properties.initializeDataSourceBuilder().type(HikariDataSource.class).build();//?設置線程池名if?(StringUtils.hasText(properties.getName()))?{dataSource.setPoolName(properties.getName());}return?dataSource;}}

• 基于?spring.datasource.user?配置項，創(chuàng)建了名字為?"userDataSource"?的 DataSource Bean 。并且，在其上我們添加了?@Primay?注解，表示其是主數(shù)據(jù)源。

• 基于?spring.datasource.quartz?配置項，創(chuàng)建了名字為?"quartzDataSource"?的 DataSource Bean 。并且，在其上我們添加了?@QuartzDataSource?注解，表示其是?Quartz?的數(shù)據(jù)源。😈 注意，一定要配置啊，這里艿艿卡了好久！！！！

4.6 定時任務配置

完成上述的工作之后，我們需要配置 Quartz 的定時任務。目前，有兩種方式：

• 方式一，「4.6.1 Bean 自動設置」 。

• 方式二，「4.6.2 Scheduler 手動設置」 。

4.6.1 Bean 自動設置

在?cn.iocoder.springboot.lab28.task.config?包路徑下，創(chuàng)建 ScheduleConfiguration 類，配置上述的兩個示例 Job 。代碼如下：

//?ScheduleConfiguration.java@Configuration public?class?ScheduleConfiguration?{public?static?class?DemoJob01Configuration?{@Beanpublic?JobDetail?demoJob01()?{return?JobBuilder.newJob(DemoJob01.class).withIdentity("demoJob01")?//?名字為?demoJob01.storeDurably()?//?沒有?Trigger?關聯(lián)的時候任務是否被保留。因為創(chuàng)建?JobDetail?時，還沒?Trigger?指向它，所以需要設置為?true?，表示保留。.build();}@Beanpublic?Trigger?demoJob01Trigger()?{//?簡單的調度計劃的構造器SimpleScheduleBuilder?scheduleBuilder?=?SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5)?//?頻率。.repeatForever();?//?次數(shù)。//?Trigger?構造器return?TriggerBuilder.newTrigger().forJob(demoJob01())?//?對應?Job?為?demoJob01.withIdentity("demoJob01Trigger")?//?名字為?demoJob01Trigger.withSchedule(scheduleBuilder)?//?對應?Schedule?為?scheduleBuilder.build();}}public?static?class?DemoJob02Configuration?{@Beanpublic?JobDetail?demoJob02()?{return?JobBuilder.newJob(DemoJob02.class).withIdentity("demoJob02")?//?名字為?demoJob02.storeDurably()?//?沒有?Trigger?關聯(lián)的時候任務是否被保留。因為創(chuàng)建?JobDetail?時，還沒?Trigger?指向它，所以需要設置為?true?，表示保留。.build();}@Beanpublic?Trigger?demoJob02Trigger()?{//?簡單的調度計劃的構造器CronScheduleBuilder?scheduleBuilder?=?CronScheduleBuilder.cronSchedule("0/10?*?*?*?*???*");//?Trigger?構造器return?TriggerBuilder.newTrigger().forJob(demoJob02())?//?對應?Job?為?demoJob02.withIdentity("demoJob02Trigger")?//?名字為?demoJob02Trigger.withSchedule(scheduleBuilder)?//?對應?Schedule?為?scheduleBuilder.build();}}}

• 和 「3.3 ScheduleConfiguration」 是一模一樣的。

在 Quartz 調度器啟動的時候，會根據(jù)該配置，自動調用如下方法：

• Scheduler#addJob(JobDetail jobDetail, boolean replace)?方法，將 JobDetail 持久化到數(shù)據(jù)庫。

• Scheduler#scheduleJob(Trigger trigger)?方法，將 Trigger 持久化到數(shù)據(jù)庫。

4.6.2 Scheduler 手動設置

一般情況下，艿艿推薦使用 Scheduler 手動設置。

創(chuàng)建 QuartzSchedulerTest 類，創(chuàng)建分別添加 DemoJob01 和 DemoJob02 的 Quartz 定時任務配置。代碼如下：

//?QuartzSchedulerTest.java@RunWith(SpringRunner.class) @SpringBootTest(classes?=?Application.class) public?class?QuartzSchedulerTest?{@Autowiredprivate?Scheduler?scheduler;@Testpublic?void?addDemoJob01Config()?throws?SchedulerException?{//?創(chuàng)建?JobDetailJobDetail?jobDetail?=?JobBuilder.newJob(DemoJob01.class).withIdentity("demoJob01")?//?名字為?demoJob01.storeDurably()?//?沒有?Trigger?關聯(lián)的時候任務是否被保留。因為創(chuàng)建?JobDetail?時，還沒?Trigger?指向它，所以需要設置為?true?，表示保留。.build();//?創(chuàng)建?TriggerSimpleScheduleBuilder?scheduleBuilder?=?SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5)?//?頻率。.repeatForever();?//?次數(shù)。Trigger?trigger?=?TriggerBuilder.newTrigger().forJob(jobDetail)?//?對應?Job?為?demoJob01.withIdentity("demoJob01Trigger")?//?名字為?demoJob01Trigger.withSchedule(scheduleBuilder)?//?對應?Schedule?為?scheduleBuilder.build();//?添加調度任務scheduler.scheduleJob(jobDetail,?trigger); //????????scheduler.scheduleJob(jobDetail,?Sets.newSet(trigger),?true);}@Testpublic?void?addDemoJob02Config()?throws?SchedulerException?{//?創(chuàng)建?JobDetailJobDetail?jobDetail?=?JobBuilder.newJob(DemoJob02.class).withIdentity("demoJob02")?//?名字為?demoJob02.storeDurably()?//?沒有?Trigger?關聯(lián)的時候任務是否被保留。因為創(chuàng)建?JobDetail?時，還沒?Trigger?指向它，所以需要設置為?true?，表示保留。.build();//?創(chuàng)建?TriggerCronScheduleBuilder?scheduleBuilder?=?CronScheduleBuilder.cronSchedule("0/10?*?*?*?*???*");Trigger?trigger?=?TriggerBuilder.newTrigger().forJob(jobDetail)?//?對應?Job?為?demoJob01.withIdentity("demoJob02Trigger")?//?名字為?demoJob01Trigger.withSchedule(scheduleBuilder)?//?對應?Schedule?為?scheduleBuilder.build();//?添加調度任務scheduler.scheduleJob(jobDetail,?trigger); //????????scheduler.scheduleJob(jobDetail,?Sets.newSet(trigger),?true);}}

• 創(chuàng)建 JobDetail 和 Trigger 的代碼，其實和 「4.6.1 Bean 自動設置」 是一致的。

• 在每個單元測試方法的最后，調用?Scheduler#scheduleJob(JobDetail jobDetail, Trigger trigger)?方法，將 JobDetail 和 Trigger 持久化到數(shù)據(jù)庫。

• 如果想要覆蓋數(shù)據(jù)庫中的 Quartz 定時任務的配置，可以調用?Scheduler#scheduleJob(JobDetail jobDetail, Set<? extends Trigger> triggersForJob, boolean replace)?方法，傳入?replace = true?進行覆蓋配置。

4.7 Application

創(chuàng)建?Application.java?類，配置?@SpringBootApplication?注解即可。代碼如下：

//?Application.java@SpringBootApplication public?class?Application?{public?static?void?main(String[]?args)?{SpringApplication.run(Application.class,?args);}}

• 運行 Application 類，啟動示例項目。具體的執(zhí)行日志，和 「3.4 Application」 基本一致，艿艿這里就不重復羅列了。

如果胖友想要測試集群下的運行情況，可以再創(chuàng)建 創(chuàng)建?Application02.java?類，配置?@SpringBootApplication?注解即可。代碼如下：

//?Application02.java@SpringBootApplication public?class?Application02?{public?static?void?main(String[]?args)?{//?設置?Tomcat?隨機端口System.setProperty("server.port",?"0");//?啟動?Spring?Boot?應用SpringApplication.run(Application.class,?args);}}

• 運行 Application02 類，再次啟動一個示例項目。然后，觀察輸出的日志，可以看到啟動的兩個示例項目，都會有 DemoJob01 和 DemoJob02 的執(zhí)行日志。

5. 快速入門 XXL-JOB

示例代碼對應倉庫：lab-28-task-xxl-job 。

雖然說，Quartz 的功能，已經(jīng)能夠滿足我們對定時任務的訴求，但是距離生產(chǎn)可用、好用，還是有一定的距離。在艿艿最早開始實習的時候，因為Quartz 只提供了任務調度的功能，不提供管理任務的管理與監(jiān)控控制臺，需要自己去做二次封裝。當時，因為社區(qū)中找不到合適的實現(xiàn)這塊功能的開源項目，所以我們就自己進行了簡單的封裝，滿足我們的管理與監(jiān)控的需求。

不過現(xiàn)在呢，開源社區(qū)中已經(jīng)有了很多優(yōu)秀的調度任務中間件。其中，比較有代表性的就是 XXL-JOB 。其對自己的定義如下：

XXL-JOB 是一個輕量級分布式任務調度平臺，其核心設計目標是開發(fā)迅速、學習簡單、輕量級、易擴展。

對于 XXL-JOB 的入門，艿艿已經(jīng)在 《芋道 XXL-JOB 極簡入門》 中編寫，胖友先跳轉到該文章閱讀。重點是，要先搭建一個 XXL-JOB 調度中心。😈 因為，本文我們是來在 Spring Boot 項目中，實現(xiàn)一個 XXL-JOB 執(zhí)行器。

5.1 引入依賴

在?pom.xml?文件中，引入相關依賴。

<?xml?version="1.0"?encoding="UTF-8"?> <project?xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0?http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.1.RELEASE</version><relativePath/>?<!--?lookup?parent?from?repository?--></parent><modelVersion>4.0.0</modelVersion><artifactId>lab-28-task-xxl-job</artifactId><dependencies><!--?實現(xiàn)對?Spring?MVC?的自動化配置?--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--?XXL-JOB?相關依賴?--><dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.1.1</version></dependency></dependencies></project>

具體每個依賴的作用，胖友自己認真看下艿艿添加的所有注釋噢。比較可惜的是，目前 XXL-JOB 官方并未提供 Spring Boot Starter 包，略微有點尷尬。不過，社區(qū)已經(jīng)有人在提交 Pull Request 了，詳細可見 https://github.com/xuxueli/xxl-job/pull/820 。

5.2 應用配置文件

在?application.yml?中，添加 Quartz 的配置，如下：

server:port:?9090?#指定一個端口，避免和?XXL-JOB?調度中心的端口沖突。僅僅測試之用#?xxl-job xxl:job:admin:addresses:?http://127.0.0.1:8080/xxl-job-admin?#?調度中心部署跟地址?[選填]：如調度中心集群部署存在多個地址則用逗號分隔。執(zhí)行器將會使用該地址進行"執(zhí)行器心跳注冊"和"任務結果回調"；為空則關閉自動注冊；executor:appname:?lab-28-executor?#?執(zhí)行器?AppName?[選填]：執(zhí)行器心跳注冊分組依據(jù)；為空則關閉自動注冊ip:?#?執(zhí)行器IP?[選填]：默認為空表示自動獲取IP，多網(wǎng)卡時可手動設置指定IP，該IP不會綁定Host僅作為通訊實用；地址信息用于?"執(zhí)行器注冊"?和?"調度中心請求并觸發(fā)任務"；port:?6666?#?###?執(zhí)行器端口號?[選填]：小于等于0則自動獲取；默認端口為9999，單機部署多個執(zhí)行器時，注意要配置不同執(zhí)行器端口；logpath:?/Users/yunai/logs/xxl-job/lab-28-executor?#?執(zhí)行器運行日志文件存儲磁盤路徑?[選填]?：需要對該路徑擁有讀寫權限；為空則使用默認路徑；logretentiondays:?30?#?執(zhí)行器日志文件保存天數(shù)?[選填]?：?過期日志自動清理,?限制值大于等于3時生效;?否則,?如-1,?關閉自動清理功能；accessToken:?yudaoyuanma?#?執(zhí)行器通訊TOKEN?[選填]：非空時啟用；

• 具體每個參數(shù)的作用，胖友自己看下詳細的注釋哈。

5.3 XxlJobConfiguration

在?cn.iocoder.springboot.lab28.task.config?包路徑下，創(chuàng)建 DataSourceConfiguration 類，配置 XXL-JOB 執(zhí)行器。代碼如下：

//?XxlJobConfiguration.java@Configuration public?class?XxlJobConfiguration?{@Value("${xxl.job.admin.addresses}")private?String?adminAddresses;@Value("${xxl.job.executor.appname}")private?String?appName;@Value("${xxl.job.executor.ip}")private?String?ip;@Value("${xxl.job.executor.port}")private?int?port;@Value("${xxl.job.accessToken}")private?String?accessToken;@Value("${xxl.job.executor.logpath}")private?String?logPath;@Value("${xxl.job.executor.logretentiondays}")private?int?logRetentionDays;@Beanpublic?XxlJobSpringExecutor?xxlJobExecutor()?{//?創(chuàng)建?XxlJobSpringExecutor?執(zhí)行器XxlJobSpringExecutor?xxlJobSpringExecutor?=?new?XxlJobSpringExecutor();xxlJobSpringExecutor.setAdminAddresses(adminAddresses);xxlJobSpringExecutor.setAppName(appName);xxlJobSpringExecutor.setIp(ip);xxlJobSpringExecutor.setPort(port);xxlJobSpringExecutor.setAccessToken(accessToken);xxlJobSpringExecutor.setLogPath(logPath);xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);//?返回return?xxlJobSpringExecutor;}}

• 在?#xxlJobExecutor()?方法，創(chuàng)建了 Spring 容器下的 XXL-JOB 執(zhí)行器 Bean 對象。要注意，方法上添加了的?@Bean?注解，配置了啟動和銷毀方法。

5.4 DemoJob

在?cn.iocoder.springboot.lab28.task.job?包路徑下，創(chuàng)建 DemoJob 類，示例定時任務類。代碼如下：

//?DemoJob.java@Component @JobHandler("demoJob") public?class?DemoJob?extends?IJobHandler?{private?Logger?logger?=?LoggerFactory.getLogger(getClass());private?final?AtomicInteger?counts?=?new?AtomicInteger();@Overridepublic?ReturnT<String>?execute(String?param)?throws?Exception?{//?打印日志logger.info("[execute][定時第?({})?次執(zhí)行]",?counts.incrementAndGet());//?返回執(zhí)行成功return?ReturnT.SUCCESS;}}

• 繼承 XXL-JOB IJobHandler 抽象類，通過實現(xiàn)?#execute(String param)?方法，從而實現(xiàn)定時任務的邏輯。

• 在方法上，添加?@JobHandler?注解，設置 JobHandler 的名字。后續(xù)，我們在調度中心的控制臺中，新增任務時，需要使用到這個名字。

#execute(String param)?方法的返回結果，為 ReturnT 類型。當返回值符合?“ReturnT.code == ReturnT.SUCCESS_CODE”?時表示任務執(zhí)行成功，否則表示任務執(zhí)行失敗，而且可以通過?“ReturnT.msg”?回調錯誤信息給調度中心；從而，在任務邏輯中可以方便的控制任務執(zhí)行結果。

#execute(String param)?方法的方法參數(shù)，為調度中心的控制臺中，新增任務時，配置的“任務參數(shù)”。一般情況下，不會使用到。

5.5 Application

創(chuàng)建?Application.java?類，配置?@SpringBootApplication?注解即可。代碼如下：

//?Application.java@SpringBootApplication public?class?Application?{public?static?void?main(String[]?args)?{SpringApplication.run(Application.class,?args);}}

運行 Application 類，啟動示例項目。輸出日志精簡如下：

#?XXL-JOB?啟動日志 2019-11-29?00:58:42.429??INFO?46957?---?[???????????main]?c.xxl.job.core.executor.XxlJobExecutor???:?>>>>>>>>>>>?xxl-job?register?jobhandler?success,?name:demoJob,?jobHandler:cn.iocoder.springboot.lab28.task.job.DemoJob@3af9aa66 2019-11-29?00:58:42.451??INFO?46957?---?[???????????main]?c.x.r.r.provider.XxlRpcProviderFactory???:?>>>>>>>>>>>?xxl-rpc,?provider?factory?add?service?success.?serviceKey?=?com.xxl.job.core.biz.ExecutorBiz,?serviceBean?=?class?com.xxl.job.core.biz.impl.ExecutorBizImpl 2019-11-29?00:58:42.454??INFO?46957?---?[???????????main]?c.x.r.r.provider.XxlRpcProviderFactory???:?>>>>>>>>>>>?xxl-rpc,?provider?factory?add?service?success.?serviceKey?=?com.xxl.job.core.biz.ExecutorBiz,?serviceBean?=?class?com.xxl.job.core.biz.impl.ExecutorBizImpl 2019-11-29?00:58:42.565??INFO?46957?---?[???????????main]?o.s.s.concurrent.ThreadPoolTaskExecutor??:?Initializing?ExecutorService?'applicationTaskExecutor' 2019-11-29?00:58:42.629??INFO?46957?---?[???????Thread-7]?com.xxl.rpc.remoting.net.Server??????????:?>>>>>>>>>>>?xxl-rpc?remoting?server?start?success,?nettype?=?com.xxl.rpc.remoting.net.impl.netty_http.server.NettyHttpServer,?port?=?6666

此時，因為我們并未在 XXL-JOB 調度中心進行相關的配置，所以 DemoJob 并不會執(zhí)行。下面，讓我們在 XXL-JOB 調度中心進行相應的配置。

5.6 新增執(zhí)行器

瀏覽器打開 http://127.0.0.1:8080/xxl-job-admin/jobgroup 地址，即「執(zhí)行器管理」菜單。如下圖：

點擊「新增執(zhí)行器」按鈕，彈出「新增執(zhí)行器」界面。如下圖：

填寫完?"lab-28-executor"?執(zhí)行器的信息，點擊「保存」按鈕，進行保存。耐心等待一會，執(zhí)行器會自動注冊上來。如下圖：

• 執(zhí)行器列表中顯示在線的執(zhí)行器列表, 可通過 "OnLine 機器" 查看對應執(zhí)行器的集群機器。

相同執(zhí)行器，有且僅需配置一次即可。

5.7 新建任務

瀏覽器打開 http://127.0.0.1:8080/xxl-job-admin/jobinfo 地址，即「任務管理」菜單。如下圖：

點擊最右邊的「新增」按鈕，彈出「新增」界面。如下圖：

填寫完?"demoJob"?任務的信息，點擊「保存」按鈕，進行保存。如下圖：

點擊?"demoJob"?任務的「操作」按鈕，選擇「啟動」，確認后，該?"demoJob"?任務的狀態(tài)就變成了?RUNNING?。如下圖：

此時，我們打開執(zhí)行器的 IDE 界面，可以看到 DemoJob 已經(jīng)在每分鐘執(zhí)行一次了。日志如下：

2019-11-29?01:30:00.161??INFO?48374?---?[??????Thread-18]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(1)?次執(zhí)行] 2019-11-29?01:31:00.012??INFO?48374?---?[??????Thread-18]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(2)?次執(zhí)行] 2019-11-29?01:32:00.009??INFO?48374?---?[??????Thread-18]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(3)?次執(zhí)行] 2019-11-29?01:33:00.010??INFO?48374?---?[??????Thread-18]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(4)?次執(zhí)行] 2019-11-29?01:34:00.005??INFO?48374?---?[??????Thread-18]?c.i.springboot.lab28.task.job.DemoJob????:?[execute][定時第?(5)?次執(zhí)行]

并且，我們在調度中心的界面上，點擊?"demoJob"?任務的「操作」按鈕，選擇「查詢日志」，可以看到相應的調度日志。如下圖：

至此，我們已經(jīng)完成了 XXL-JOB 執(zhí)行器的入門。

6. 快速入門 Elastic-Job

可能很多胖友不了解 Elastic-Job 這個中間件。我們看一段其官方文檔的介紹：

Elastic-Job 是一個分布式調度解決方案，由兩個相互獨立的子項目 Elastic-Job-Lite 和 Elastic-Job-Cloud 組成。

Elastic-Job-Lite 定位為輕量級無中心化解決方案，使用 jar 包的形式提供分布式任務的協(xié)調服務。

Elastic-Job 基本是國內開源最好的調度任務中間件的幾個中間件，可能沒有之一，嘿嘿。目前處于有點“斷更”的狀態(tài)，具體可見 https://github.com/elasticjob/elastic-job-lite/issues/616 。

所以關于這塊的示例，艿艿暫時先不提供。如果對 Elastic-Job 源碼感興趣的胖友，可以看看艿艿寫的如下兩個系列：

• 《芋道 Elastic-Job-Lite 源碼分析系列》

• 《芋道 Elastic-Job-Cloud 源碼分析系列》

666. 彩蛋

① 如何選擇？

可能胖友希望了解下不同調度中間件的對比。表格如下：

特性quartzelastic-job-litexxl-jobLTS

依賴	MySQL、jdk	jdk、zookeeper	mysql、jdk	jdk、zookeeper、maven
高可用	多節(jié)點部署，通過競爭數(shù)據(jù)庫鎖來保證只有一個節(jié)點執(zhí)行任務	通過zookeeper的注冊與發(fā)現(xiàn)，可以動態(tài)的添加服務器	基于競爭數(shù)據(jù)庫鎖保證只有一個節(jié)點執(zhí)行任務，支持水平擴容。可以手動增加定時任務，啟動和暫停任務，有監(jiān)控	集群部署,可以動態(tài)的添加服務器?？梢允謩釉黾佣〞r任務，啟動和暫停任務。有監(jiān)控
任務分片	×	√	√	√
管理界面	×	√	√	√
難易程度	簡單	簡單	簡單	略復雜
高級功能	-	彈性擴容，多種作業(yè)模式，失效轉移，運行狀態(tài)收集，多線程處理數(shù)據(jù)，冪等性，容錯處理，spring命名空間支持	彈性擴容，分片廣播，故障轉移，Rolling實時日志，GLUE（支持在線編輯代碼，免發(fā)布）,任務進度監(jiān)控，任務依賴，數(shù)據(jù)加密，郵件報警，運行報表，國際化	支持spring，spring boot，業(yè)務日志記錄器，SPI擴展支持，故障轉移，節(jié)點監(jiān)控，多樣化任務執(zhí)行結果支持，FailStore容錯，動態(tài)擴容。
版本更新	半年沒更新	2年沒更新	最近有更新	1年沒更新

也推薦看看如下文章：

• 《分布式定時任務調度系統(tǒng)技術選型》

• 《Azkaban、Xxl-Job 與 Airflow 對比分析》

目前的狀況，如果真的不知道怎么選擇，可以先嘗試下 XXL-JOB 。

② 中心化 V.S 去中心化

下面，讓我們一起來簡單聊聊分布式調度中間件的實現(xiàn)方式的分類。一個分布式的調度中間件，會存在兩種角色：

• 調度器：負責調度任務，下發(fā)給執(zhí)行器。

• 執(zhí)行器：負責接收任務，執(zhí)行具體任務。

那么，如果從調度系統(tǒng)的角度來看，可以分成兩類：

• 中心化： 調度中心和執(zhí)行器分離，調度中心統(tǒng)一調度，通知某個執(zhí)行器處理任務。

• 去中心化：調度中心和執(zhí)行器一體化，自己調度自己執(zhí)行處理任務。

如此可知 XXL-Job 屬于中心化的任務調度平臺。目前采用這種方案的還有：

• 鏈家的 kob

• 美團的 Crane（暫未開源）

去中心化的任務調度平臺，目前有：

• Elastic Job

• 唯品會的 Saturn

• Quartz 基于數(shù)據(jù)庫的集群方案

• 淘寶的 TBSchedule（暫停更新，只能使用阿里云 SchedulerX 服務）

艿艿：如果胖友想要更加的理解，可以看看艿艿朋友寫的 《中心化 V.S 去中心化調度設計》

③ 任務競爭 V.S 任務預分配

那么，如果從任務分配的角度來看，可以分成兩類：

• 任務競爭：調度器會通過競爭任務，下發(fā)任務給執(zhí)行器。

• 任務預分配：調度器預先分配任務給不同的執(zhí)行器，無需進行競爭。

如此可知 XXL-Job 屬于任務競爭的任務調度平臺。目前采用這種方案的還有：

• 鏈家的 kob

• 美團的 Crane（暫未開源）

• Quartz 基于數(shù)據(jù)庫的集群方案

任務預分配的任務調度平臺，目前有：

• Elastic Job

• 唯品會的 Saturn

• 淘寶的 TBSchedule（暫停更新，只能使用阿里云 SchedulerX 服務）

一般來說，基于任務預分配的任務調度平臺，都會選擇使用 Zookeeper 來協(xié)調分配任務到不同的節(jié)點上。同時，任務調度平臺必須是去中心化的方案，每個節(jié)點即是調度器又是執(zhí)行器。這樣，任務在預分配在每個節(jié)點之后，后續(xù)就自己調度給自己執(zhí)行。

相比較而言，隨著節(jié)點越來越多，基于任務競爭的方案會因為任務競爭，導致存在性能下滑的問題。而基于任務預分配的方案，則不會存在這個問題。并且，基于任務預分配的方案，性能會優(yōu)于基于任務競爭的方案。

這里在推薦一篇 Elastic Job 開發(fā)者張亮的文章 《詳解當當網(wǎng)的分布式作業(yè)框架 elastic-job》 ，灰常給力！

④ Quartz 是個優(yōu)秀的調度內核

絕大多數(shù)情況下，我們不會直接使用 Quartz 作為我們的調度中間件的選擇。但是，基本所有的分布式調度中間件，都將 Quartz 作為調度內核，因為 Quartz 在單純任務調度本身提供了很強的功能。

不過呢，隨著一個分布式調度中間件的逐步完善，又會逐步考慮拋棄 Quartz 作為調度內核，轉而自研。例如說 XXL-JOB 在 2.1.0 RELEASE 的版本中，就已經(jīng)更換成自研的調度模塊。其替換的理由如下：

XXL-JOB 最終選擇自研調度組件（早期調度組件基于 Quartz）；

• 一方面，是為了精簡系統(tǒng)降低冗余依賴。

• 另一方面，是為了提供系統(tǒng)的可控度與穩(wěn)定性。

在 Elastic-Job 3.X 的開發(fā)計劃中，也有一項計劃，就是自研調度組件，替換掉 Quartz 。

總結

以上是生活随笔為你收集整理的Spring Job？Quartz？XXL-Job？年轻人才做选择，艿艿全莽~的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內容還不錯，歡迎將生活随笔推薦給好友。