官方文檔：https://www.xuxueli.com/xxl-job/

XXL-JOB 是一個分布式任務(wù)調(diào)度平臺，其核心設(shè)計目標是開發(fā)迅速、學(xué)習(xí)簡單、輕量級、易擴展。現(xiàn)已開放源代碼并接入多家公司線上產(chǎn)品線，開箱即用。

說明：官方文檔很重要，而且非常詳細，要慢慢適應(yīng)看官方文檔進行學(xué)習(xí)！

PS：下面搭建和整合流程是基于項目需求進行整理的，和普通學(xué)習(xí)流程一致，就是有一些命名沒那么測試化，自行體會。

xxl-job 環(huán)境搭建

1. 下載

下載地址：https://github.com/xuxueli/xxl-job/releases

建議：直接下載最新版，如目前我下的是 2.4.0，之前的 2.3.0 用的有問題。

說明：下載解壓后，使用 IDEA 打開。

2. 數(shù)據(jù)庫表導(dǎo)入

SQL 位置：doc/db/tables_xxl_job.sql

說明：導(dǎo)入到自己的數(shù)據(jù)庫中。

3. 修改配置數(shù)據(jù)

說明：以下兩個配置必須修改，否則啟動報錯！

3.1 修改 application.properties

配置文件位置：xxl-job-admin 下的 src/main/resources/application.properties

server.port=7397 #【自選】，修改后，后面自己執(zhí)行器項目配置中需要對應(yīng)換改的這個端口

# 數(shù)據(jù)源配置信息，對應(yīng)改成自己的。
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=luis
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 【重要！說明：此 accessToken xxl-job 配置了默認的，你自己的執(zhí)行器項目中 accessToken 必須保持一致】
xxl.job.accessToken=default_token

3.2 修改 logback.xml

日志配置文件位置：xxl-job-admin 下的 src/main/resources/logback.xml

<!-- 日志文件保存位置改成自己的，可按如下示例放到項目根目錄下 -->
<property name="log.path" value="D:/1a-Projects/lw-projects/tool-projects/xxl-job-2.3.0/data/applogs/xxl-job/xxl-job-admin.log"/>

4. 運行訪問

運行 xxl-job-admin 下的主啟動類啟動項目，瀏覽器輸入地址訪問：http://localhost:7397/xxl-job-admin/toLogin

PS：若是免登陸的，則忽略下面賬號密碼。

默認登陸賬號：admin

默認登陸密碼：123456

5. 其他

這里簡單說明下，xxl-job-executor-samples 下有兩個示例執(zhí)行器模板項目，有多種任務(wù)使用方式，后續(xù)可自行參考模板項目以及官方文檔，進行學(xué)習(xí)使用，下面直接介紹 Spring Boot 中簡單使用 XXL-JOB。

Spring Boot 整合 XXL-JOB

新建 Spring Boot 項目，準備進行整合。

1. 添加 pom

<!-- xxl-job-core（建議根據(jù)下載的 xxl-job 自行適配版本）-->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version>
</dependency>

2. 添加配置信息

幾個核心配置：調(diào)度中心地址、執(zhí)行器名稱、執(zhí)行器端口、執(zhí)行器日志路徑、執(zhí)行器通訊 token

# xxl-job
# 官網(wǎng)：https://github.com/xuxueli/xxl-job/
# 地址：http://localhost:7397/xxl-job-admin 【需要先啟動 xxl-job】
# 賬號：admin
# 密碼：123456
xxl:
  job:
    admin:
      ### 調(diào)度中心部署根地址 [選填]：如調(diào)度中心集群部署存在多個地址則用逗號分隔。執(zhí)行器將會使用該地址進行"執(zhí)行器心跳注冊"和"任務(wù)結(jié)果回調(diào)"；為空則關(guān)閉自動注冊；
      addresses: http://127.0.0.1:7397/xxl-job-admin
    executor:
      ### 執(zhí)行器注冊 [選填]：優(yōu)先使用該配置作為注冊地址，為空時使用內(nèi)嵌服務(wù) ”IP:PORT“ 作為注冊地址。從而更靈活的支持容器類型執(zhí)行器動態(tài)IP和動態(tài)映射端口問題。
      address:
      ### 執(zhí)行器AppName [選填]：執(zhí)行器心跳注冊分組依據(jù)；為空則關(guān)閉自動注冊
      appname: lottery-job
      ### 執(zhí)行器IP [選填]：默認為空表示自動獲取IP，多網(wǎng)卡時可手動設(shè)置指定IP，該IP不會綁定Host僅作為通訊實用；地址信息用于 "執(zhí)行器注冊" 和 "調(diào)度中心請求并觸發(fā)任務(wù)"；
      ip:
      ### 執(zhí)行器端口號 [選填]：小于等于0則自動獲取；默認端口為9999，單機部署多個執(zhí)行器時，注意要配置不同執(zhí)行器端口；
      port: 9998
      ### 執(zhí)行器運行日志文件存儲磁盤路徑 [選填] ：需要對該路徑擁有讀寫權(quán)限；為空則使用默認路徑；
      logpath: D:/1a-Projects/lw-projects/tool-projects/xxl-job-2.3.0/data/applogs/xxl-job/jobhandler
      ### 執(zhí)行器日志文件保存天數(shù) [選填] ： 過期日志自動清理, 限制值大于等于3時生效; 否則, 如-1, 關(guān)閉自動清理功能；
      logretentiondays: 50
    ### 執(zhí)行器通訊TOKEN [選填]：非空時啟用；
    accessToken: default_token

3. 添加配置類

@Configuration
public class LotteryXxlJobConfig {

    private Logger logger = LoggerFactory.getLogger(LotteryXxlJobConfig.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;
    }

    /**********************************************************************************************
     * 針對多網(wǎng)卡、容器內(nèi)部署等情況，可借助 "spring-cloud-commons" 提供的 "InetUtils" 組件靈活定制注冊IP；
     *
     *      1、引入依賴：
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置文件，或者容器啟動變量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、獲取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     **********************************************************************************************/
    
}

4. 添加任務(wù)類

@Component
public class LotteryXxlJob {

    private Logger logger = LoggerFactory.getLogger(LotteryXxlJob.class);
	
    // 簡單任務(wù)
    @XxlJob("lotteryActivityStateJobHandler")
    public void lotteryActivityStateJobHandler() throws Exception {

        logger.info("我是被 xxl-job 自動調(diào)用執(zhí)行的任務(wù)！");

    }

}

5. 啟動項目

PS：必須保證 xxl-job 項目先正常啟動，并且任務(wù)調(diào)度中心可訪問。此項目必須后啟動！

6. 任務(wù)調(diào)度中心配置任務(wù)

說明：必須先創(chuàng)建執(zhí)行器，再創(chuàng)建任務(wù)！

6.1 新增執(zhí)行器

訪問任務(wù)調(diào)度中心：http://localhost:7397/xxl-job-admin/

進入執(zhí)行器管理，新增執(zhí)行器，填寫信息：

• AppName ：填自己 Spring Boot 項目中配置的 appname，如上面項目的 lottery-job
• 名稱：隨便寫，即執(zhí)行器名
• 注冊方式：選自動注入

然后保存即可！

6.2 新增任務(wù)

進入任務(wù)管理，新增任務(wù)，填寫信息：

• 執(zhí)行器：選擇上步中填寫的執(zhí)行器名稱
• 任務(wù)描述：自行描述
• 負責人：xxx
• 調(diào)度類型：CRON
• CRON 表達式：自行定制，如 0/1 * * * * ?，表示每秒執(zhí)行一次
• 運行模式：BEAN
• JobHandler：填上面 Spring Boot 項目任務(wù)類方法上 @XxlJob 注解中的名稱，如：lotteryActivityStateJobHandler

然后保存即可?。ㄆ渲杏行┡渲每勺孕性O(shè)置）

7. 任務(wù)操作

在任務(wù)管理下，可對新增的任務(wù)進行操作，如啟動、執(zhí)行一次等

點擊啟動或執(zhí)行一次后，可觀察 Spring Boot 項目后臺任務(wù)的日志打印情況，測試驗證。

以上，整合完成。文章來源地址http://www.zghlxwxcb.cn/news/detail-411834.html

到了這里，關(guān)于Spring Boot 整合 xxl-job的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！