XXL-JOB分布式任务调度平台搭建以和和SpringBoot整合应用

1 前言

XXL-JOB 是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

可以前往 Gitee 地址进行下载使用：

https://gitee.com/xuxueli0323/xxl-job.git

 2 架构图

 3 xxl-job-admin 搭建

3.1 拉取代码

代码结构如下：

运行 SQL 文件至本地数据库：

修改 xxl-job-admin 模块的 yml 文件：

3.2 启动任务调度中心

如下图：

浏览器访问默认地址：http://localhost:8080/xxl-job-admin

账号：admin 密码：123456 （初始状态下）。

3.3 登录成功

如下图：

到此为止，第一阶段 xxl-job-admin 模块的部署就完成啦。

4 整合 SpringBoot 项目

此部分官方已经给出具体案例，我们只需对赶方案例进行整合或修改即可。

接下来就是如何整合到自己的 SpringBoot 项目中。

4.1 引入 maven 依赖

如下图：

注意：此处版本要与 xxl-job-admin 中版本保持一致。

4.2 引入配置类

如下图：

只需引入 XxlJobConfig 配置类即可，其他配置类为该项目其他配置类，与此无关！

可以直接从拉取的项目中复制过来，无需任何修改！！！复制此类到你的项目中即可！

1.  
   @Configuration
2.  
   public class XxlJobConfig {
3.  
   private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
4.  
    
5.  
   @Value("${xxl.job.admin.addresses}")
6.  
   private String adminAddresses;
7.  
    
8.  
   @Value("${xxl.job.accessToken}")
9.  
   private String accessToken;
10.  
     
11.  
    @Value("${xxl.job.executor.appname}")
12.  
    private String appname;
13.  
     
14.  
    @Value("${xxl.job.executor.address}")
15.  
    private String address;
16.  
     
17.  
    @Value("${xxl.job.executor.ip}")
18.  
    private String ip;
19.  
     
20.  
    @Value("${xxl.job.executor.port}")
21.  
    private int port;
22.  
     
23.  
    @Value("${xxl.job.executor.logpath}")
24.  
    private String logPath;
25.  
     
26.  
    @Value("${xxl.job.executor.logretentiondays}")
27.  
    private int logRetentionDays;
28.  
     
29.  
     
30.  
    @Bean
31.  
    public XxlJobSpringExecutor xxlJobExecutor() {
32.  
    logger.info(">>>>>>>>>>> xxl-job config init.");
33.  
    XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
34.  
    xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
35.  
    xxlJobSpringExecutor.setAppname(appname);
36.  
    xxlJobSpringExecutor.setAddress(address);
37.  
    xxlJobSpringExecutor.setIp(ip);
38.  
    xxlJobSpringExecutor.setPort(port);
39.  
    xxlJobSpringExecutor.setAccessToken(accessToken);
40.  
    xxlJobSpringExecutor.setLogPath(logPath);
41.  
    xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
42.  
     
43.  
    return xxlJobSpringExecutor;
44.  
    }
45.  
     
46.  
    /**
47.  
    * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
48.  
    *
49.  
    * 1、引入依赖：
50.  
    * <dependency>
51.  
    * <groupId>org.springframework.cloud</groupId>
52.  
    * <artifactId>spring-cloud-commons</artifactId>
53.  
    * <version>${version}</version>
54.  
    * </dependency>
55.  
    *
56.  
    * 2、配置文件，或者容器启动变量
57.  
    * spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
58.  
    *
59.  
    * 3、获取IP
60.  
    * String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
61.  
    */
62.  
     
63.  
     
64.  
    }

4.3 修改 yml 配置文件

代码如下：

1.  
   xxl:
2.  
   job:
3.  
   admin:
4.  
   # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。
5.  
   # 执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
6.  
   addresses: http://127.0.0.1:8086/xxl-job-admin
7.  
   # 执行器通讯TOKEN [选填]：非空时启用；
8.  
   accessToken:
9.  
   executor:
10.  
    # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
11.  
    appname: xxl-job-executor-mileage
12.  
    # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。
13.  
    #从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
14.  
    address:
15.  
    # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；
16.  
    # 地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
17.  
    ip:
18.  
    # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
19.  
    port: 8088
20.  
    # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
21.  
    logpath: /data/applogs/xxl-job/jobhandler
22.  
    # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
23.  
    logretentiondays: 30
24.  
    logging:
25.  
    config: classpath:logback.xml

4.4 编写测试类

代码如下：

1.  
   @Component
2.  
   public class MileageXxlJob {
3.  
   private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
4.  
    
5.  
    
6.  
   /**
7.  
   * 1、简单任务示例（Bean模式）
8.  
   */
9.  
   @XxlJob("mileageJobHandler")
10.  
    public void mileageJobHandler() throws Exception {
11.  
    XxlJobHelper.log("XXL-JOB, Hello World.");
12.  
     
13.  
    for (int i = 0; i < 5; i ) {
14.  
    XxlJobHelper.log("beat at:" i);
15.  
    System.out.println("ok");
16.  
    TimeUnit.SECONDS.sleep(2);
17.  
    }
18.  
    // default success
19.  
    }
20.  
    }

4.5 项目目录

编写完成后，启动服务！（注意启动顺序，先启动 xxl-job-admin 模块，再启动您的 springboot 服务）

4.6 任务调度中心，配置服务

① 新增执行器：

②新增任务：

③执行任务：

注：测试选择执行一次即可，如需项目保持运行，选择启动。

④ 查看运行结果：

到此，XXL-JOB 与 SpringBoot 的简单整合入门教程就完成了，感谢您的查阅！

这篇好文章是转载于：学新通技术网