SpringBoot集成系列--xxlJob

一、搭建调度中心xxl-job-admin

1、下载项目

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

2、调整项目参数

端口号冲突，修改端口号，数据库密码不一样，改为你的密码

3、执行初始化数据库SQL

4、启动项目

把项目打包成jar包，使用java -jar命令启动

5、访问

访问http://localhost:8087/xxl-job-admin，输入用户名：admin，密码：123456，这个是默认初始化的用户名和密码，登录成功

二、集成步骤

1、添加xxl-job的依赖

引入依赖到pom.xml

<!-- Xxl-Job -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

2、添加xxl-job的依赖

在application.properties添加xxl-job的配置

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

3、配置执行器

初始化并配置xxl-job的执行器，将其集成到Spring Boot应用中。

@Configuration
public class XxlJobConfig {
   
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.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;
    }
}

4、创建执行器

登录调度中心，选择执行器管理菜单，新增一个执行器

AppName就是我们之前配置的application.properties中的xxl.job.executor.appname

到这里已经全部配置完毕，接下来开发我们的任务即可

5、开发任务

1）方式1：BEAN模式（方法形式）

需要新增XxlJobHandler类，每个任务需要开发一个方法，并添加"@XxlJob"注解，如下

package cn.forlan.job;

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

@Component
public class MyXxlJobHandler {
   

    @XxlJob("myXxlJobHandler")
    public void execute() throws Exception {
   
        // 任务执行逻辑
        System.out.println("MyXxlJobHandler is running.");
        XxlJobHelper.log("MyXxlJobHandler is running.");
    }
}

选择任务管理菜单，新增任务，JobHandler填写上myXxlJobHandler，填完所有信息，保存即可

2）方式2：GLUE模式(Java)

直接在调度中心，新建调度任务，运行模式选中 “GLUE模式(Java)”

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面

编写我们的代码，保存即可

6、测试

选择执行一次，就可以看到成功执行

查看日志，就可以看到我们的执行情况

三、总结

xxl-job包括调度中心和执行器两个主要部分，调度中心负责管理调度信息，按照调度配置发出调度请求，执行器负责接收调度请求并执行对应的JobHandler中业务逻辑。通过这种方式，“调度”和“任务”两部分可以相互解耦，提高系统整体稳定性和扩展性。

大概原理如下：

• 任务注册：任务的注册是通过在xxl-job-admin管理平台上配置任务信息，包括任务名称、执行器地址、任务参数等。
• 任务调度：xxl-job-admin管理平台会根据任务的配置信息，将任务调度信息写入数据库。调度中心会定时扫描数据库，根据任务的调度策略和触发器条件，选择合适的执行器节点进行任务调度。
• 任务执行：执行器节点会定时向调度中心发送心跳请求，获取待执行的任务。调度中心根据任务的调度策略，将任务分配给执行器节点。执行器节点接收到任务后，根据任务的类型和参数进行任务的执行。
• 任务监控：xxl-job提供了任务监控功能，可以查看任务的执行情况、日志和统计信息。执行器节点会将任务的执行情况和日志信息上报给调度中心，调度中心将这些信息存储在数据库中，供用户查看。

通过以上功能，xxl-job实现了分布式任务的调度和执行，提供了可靠、高效的任务调度解决方案。