xxl-job學習筆記(一)——使用xxl-job搭建作業調度平臺

前言

最近項目需要引入作業調度相關功能，打算引入xxl-job，因爲之前在公司參與過作業調度相關的開發，打算系統的記錄下學習使用和分析的過程

搭建調度中心

拋開架構和原理，拿到一個新東西，首先讓我們能夠使用起來，搭建一個自己的任務
第一步: 下載源碼
下載地址：https://github.com/xuxueli/xx...
第二步: 執行sql
文件地址：xxl-job/doc/db/tables_xxl_job.sql
第三步: 修改xxl-job-admin項目配置
配置文件：application.properties
配置項：

### xxl-job, datasource
spring.datasource.url=${datasource.url}
spring.datasource.username=${datasource.username}
spring.datasource.password=${datasource.password}

打包命令:

 xxl-job-admin git:(master) ✗ mvn clean -U package -Dmaven.test.skip=true

啓動命令：

➜  xxl-job-admin git:(master) ✗ cd target 
➜  target git:(master) ✗ java -jar xxl-job-admin-2.1.0.jar 

訪問http://localhost:18827/xxl-jo...
賬號：admin
密碼：123456
看到如下頁面即搭建成功

編寫代碼

第一步： 搭建一個springboot項目，application.properties加入如下配置：

# web port
server.port=8081
# log config
logging.config=classpath:logback.xml
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### xxl-job executor address
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.ip=
xxl.job.executor.port=9999
### xxl-job, access token
xxl.job.accessToken=
### xxl-job log path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job log retention days
xxl.job.executor.logretentiondays=-1

第二步： 編寫配置類

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

    @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;


    @Bean(initMethod = "start", destroyMethod = "destroy")
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        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;
    }

第三步： 編寫jobhandler

@JobHandler(value="demoJobHandler")
@Component
public class DemoJobHandler extends IJobHandler {

    @Override
    public ReturnT<String> execute(String param) throws Exception {
        XxlJobLogger.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobLogger.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        return SUCCESS;
    }

}

第四步： 啓動springboot項目後，配置執行器

點擊保存後

出現這個，即爲配置成功
第五步: 配置jobhandler，新增任務

第六步: 點擊執行一次看看效果

到此springboot整合xxl-job就完成了，在後續添加任務時，只需要編寫相應的handler去繼承IJobHandler即可

更多內容可關注博客：https://www.zplxjj.com和公衆號