1. 程式人生 > 實用技巧 >xxl-job專案定時管理工具

xxl-job專案定時管理工具

1.原始碼下載地址:

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

2.將原始碼clone到IDEA中:

3.初始化資料庫指令碼:/doc/db/tables_xxl_job.sql ;

4.xxl-job-admin的配置檔案application.properties:

### web
### 1、排程中心專案的埠號以及訪問路徑
server.port=8081
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled
=false ### resources spring.mvc.servlet.load-on-startup=0 spring.mvc.static-path-pattern=/static/** spring.resources.static-locations=classpath:/static/ ### freemarker spring.freemarker.templateLoaderPath=classpath:/templates/ spring.freemarker.suffix=.ftl spring.freemarker.charset=UTF-8 spring.freemarker.request-context-attribute=request spring.freemarker.settings.number_format=0.########## ### mybatis mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml #mybatis.type-aliases-package=com.xxl.job.admin.core.model ### xxl-job, datasource ### 5、配置資料庫的地址 spring.datasource.url=jdbc:mysql://10.0.204.214:8080/b2b_provider?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai spring.datasource.username=dev spring.datasource.password=D@_uat_0715 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver ### datasource-pool spring.datasource.type=com.zaxxer.hikari.HikariDataSource spring.datasource.hikari.minimum-idle=10 spring.datasource.hikari.maximum-pool-size=30 spring.datasource.hikari.auto-commit=true spring.datasource.hikari.idle-timeout=30000 spring.datasource.hikari.pool-name=HikariCP spring.datasource.hikari.max-lifetime=900000 spring.datasource.hikari.connection-timeout=10000 spring.datasource.hikari.connection-test-query=SELECT 1 ### xxl-job, email spring.mail.host=smtp.qq.com spring.mail.port=25 [email protected] [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= ### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en") xxl.job.i18n=zh_CN ## xxl-job, triggerpool max size xxl.job.triggerpool.fast.max=200 xxl.job.triggerpool.slow.max=100 ### xxl-job, log retention days xxl.job.logretentiondays=30

5.部署排程中心

該工程是一個springboot專案,我們只需要在IDEA中執行XxlJobAdminApplication 類即可執行該工程;

6.在瀏覽器輸入http://localhost:8080/xxl-job-admin然後輸入使用者名稱和密碼(admin/123456);

二、建立自己專案的執行器:

1.引入jar包:

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

注:如果不是maven專案,則需要在idea中執行maven-》install 打出jar包,將jar包引入;

2.把xxl-job執行器的xxl-job-executor.properties檔案copy至專案的resources資料夾下

3.配置xxl-job-executor.properties檔案

# 排程中心地址
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
 
#執行器"AppName"和地址資訊配置:AppName執行器心跳註冊分組依據;地址資訊用於"排程中心請求並觸發任務"和"執行器註冊"。執行器預設埠為9999,執行器IP預設為空表示自動獲取IP,多網絡卡時可手動設定指定IP,該IP不會繫結Host僅作為通訊實用。單機部署多個執行器時,注意要配置不同執行器埠;
 
xxl.job.executor.appname=task-demo02
xxl.job.executor.ip=
xxl.job.executor.port=9998
​
#執行器通訊TOKEN,非空時啟用
xxl.job.accessToken=
#xxl-job log path執行器執行日誌檔案儲存的磁碟位置,需要對該路徑擁有讀寫許可權
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
#xxl-job log retention days執行器Log檔案定期清理功能,指定日誌儲存天數,日誌檔案過期自動刪除。限制至少保持3天,否則功能不生效;
xxl.job.executor.logretentiondays=30

4.配置applicationContext.xml檔案

5.載入配置檔案,在專案中建立 XxlJobConfig.class 檔案:

package com.taskDemo.core.config;
 
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
/**
 * xxl-job config
 *
 * @author xuxueli 2017-04-28
 */
@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
    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;
    }
 
    /**
     * 針對多網絡卡、容器內部署等情況,可藉助 "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();
     */
 
 
}

6.建立任務JobHandler

package com.taskDemo.service.jobhandler;
 
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import org.springframework.stereotype.Component;
 
/**
 * @Description 排程任務類
 * @Date Created in 下午8:19 2020/2/15
 * @Version 1.0
 */
@Component
public class TaskHandler extends IJobHandler {
 
    @XxlJob("taskDemoHandler")
    @Override
    public ReturnT<String> execute(String param) throws Exception {
        XxlJobLogger.log("接受引數" + param +"\n執行任務");
        return SUCCESS;
    }
}

7.在排程任務中心配置執行器

點選執行器管理-->新增執行器 注意AppName為執行器專案應用名,即上面引數xxl.job.executor.appname=task-demo02

8.建立任務

點選任務管理-->新增 執行器下拉列表選擇剛新增的執行器 注意JobHandler為上面排程任務類@JobHandler(value="taskDemoHandler")中value值

  1. <dependency>
  2. <groupId>com.xuxueli</groupId>
  3. <artifactId>xxl-job-core</artifactId>
  4. <version>2.1.2</version>
  5. </dependency>