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

这篇具有很好参考价值的文章主要介绍了SpringBoot 集成 xxl-job 实现定时任务管理。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

xxl-job定时任务,Spring-Boot,spring boot,后端,java

摘要

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文件导入下面表。
xxl-job定时任务,Spring-Boot,spring boot,后端,java

3. 修改数据库连接配置

数据库连接配置在项目目录 xxl-job-admin/src/main/resources/application.properties ,如果需要配置发送邮箱则需要配置 spring.mail 下所有配置信息。
xxl-job定时任务,Spring-Boot,spring boot,后端,java

4. 启动项目

在IDEA 启动项目后,访问:http://localhost:8080/xxl-job-admin,默认账号:admin,密码:123456
xxl-job定时任务,Spring-Boot,spring boot,后端,java
登录进来后主页:
xxl-job定时任务,Spring-Boot,spring boot,后端,java
后续需要配置执行器和任务都是在这个页面上完成的。

项目集成

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,登录进去。
xxl-job定时任务,Spring-Boot,spring boot,后端,java
我们选择注册方式是自动,有可能添加完成获取不到在线机器;这时候我们只需要重启一下我们自己的项目即可自动获取成功。
xxl-job定时任务,Spring-Boot,spring boot,后端,java

添加任务

xxl-job定时任务,Spring-Boot,spring boot,后端,java

执行任务

我们启动任务后可以在调度日志上查看执行记录。
xxl-job定时任务,Spring-Boot,spring boot,后端,java

查看调度日志

xxl-job定时任务,Spring-Boot,spring boot,后端,java
至此,您的Spring Boot应用程序已经集成了XXL-Job。当配置的触发器满足条件时,xxl-job执行器将会自动调用对应的JobHandler方法进行任务处理。文章来源地址https://www.toymoban.com/news/detail-709411.html

到了这里,关于SpringBoot 集成 xxl-job 实现定时任务管理的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • XXL-JOB定时任务框架(Oracle定制版)

    xxl-job是一个轻量级、易扩展的分布式任务调度平台,能够快速开发和简单学习。开放源代码并被多家公司线上产品使用,开箱即用。尽管其确实非常好用,但我在工作中使用的是Oracle数据库,因为xxl-job是针对MySQL设计的,所以使用起来需要进行一些魔改。为了方便后人使用,

    2023年04月13日
    浏览(43)
  • springcloud:快速上手定时任务框架xxl-job(十五)

    实际开发中,我们常常遇到需要定时执行的任务,我们可以利用定时线程池或schedule框架等来实现定时任务,但这些方式都有效率、性能上的缺陷,在微服务框架下,我们期望一种更加规整、轻量、可靠的定时任务框架来帮助我们实现定时任务,以及可视化的管理定时任务。

    2023年04月08日
    浏览(34)
  • Spring Boot 3 整合 xxl-job 实现分布式定时任务调度,结合 Docker 容器化部署(图文指南)

    xxl-job 是一个分布式任务调度平台,它提供了强大的任务调度和执行能力,可以帮助我们实现任务的自动化调度和执行。本文将介绍如何在 Docker 环境下部署 xxl-job,并将其与 Spring Boot 进行整合。 数据库脚本:tables_xxl_job-2.4.0.sql Docker 镜像地址: https://hub.docker.com/r/xuxueli/xxl-jo

    2024年02月06日
    浏览(55)
  • Xxl-job安装部署以及SpringBoot集成Xxl-job使用

    1、安装Xxl-job: 可以使用docker拉取镜像部署和源码编译两种方式,这里选择源码编译安装。 代码拉取地址: 官方开发文档: 2、打开项目 使用Maven打开项目,下载相关的jar包依赖。配置相关配置文件 这里可以参考官方开发文档进行配置。 3、初始化数据库 项目中包含数据库

    2023年04月25日
    浏览(33)
  • 第三代开源定时任务框架PowerJob-比xxl-job 更强大!

    这倒是勾起了我的好奇心,因为前段时间用  xxl-job 替换掉了同样不太好用的 QuartZ ,那时候还没有调研 PowerJob。于是这次研究了一番, 发现 PowerJob 确实是个很棒的框架 ,在这里推荐给大家。 PowerJob是新一代分布式任务调度与计算框架,支持CRON、API、固定频率、固定延迟等

    2023年04月10日
    浏览(29)
  • 【手把手】分布式定时任务调度解析之xxl-job

    在之前我写的讲解Quartz中有介绍过,Quartz有差不多二十年的历史,调度模型已经非常成熟了,而且很容易集成到Spring中去,用来执行业务任务是一个很好的选择。但是越早的设计存在的问题也越明显,比如: 1、调度逻辑(Scheduler)和任务类耦合在同一个项目中,随着调度任

    2024年01月19日
    浏览(51)
  • 分布式定时任务系列8:XXL-job源码分析之远程调用

    分布式定时任务系列1:XXL-job安装 分布式定时任务系列2:XXL-job使用 分布式定时任务系列3:任务执行引擎设计 分布式定时任务系列4:任务执行引擎设计续 分布式定时任务系列5:XXL-job中blockingQueue的应用 分布式定时任务系列6:XXL-job触发日志过大引发的CPU告警 分布式定时任

    2024年01月21日
    浏览(44)
  • xxl-job 集成 SpringBoot 使用

      如果您觉得有用的话,记得给 博主点个赞,评论,收藏一键三连啊 ,写作不易啊^ _ ^。   而且听说 点赞的人每天的运气都不会太差 ,实在白嫖的话,那欢迎常来啊!!! xxl-job 集成 SpringBoot 使用 1. xxl-job 安装部署超链接 xxl-job 7.32版本 安装部署 2. 启动xxl-job 3. 集成 Sprin

    2024年02月04日
    浏览(24)
  • Spring@Scheduled定时任务接入XXL-JOB的一种方案(基于SC Gateway)

    目前在职的公司,维护着Spring Cloud分布式微服务项目有25+个。其中有10个左右微服务都写有定时任务逻辑,采用Spring @Scheduled这种方式。 Spring @Scheduled定时任务的缺点: 不支持集群:为避免重复执行,需引入分布式锁 死板不灵活:不支持手动执行,单次执行,补偿执行,修改

    2024年02月11日
    浏览(33)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包