前兩天寫了一篇文章介紹了一下 ElasticJob，有不少小伙伴強(qiáng)烈建議講講 xxl-job，其實(shí) ElasticJob 本來(lái)就是一個(gè)引子，松哥本來(lái)就是想和大家分享 xxl-job。

1. xxl-job

松哥也在微信群里和小伙伴們討論過(guò)各自到底用的是 xxl-job 還是 ElasticJob，討論的結(jié)果就是，xxl-job 使用的人更多一些。

不說(shuō)功能的優(yōu)劣，我們單純從數(shù)據(jù)上其實(shí)就能看出一些端倪：

這是 xxl-job 的 GitHub：

這是 ElasticJob 的 GitHub：

從這個(gè)數(shù)據(jù)比較上大概也能看出來(lái) xxl-job 更火一些。注意我這里說(shuō)的是更火一些，不是說(shuō) xxl-job 比 ElasticJob 更強(qiáng)。

xxl-job 出自大眾點(diǎn)評(píng)，這是一個(gè)分布式輕量級(jí)的任務(wù)調(diào)度框架，其核心設(shè)計(jì)目標(biāo)是開發(fā)迅速、學(xué)習(xí)簡(jiǎn)單、輕量級(jí)、易擴(kuò)展。

xxl-job 通過(guò)一個(gè)中心式的調(diào)度平臺(tái)，調(diào)度多個(gè)執(zhí)行器執(zhí)行任務(wù)，調(diào)度中心通過(guò) DB 鎖保證集群分布式調(diào)度的一致性，這樣擴(kuò)展執(zhí)行器會(huì)增大 DB 的壓力，然而大部分公司的任務(wù)數(shù)，執(zhí)行器并不多;xxl-job 提供了非常好用的監(jiān)控頁(yè)面甚至還有任務(wù)失敗的郵件告警功能。不同于 ElasticJob，xxl-job 在使用時(shí)依賴 MySQL，而不需要 ZooKeeper。

ElasticJob 則出自當(dāng)當(dāng)，設(shè)計(jì) ElasticJob 的初衷是為了面對(duì)高并發(fā)以及復(fù)雜的業(yè)務(wù)，即使是在業(yè)務(wù)量大，服務(wù)器多的時(shí)候也能做好任務(wù)調(diào)度，盡可能的利用服務(wù)器的資源。ElasticJob 是無(wú)中心化的，如果主服務(wù)器掛了，會(huì)自動(dòng)通過(guò) ZooKeeper 的選舉機(jī)制選舉出新的主服務(wù)器。因此 ElasticJob 具有良好的擴(kuò)展性和可用性。

所以，你打算用哪個(gè)?

2. 運(yùn)行 xxl-job

我們先把 xxl-job 跑起來(lái)，再寫我們自己的代碼。

首先我們先把 xxl-job 的代碼搞下來(lái)，地址：

https://github.com/xuxueli/xxl-job

然后用 IDEA 打開項(xiàng)目，打開之后，有四個(gè)主要的文件夾：

• doc：項(xiàng)目文檔
• xxl-job-admin：任務(wù)調(diào)度平臺(tái)
• xxl-job-core：核心代碼
• xxl-job-executor-samples：案例

由于 xxl-job 運(yùn)行需要數(shù)據(jù)庫(kù)，所以接下來(lái)我們就來(lái)配置數(shù)據(jù)庫(kù)，先找到數(shù)據(jù)庫(kù)腳本，在 doc/db/tables_xxl_job.sql 位置。

找到數(shù)據(jù)庫(kù)腳本后，導(dǎo)入到數(shù)據(jù)庫(kù)中執(zhí)行一下，執(zhí)行完成后，生成如下庫(kù)和表：

接下來(lái)找到 xxl-job-admin/src/main/resources/application.properties 文件，修改數(shù)據(jù)庫(kù)連接信息：

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

日志配置也要修改一下，在 xxl-job-admin/src/main/resources/logback.xml 文件中，有如下一行：

<property name="log.path" value="/data/applogs/xxl-job/xxl-job-admin.log"/>

如果你是 Windows 操作系統(tǒng)，這里肯定要改，如果你是 Mac 的話，也有可能沒有這個(gè)目錄的權(quán)限，因此我建議大家改一下這里的配置，改為如下這樣：

<property name="log.path" value="./applogs/xxl-job/xxl-job-admin.log"/>

改為在項(xiàng)目運(yùn)行目錄下生成這個(gè)日志文件。

修改完成后，接下來(lái)我們就可以啟動(dòng) xxl-job-admin 項(xiàng)目了，這是一個(gè) SpringBoot 項(xiàng)目，找到啟動(dòng)類，直接運(yùn)行其 main 方法即可。

項(xiàng)目啟動(dòng)成功后，瀏覽器輸入如下地址 http://localhost:8080/xxl-job-admin/toLogin，就可以看到登錄頁(yè)面了：

默認(rèn)的登錄賬號(hào)是 admin/123456。

看到如下頁(yè)面，就是登錄成功了。

3. 開發(fā)定時(shí)任務(wù)

3.1 項(xiàng)目創(chuàng)建及配置

接下來(lái)我們來(lái)創(chuàng)建一個(gè)項(xiàng)目，跑一個(gè)定時(shí)任務(wù)看看。

首先創(chuàng)建一個(gè) SpringBoot 項(xiàng)目，引入 Web 依賴，如下：

項(xiàng)目創(chuàng)建成功后，引入 xxl-job 的依賴：

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

然后在 resources 目錄下加入 logback.xml，內(nèi)容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds">

    <contextName>logback</contextName>
    <property name="log.path" value="./applogs/xxl-job/xxl-job-executor-sample-springboot.log"/>

    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n
            </pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
    </root>

</configuration>

修改 application.properties 文件，內(nèi)容如下：

# web port
server.port=8089

# 日志配置
logging.config=classpath:logback.xml

# 配置調(diào)度中心地址
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

# 執(zhí)行器和調(diào)度中心之間的通信令牌，如果沒有配置，表示關(guān)閉了通信令牌的校驗(yàn)。
# 在 xxl-job-admin 的配置文件中，有一個(gè)一模一樣的配置項(xiàng)，兩邊都配置，就會(huì)進(jìn)行校驗(yàn)。
xxl.job.accessToken=

# 配置執(zhí)行器的名字
xxl.job.executor.appname=xxl-job-demo
# 執(zhí)行器地址，如果沒有配置，就使用 IP:PORT 作為默認(rèn)值
xxl.job.executor.address=
# 執(zhí)行器 ip 地址
xxl.job.executor.ip=
# 執(zhí)行器端口，默認(rèn)即 9999
xxl.job.executor.port=9999
# 執(zhí)行器日志文件位置
xxl.job.executor.logpath=./applogs/xxl-job/jobhandler
# 執(zhí)行器日志保存時(shí)間
xxl.job.executor.logretentiondays=30

各項(xiàng)配置的含義我已經(jīng)加了注釋了。

接下來(lái)再提供一個(gè)配置類，如下：

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;

    @Value("${xxl.job.accessToken}")
    private String accessToken;

    @Value("${xxl.job.executor.appname}")
    private String appname;

    @Value("${xxl.job.executor.address}")
    private String address;

    @Value("${xxl.job.executor.ip}")
    private String ip;

    @Value("${xxl.job.executor.port}")
    private int port;

    @Value("${xxl.job.executor.logpath}")
    private String logPath;

    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;


    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppname(appname);
        xxlJobSpringExecutor.setAddress(address);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
        return xxlJobSpringExecutor;
    }

}

其實(shí)就是把剛剛 application.properties 中的屬性都配置成一個(gè) XxlJobSpringExecutor Bean，很奇怪官方為什么沒把這個(gè)搞成一個(gè)自動(dòng)化配置的 Bean。

接下來(lái)我們就可以創(chuàng)建一個(gè)具體的定時(shí)任務(wù)了。

3.2 定時(shí)任務(wù)開發(fā)方式

對(duì)于我們 Java 工程師而言，有三種開發(fā)定時(shí)任務(wù)的方式。

3.2.1 BEAN 模式(類形式)

Bean 模式任務(wù)，支持基于類的開發(fā)方式，每個(gè)任務(wù)對(duì)應(yīng)一個(gè) Java 類。

優(yōu)點(diǎn)：不限制項(xiàng)目環(huán)境，兼容性好。即使是無(wú)框架項(xiàng)目，如 main 方法直接啟動(dòng)的項(xiàng)目也可以提供支持。

缺點(diǎn)：

• 每個(gè)任務(wù)需要占用一個(gè)Java類，造成類的浪費(fèi);
• 不支持自動(dòng)掃描任務(wù)并注入到執(zhí)行器容器，需要手動(dòng)注入。

開發(fā)方式：

• 開發(fā)一個(gè)繼承自 com.xxl.job.core.handler.IJobHandler 的 JobHandler 類，實(shí)現(xiàn)其中任務(wù)方法。
• 手動(dòng)通過(guò)如下方式注入到執(zhí)行器容器：

XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());

• 在調(diào)度中心新建調(diào)度任務(wù)(后續(xù)步驟和 3.2.1 BEAN 模式(方法形式) 一致)。

這種方式用的不多，我就不給大家演示了，小伙伴們可以自行嘗試。

3.2.2 BEAN模式(方法形式)

Bean 模式任務(wù)，支持基于方法的開發(fā)方式，每個(gè)任務(wù)對(duì)應(yīng)一個(gè)方法，一般推薦這種方式。

優(yōu)點(diǎn)：

• 每個(gè)任務(wù)只需要開發(fā)一個(gè)方法，并添加 ”@XxlJob” 注解即可，更加方便、快速。
• 支持自動(dòng)掃描任務(wù)并注入到執(zhí)行器容器。

缺點(diǎn)：

• 要求 Spring 容器環(huán)境。

基于方法開發(fā)的任務(wù)，底層會(huì)生成 JobHandler 代理，和基于類的方式一樣，任務(wù)也會(huì)以 JobHandler 的形式存在于執(zhí)行器任務(wù)容器中。

開發(fā)步驟：

• 開發(fā) Job 方法：

@Component
public class MyJob {
    @XxlJob("demoJobHandler")
    public ReturnT<String> demoJobHandler() throws Exception {
        String param = XxlJobHelper.getJobParam();
        XxlJobHelper.log("XXL-JOB, Hello World：{}",param);
        return ReturnT.SUCCESS;
    }
}

這里的 @XxlJob 注解標(biāo)記了這是一個(gè)定時(shí)任務(wù)方法，該注解還有 init 和 destroy 屬性，可以分別用來(lái)配置初始化和銷毀的方法。

XxlJobHelper.getJobParam() 可以用來(lái)獲取任務(wù)參數(shù)。

在這個(gè)過(guò)程中，我們需要通過(guò) XxlJobHelper.log 打印執(zhí)行日志。

默認(rèn)任務(wù)結(jié)果為 "成功" 狀態(tài)，不需要主動(dòng)設(shè)置;如有訴求，比如設(shè)置任務(wù)結(jié)果為失敗，可以通過(guò) XxlJobHelper.handleFail/handleSuccess 自主設(shè)置任務(wù)結(jié)果。

然后啟動(dòng) SpringBoot 項(xiàng)目。

• 配置調(diào)度中心，新建調(diào)度任務(wù)

接下來(lái)打開配置調(diào)度中心，找到執(zhí)行器管理，點(diǎn)擊新增，如下：

如果是自動(dòng)注冊(cè)的話，可以不用填機(jī)器地址。

接下來(lái)找到任務(wù)管理，并點(diǎn)擊新增：

基礎(chǔ)配置都沒啥好說(shuō)的。

調(diào)度類型選擇 CRON 表達(dá)式，CRON 表達(dá)式可以自己填，也可以點(diǎn)擊后面的編輯按鈕自動(dòng)生成。

運(yùn)行模式就選擇 BEAN，JobHandler 的值就是我們前面 @XxlJob 注解中填的值，任務(wù)參數(shù)就是定時(shí)任務(wù)的方法參數(shù)。

配置完成后，回到執(zhí)行器管理，點(diǎn)擊查看，可以查看剛剛注冊(cè)的節(jié)點(diǎn)信息：

再次回到任務(wù)管理，選擇啟動(dòng)，就可以開始定時(shí)任務(wù)的執(zhí)行了：

開啟之后，點(diǎn)擊調(diào)度日志，就可以看到我們系統(tǒng)任務(wù)執(zhí)行的詳細(xì)信息了：

可以看到，每隔 5 秒執(zhí)行一次。

點(diǎn)擊調(diào)度備注，可以查看一些調(diào)度細(xì)節(jié)：

在右邊操作按鈕中選擇執(zhí)行日志：

可以查看執(zhí)行細(xì)節(jié)：

紅色框出來(lái)的，就是我們剛剛自己打印的。

當(dāng)然這里還有一些其他玩法，小伙伴們可以自行點(diǎn)擊按鈕嘗試，我就不贅述了。

3.2.3 GLUE 模式(Java)

任務(wù)以源碼方式維護(hù)在調(diào)度中心，支持通過(guò) Web IDE 在線更新，實(shí)時(shí)編譯和生效，因此不需要指定 JobHandler。即在網(wǎng)頁(yè)上寫定時(shí)任務(wù)的代碼，然后去執(zhí)行。

這種方式個(gè)人感覺使用較少，小伙伴們了解一下即可。

開發(fā)流程如下：

• 調(diào)度中心->任務(wù)管理，新建調(diào)度任務(wù)，新建時(shí)選擇 “GLUE模式(Java)”：

開發(fā)任務(wù)代碼：選中指定任務(wù)，點(diǎn)擊該任務(wù)右側(cè) GLUE 按鈕，將會(huì)前往 GLUE 任務(wù)的 Web IDE 界面，在該界面支持對(duì)任務(wù)代碼進(jìn)行開發(fā)(也可以在IDE中開發(fā)完成后，復(fù)制粘貼到編輯中)。

編輯完成后，保存即可。接下來(lái)又和前面一樣了，啟動(dòng)任務(wù)，后查看調(diào)度日志。

這里支持 30 個(gè)版本的版本回溯，在 GLUE 任務(wù)的 Web IDE 界面，選擇右上角下拉框“版本回溯”，會(huì)列出該 GLUE 的更新歷史，選擇相應(yīng)版本即可顯示該版本代碼，保存后 GLUE 代碼即回退到對(duì)應(yīng)的歷史版本。