springboot使用xxl-job

簡介

XXL-JOB是一個分布式任務排程平台，其核心設計目标是開發迅速、學習簡單、輕量級、易擴充。現已開放源代碼可以根據自己需要進行修改，開箱即用，非常爽；

部署xxl-job項目

首先去github上下載下傳：https://github.com/xuxueli/xxl-job/

下載下傳源碼，然後在本地進行編譯

修改配置xxl-job-admin中的application.properties

server.port=8080
server.servlet.context-path=/xxl-job-admin
### xxl-job, datasource
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=xxx
spring.datasource.password=xxxxx
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
[email protected]
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### xxl-job, access token
xxl.job.accessToken=xxxxxx  
           

配置很多，但是隻需要修改上面這幾個，最好将xxl.job.accessToken添加上進行token驗證

修改完打包部署

部署完可以通過位址檢視管理頁面：http://127.0.0.1:8080/xxl-job-admin/

預設賬号密碼admin 123456，可以登入進去看看

引入項目

建立網關項目pom檔案中引入jar包

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

在配置檔案中增肌配置

xxl:
  job:
    accessToken: xxxxxx  #修改的token秘鑰
    admin:
      addresses: http://10.1.11.60:8080/xxl-job-admin/   #上面部署xxl-job-admin位址
    executor:
      appname: dayunmotor-tsp-gateway-xxl-job  #本項目名稱
      ip: 10.1.5.27 #這個是本項目部署位址和端口
      port: 30003   #注意這裡不是本項目的端口是xxl-job執行請求的端口
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30
           

在項目中增加配置類

@Slf4j
@Configuration
public class XxlJobConfig {

    @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.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() {
        log.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;
    }
}
           

增加定時任務

@Slf4j
@Component
public class RemoteUpgradeTask extends IJobHandler {

    @XxlJob(value = "remoteUpgradeTask")
    public ReturnT<String> execute(String s) throws Exception {
        try {
            log.info("執行任務");
            return IJobHandler.SUCCESS;
        } catch (Exception e) {
            log.error("執行任務異常", e);
            return new ReturnT<>(IJobHandler.FAIL.getCode(), "執行任務失敗");
        }
    }
    //執行初始化方法
    @Override
    public void init() throws InvocationTargetException, IllegalAccessException {
        super.init();
    }
    //執行銷毀方法
    @Override
    public void destroy() throws InvocationTargetException, IllegalAccessException {
        super.destroy();
    }
}
           

然後去xxl-job-admin中增加執行器，增加完啟動項目，可以看到啟動的執行器

然後建立定時任務：注意這裡的JobHandler就是代碼裡的 @XxlJob(value = “remoteUpgradeTask”)

建立完啟動任務，就可以執行了，這個就完成了

不過如果使用windows的時候注意關閉防火牆，不然沒法注冊上去