【xxl-job】SpringBoot零基础集成xxl-job

原创 已于 2025-02-08 17:38:34 修改 · 2.7k 阅读 · 2 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
收录于
Spring Boot

当前文章被收录于：

Spring Boot
41 篇文章 16 人学习

关于Spring Boot框架相关的技术文章

订阅专栏 查看详情
于 2022-03-27 13:50:27 首次发布

【xxl-job】SpringBoot零基础集成xxl-job

摘要

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

xxl-job主要分成两部分:

  • 一部分是xxl-job-admin。这是管理控制台，简单理解就是用于管理和调度任务。
  • 另一部分是xxl-job-core。这主要是帮助开发人员更高效的开发具体的任务，然后与调度中心交互，完成具体任务的执行操作。

官方文档

  • 中文文档: https://www.xuxueli.com/xxl-job/
  • 英文文档: https://www.xuxueli.com/xxl-job/en/
  • Github源码地址: https://github.com/xuxueli/xxl-job

xxl-job-admin部署

  • 下载源码: git clone https://github.com/xuxueli/xxl-job
  • 执行数据库初始化脚本
cd xxl-job
mysql -uroot -proot < doc/db/tables_xxl_job.sql

在这里插入图片描述

  • 修改配置文件application.properties
    • 修改xxl-job-admin启动端口
      在这里插入图片描述
    • 修改数据库配置信息
      在这里插入图片描述
    • 关闭邮件通知服务
      在这里插入图片描述
  • 启动xxl-job-admin
    在这里插入图片描述
    • 输出以下日志代表启动成功
    Connected to the target VM, address: '127.0.0.1:55192', transport: 'socket'

.   ____          _            __ _ _
/\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/  ___)| |_)| | | | | || (_| |  ) ) ) )
'  |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/

:: Spring Boot ::                (v3.4.2)

17:22:29.726 logback [main] INFO  c.x.job.admin.XxlJobAdminApplication - Starting XxlJobAdminApplication using Java 17.0.0.1 with PID 22948 (G:\projects-blog\xxl-job\xxl-job-admin\target\classes started by best5 in G:\projects-blog\xxl-job)
17:22:29.728 logback [main] INFO  c.x.job.admin.XxlJobAdminApplication - No active profile set, falling back to 1 default profile: "default"
17:22:31.174 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat initialized with port 8080 (http)
17:22:31.185 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8080"]
17:22:31.186 logback [main] INFO  o.a.catalina.core.StandardService - Starting service [Tomcat]
17:22:31.186 logback [main] INFO  o.a.catalina.core.StandardEngine - Starting Servlet engine: [Apache Tomcat/10.1.34]
17:22:31.246 logback [main] INFO  o.a.c.c.C.[.[.[/xxl-job-admin] - Initializing Spring embedded WebApplicationContext
17:22:31.246 logback [main] INFO  o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 1309 ms
17:22:31.895 logback [main] INFO  c.x.j.a.c.scheduler.XxlJobScheduler - >>>>>>>>> init xxl-job admin success.
17:22:31.915 logback [xxl-job, admin JobFailMonitorHelper] INFO  com.zaxxer.hikari.HikariDataSource - HikariCP - Starting...
17:22:31.966 logback [main] INFO  o.s.b.a.w.s.WelcomePageHandlerMapping - Adding welcome page template: index
17:22:32.489 logback [xxl-job, admin JobFailMonitorHelper] INFO  com.zaxxer.hikari.pool.HikariPool - HikariCP - Added connection com.mysql.cj.jdbc.ConnectionImpl@1ea6c96a
17:22:32.492 logback [xxl-job, admin JobFailMonitorHelper] INFO  com.zaxxer.hikari.HikariDataSource - HikariCP - Start completed.
17:22:32.744 logback [main] INFO  o.s.b.a.e.web.EndpointLinksResolver - Exposing 1 endpoint beneath base path '/actuator'
17:22:32.822 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Starting ProtocolHandler ["http-nio-8080"]
17:22:32.865 logback [main] INFO  o.a.c.c.C.[.[.[/xxl-job-admin] - Initializing Spring DispatcherServlet 'dispatcherServlet'
17:22:32.865 logback [main] INFO  o.s.web.servlet.DispatcherServlet - Initializing Servlet 'dispatcherServlet'
17:22:32.866 logback [main] INFO  o.s.web.servlet.DispatcherServlet - Completed initialization in 1 ms
17:22:32.868 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat started on port 8080 (http) with context path '/xxl-job-admin'
17:22:32.893 logback [main] INFO  c.x.job.admin.XxlJobAdminApplication - Started XxlJobAdminApplication in 3.485 seconds (process running for 5.185)
17:22:36.001 logback [xxl-job, admin JobScheduleHelper#scheduleThread] INFO  c.x.j.a.c.thread.JobScheduleHelper - >>>>>>>>> init xxl-job admin scheduler success.
    • 当然也可以通过mvn package命令打成Fatjar，然后通过java -jar xxxx.jar命令运行
  • 浏览器访问调度中心
    • 访问地址http://localhost:8080/xxl-job-admin/
      在这里插入图片描述
    • 默认登录账号: admin
    • 默认登录密码: 123456
  • 登录后的界面
    在这里插入图片描述

部署SpringBoot示例xxl-job-executor-sample-springboot

  • 修改配置
    • 修改示例程序启动的端口
    • 修改调度中心的地址
    • 修改示例程序与调度中心通讯的端口
      在这里插入图片描述
  • 启动示例程序
    在这里插入图片描述
    • 当然也可以通过mvn package命令打成Fatjar，然后通过java -jar xxxx.jar命令运行
    • 输出以下日志代表启动成功
    Connected to the target VM, address: '127.0.0.1:55351', transport: 'socket'

.   ____          _            __ _ _
/\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/  ___)| |_)| | | | | || (_| |  ) ) ) )
'  |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot ::                (v2.4.5)

13:18:48.342 logback [main] INFO  c.x.j.e.XxlJobExecutorApplication - Starting XxlJobExecutorApplication using Java 1.8.0_241 on DESKTOP-MRA9GD8 with PID 7176 (G:\projects-blog\xxl-job\xxl-job-executor-samples\xxl-job-executor-sample-springboot\target\classes started by Administrator in G:\projects-blog\xxl-job)
13:18:48.348 logback [main] INFO  c.x.j.e.XxlJobExecutorApplication - No active profile set, falling back to default profiles: default
13:18:51.795 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat initialized with port(s): 8081 (http)
13:18:51.812 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8081"]
13:18:51.814 logback [main] INFO  o.a.catalina.core.StandardService - Starting service [Tomcat]
13:18:51.814 logback [main] INFO  o.a.catalina.core.StandardEngine - Starting Servlet engine: [Apache Tomcat/9.0.45]
13:18:51.998 logback [main] INFO  o.a.c.c.C.[Tomcat].[localhost].[/] - Initializing Spring embedded WebApplicationContext
13:18:51.999 logback [main] INFO  o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 2909 ms
13:18:52.152 logback [main] INFO  c.x.j.e.core.config.XxlJobConfig - >>>>>>>>>>> xxl-job config init.
13:18:52.515 logback [main] INFO  o.s.s.c.ThreadPoolTaskExecutor - Initializing ExecutorService 'applicationTaskExecutor'
13:18:53.303 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:demoJobHandler2, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@4f2d014a[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#demoJobHandler2]
13:18:53.310 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:demoJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@28e0e464[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#demoJobHandler]
13:18:53.311 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:httpJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@1d98daa0[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#httpJobHandler]
13:18:53.311 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:commandJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@70a898b0[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#commandJobHandler]
13:18:53.312 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:shardingJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@7bdf61ad[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#shardingJobHandler]
13:18:53.777 logback [main] WARN  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job accessToken is empty. To ensure system security, please set the accessToken.
13:18:53.879 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Starting ProtocolHandler ["http-nio-8081"]
13:18:53.975 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat started on port(s): 8081 (http) with context path ''
13:18:53.996 logback [main] INFO  c.x.j.e.XxlJobExecutorApplication - Started XxlJobExecutorApplication in 6.383 seconds (JVM running for 9.119)
13:18:55.608 logback [Thread-5] INFO  com.xxl.job.core.server.EmbedServer - >>>>>>>>>>> xxl-job remoting server start success, nettype = class com.xxl.job.core.server.EmbedServer, port = 9999
  • 在调度中心界面配置执行器
    • 查看本机IP
      在这里插入图片描述
    • 配置执行器
      在这里插入图片描述
  • 在调度中心界面调度执行一次任务
    在这里插入图片描述
  • 查看执行日志
    在这里插入图片描述
    在这里插入图片描述

分析执行日志原理

从上面的执行日志中可以看到输出XXL-JOB, Hello World等内容，这是怎么输出到调度中心的呢？接着往下看。

示例程序中的代码位置

在这里插入图片描述
使用XxlJobHelper.log()这个方法可以把日志输出到调度中心，如果使用本地的slf4j输出日志则只能打印到本地，要注意这个区别。

@XxlJob注解的使用

示例源码@XxlJob("demoJobHandler")中的demoJobHandler要与调度中心的配置JobHandler保持一致
在这里插入图片描述
在这里插入图片描述

总结

  • 每个步骤都有截图，写的很详细，方便零基础的同学跟着节奏一步一步上手。
  • 有兴趣的同学可以模仿这个示例程序自己写一个JobHandler，然后在调度中心注册一个执行器，新增一个任务。
  • 如果有疑问，欢迎交流沟通。
标签
#spring boot #分布式 #xxl-job #xxljob #定时任务
#调度
原理篇-- 定时任务xxl-job-服务端(admin)项目启动过程(1)
拽着尾巴的鱼儿的博客
03-01 3637
我们已经熟悉并使用了xxl-job 进行任务调度，作为服务端的xxl-job 的工作过程是怎样的，本文进行介绍。XxlJobAdminConfig 是 xxl-job-admin 的配置类，用于配置 xxl-job-admin 的相关参数和属性，以实现对 xxl-job-admin 的自定义配置和定制。配置注册中心：通过 XxlJobAdminConfig 可以配置 xxl-job-admin 的注册中心，包括注册中心的地址、端口、用户名、密码等，用于管理 xxl-job 的执行器和任务。配置调度中心。
原理篇-- 定时任务xxl-job-admin的表&任务状态介绍
拽着尾巴的鱼儿的博客
03-01 4807
在 中我们已经知道了如何在项目中使用xxljob ，接下来从xxljob 的原理入手进行介绍，首先看下xxljob-admin 服务端所使用的几张表。本文对xxl-job 服务端涉及的表及其任务状态进行介绍。
springboot整合 xxl-job
最新发布
2611_94945348的博客
04-21 367
如果启动失败，检查配置文件的值是否一致，如accessToken的值。
xxl-job使用教程
u013529468的博客
04-23 6587
springboot版本配置参照xxl-job-executor-sample-springboot中的代码。spring版本配置参照xxl-job-executor-sample-frameless中的代码。启动client，在admin管理后台中能看到client注册上来了。accessToken值替换（后面client配置中会用到）即可 初始密码 admin/123456。创建对应数据库，导入初始sql。替换对应的数据库链接。
xxl-job-admin 安装详解
热门推荐
我思，顾我在
08-17 1万+
一、简介 XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。 官方文档： 中文文档 English Documentation 源码仓库地址 源码仓库地址 Release Download https://github.com/xuxueli/xxl-job Download http://gitee.com/xuxueli0323/xxl-job Download 中央仓库地址 <
配置部署调度中心 xxl-job-admin
m0_51963973的博客
07-07 2136
XXL-JOB 是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。源码地址： https://gitee.com/xuxueli0323/xxl-job文档地址： https://www.xuxueli.com/xxl-job简单灵活提供Web页面对任务进行管理，管理系统支持用户管理、权限控制；支持容器部署；支持通过通用HTTP提供跨平台任务调度；丰富的任务管理功能支持页面对任务CRUD操作；支持在页面编写脚本任务、命令行任务、Java代码任务并执行；
基于SpringBoot集成DATAX、XXL-JOB实现离线数据定时同步实践
HIT的专栏
02-02 1万+
在很多实际应用中，需要实现离线数据定时同步，比如生产库和运营库分离之后，在运营库实现离线数据对账。 本文介绍一种实现方式，完成基于SpringBoot集成DATAX、XXL-JOB实现离线数据定时同步。 一、集成XXL-JOB 集成XXL-JOB，需要添加xxl-job-admin、xxl-job-core模块。在主工程配置中添加: <modules> <module&g...
Springboot 集成xxl-job实现定时调度任务
linkk
05-30 7114
一、前言 因为自己开发的系统中需要使用到定时调度的情境，所以结合自己使用的Springboot项目框架，准备接入xxl-job定时调度平台。 二、准备 1.先从xuxueli的GitHub上将xxl-job的源代码克隆一份到本地。 具体链接为https://github.com/xuxueli/xxl-job git clone https://github.com/xuxueli/xxl-job...
XXL-JOB详解（整合springboot）保姆级教程
我认不到你的博客
12-14 1万+
xxl-job中心式的调度平台轻量级，开箱即用，操作简易，上手快，与SpringBoot有非常好的集成，而且监控界面就集成在调度中心，界面又简洁，对于企业维护起来成本不高，还有失败的邮件告警等等。这就使很多企业选择xxl-job做调度平台。
SpringBoot 集成 xxl-job 实现定时任务管理
Java老兵的后端进阶与AI前沿探索之路。
07-05 4200
XXL-Job是一个功能强大的分布式任务调度框架，集成了Spring Boot后能够发挥更大的优势。它提供了分布式任务调度、任务执行报告、任务调度中心、良好的扩展性、分布式集群部署、监控与报警等多种优势。此外，XXL-Job是开源免费的，可以在GitHub上获取源代码和详细文档。详细的文档和使用指南可以在XXL-Job的官方文档中找到。
xxl-job项目集成到springBoot
zjz_i的博客
08-13 1万+
源码：http://www.xuxueli.com/xxl-job/#/?id=%E4%B8%80%E3%80%81%E7%AE%80%E4%BB%8B 一初始化数据库 脚本位置/xxl-job/doc/db/tables_xxl_job.sql xxl-job-admin：调度中心 xxl-job-core：公共依赖 二.配置调度中心项目 调度中心项目：xxl-job-admin ...
【springboot】集成xxl-job（分布式任务调度平台）
GodFatherMisZhao的博客
03-13 2466
xxl-job分布式任务调度平台
SpringBoot整合XXL-JOB
liyh722的博客
03-25 6743
1 XXL-JOB说明 　　XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。 　　项目中可能或多或少的会使用到定时调度，如果定时调度任务很多，这时候呢，就可以考虑使用xxl-job 其提供了强大的web管理界面 以及分布式调度特性！ 　　官网文档地址：分布式任务调度平台XXL-JOB 　　GitHub地址：代码 　　Gitee地址：代码 1.1 XXL-JOB特性 1、简单：支持通过Web页面对任务进
SpringBoot整合Xxl-Job
林知屿的博客
03-20 5936
这样就表示Xxl-Job成功运行了。确保运行没问题后，就可以开始下一步。注意:在运行之前，需要把2的sql脚本执行完毕，并修改数据库连接池。可以不用eureka，这里我的项目中用到eureka所以增加该配置。第三、确实非常容易上手且轻量化(轻量化的一个体现就是非侵入式)第一、团队里有好几个人上一家公司或上上家公司用过。第二、这个生态比较丰富且开源。用户名默认为admin。
SpringBoot（四十三）SpringBoot集成xxl-job分布式任务调度平台
camellia的博客
11-28 1591
在这里我遇到了一个小坑，我的项目是多模块的springboot项目，我为xxl-job单独创建了一个模块，将代码配置在其中进行测试，发现不好用。支持可视化、简单且动态的管理调度信息，包括任务新建，更新，删除，GLUE开发和任务报警等，所有上述操作都会实时生效，同时支持监控调度结果以及执行日志，支持执行器Failover。负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码。点击上图中的调度备注中的查看，会看到这次执行的基本信息（我最开始不知道啊，一直在服务器中查看调度日志）这部分是非常重要的。
xxl-job集成springboot实战，xxl-job定时任务详解
杜盟恩的博客
01-17 6258
xxl-job集成springboot实战，xxl-job定时任务详解
SpringBoot集成Xxl-Job
usa_washington的博客
02-24 1325
Xxl-Job
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

太空眼睛

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值