SpringBoot 集成 xxl-job 实现定时任务管理

摘要

XXL-Job是一个功能强大的分布式任务调度框架，集成了Spring Boot后能够发挥更大的优势。它提供了分布式任务调度、任务执行报告、任务调度中心、良好的扩展性、分布式集群部署、监控与报警等多种优势。此外，XXL-Job是开源免费的，可以在GitHub上获取源代码和详细文档。详细的文档和使用指南可以在XXL-Job的官方文档中找到。

XXL-Job 优势

当集成XXL-Job和Spring Boot时，XXL-Job的优势包括：

1. 分布式任务调度：XXL-Job提供了分布式任务调度的能力，可以在多台服务器上同时执行定时、循环、CRON等各类任务。

2. 任务执行报告：XXL-Job提供了任务执行报告，可以查看任务执行情况、执行日志、任务结果等，方便排查问题和监控任务执行状态。

3. 任务调度中心：XXL-Job配备了任务调度中心，通过Web界面进行任务配置和管理，支持动态修改任务配置，实现了可视化的管理和操作。

4. 良好的扩展性：XXL-Job通过编写JobHandler，可以轻松集成各种业务逻辑和任务处理，支持自定义Job开发和管理。

5. 分布式集群部署：XXL-Job支持分布式集群部署，提供可伸缩性和高可用性，适应大规模和高并发任务调度场景。

6. 监控与报警：XXL-Job提供丰富的监控指标和报警机制，可以及时发现任务执行异常和错误，并通过邮件、短信等方式进行提醒。

7. 开源免费：XXL-Job是一个开源项目，可以免费使用并在GitHub上获取源代码和文档。

您可以在 XXL-Job的官方文档 上找到更详细的文档和使用指南。该文档包含XXL-Job的安装部署、任务配置、调度策略、任务执行报告等方面的详细说明和示例代码。

集成XXL-Job

操作环境

• MAC10.15系统
• Maven3.8.6
• Jdk1.8
• Mysql8.0
• IDEA2021

运行XXL-Job

1. 下载XXL-Job

参考官方文档，我们需要下载一个xxl-job项目。
Gitee
Github

2. 创建数据库并导入数据

从Gitee上下载下来的源码文件目录 /xxl-job/doc/db 下面有SQL文件 tables_xxl_job.sql ,然后再数据库创建数据库 xxl-job，我这里是和系统默认的一样也可以自己修改数据库名称；然后运行SQL文件导入下面表。

3. 修改数据库连接配置

数据库连接配置在项目目录 xxl-job-admin/src/main/resources/application.properties ，如果需要配置发送邮箱则需要配置 spring.mail 下所有配置信息。

4. 启动项目

在IDEA 启动项目后，访问：http://localhost:8080/xxl-job-admin，默认账号：admin，密码：123456

登录进来后主页：

后续需要配置执行器和任务都是在这个页面上完成的。

项目集成

1. 导入依赖

<!-- xxl-job-core依赖 -->
<!-- https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

2. 配置 application.yml 信息

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

3. XxlJobConfig 配置类

这个配置类在我们下载下来的项目中的目录下：xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java ，我们拷贝过来就能使用了。

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

    /**
     * 针对多网卡、容器内部署等情况，可借助 "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();
     */
}

4. 创建 XxlJobTest 任务测试demo

@Slf4j
@Component
@RequiredArgsConstructor
public class XxlJobTest {
    
    

    @XxlJob("xxlJobTest")
    public ReturnT<String> xxlJobTest(String date) {
    
    
        // 获取任务参数
        XxlJobContext xxlJobContext = XxlJobContext.getXxlJobContext();
        String jobParam = xxlJobContext.getJobParam();
        log.info("---------xxlJobTest定时任务执行成功--------{}", jobParam);
        return ReturnT.SUCCESS;
    }
}

测试运行

添加执行器

进入 http://localhost:8080/xxl-job-admin，登录进去。

我们选择注册方式是自动，有可能添加完成获取不到在线机器；这时候我们只需要重启一下我们自己的项目即可自动获取成功。

添加任务

执行任务

我们启动任务后可以在调度日志上查看执行记录。

查看调度日志

至此，您的Spring Boot应用程序已经集成了XXL-Job。当配置的触发器满足条件时，xxl-job执行器将会自动调用对应的JobHandler方法进行任务处理。