《分布式任务调度平台XXL-JOB》手册

《分布式任务调度平台XXL-JOB》手册文档历史记录目录1：简介 (3)2：安装 (3)3：配置 (3)3.1数据库准备 (4)3.2源码准备 (5)3.3部署准备 (5)3.3.1 配置部署“调度中心” (5)3.3.2 配置部署“执行器项目” (7)4：使用 (9)步骤一：新建任务 (9)步骤二：“GLUE模式(Java)”任务开发 (10)步骤三：触发执行 (10)步骤四：查看日志 (10)5：总结 (11)1：简介XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是开发迅速、学习简单、轻量级、易扩展，XXL-JOB是基于开源Quartz 调度内核的、为方便企业调度场景而开源的一款实用的调度工具。

自带任务配置页面，任务监控，分布式执行器等功能。

2：安装下载地址（最新1.9版本迭代中，可选择稳定版本1.8.2下载）码云：https:///xuxueli0323/xxl-job/tree/v1.8.23：配置解压下载文件，得到如下文件结构，- /doc :文档资料- /db :“调度数据库”建表脚本- /xxl-job-admin :调度中心，项目源码- /xxl-job-core :公共Jar依赖- /xxl-job-executor-samples :执行器，Sample示例项目3.1数据库准备使用mysql 新建数据库xxl-job ，导入下载文件夹中/doc/db/tables_xxl_job.sql 文件，应生成16张表，如图所示。

3.2源码准备按照maven格式将源码导入IDE，使用maven进行编译即可，源码结构如下xxl-job-admin：调度中心xxl-job-core：公共依赖xxl-job-executor：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用；：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器；：xxl-job-executor-sample-jfinal：JFinal版本，通过JFinal管理执行器；：xxl-job-executor-sample-nutz：Nutz版本，通过Nutz管理执行器；3.3部署准备3.3.1 配置部署“调度中心”调度中心项目：xxl-job-admin作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

分布式任务调度平台XXL-JOB快速使⽤与问题总结1.XXL-JOB简介XXL-JOB is a lightweight distributed task scheduling framework. It's core design goal is to develop quickly and learn simple, lightweight, and easy to expand. Now, it's already open source, and many companies use it in production environments, real "out-of-the-box".XXL-JOB是⼀个轻量级分布式任务调度平台，其核⼼设计⽬标是开发迅速、学习简单、轻量级、易扩展。

现已开放源代码并接⼊多家公司线上产品线，开箱即⽤。

——引⽤⾃XXL-JOB的GIT项⽬介绍关于XXL-JOB的其他介绍可以，它含有丰富的特性，⽀持分布式和动态任务添加以及权限控制等。

2.搭建XXL-JOB项⽬①下载源码https:///xuxueli/xxl-job/②执⾏SQLxxl-job-2.1.1\xxl-job-2.1.1\doc\db\tables_xxl_job.sql③修改配置### xxl-job, datasourcespring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8ername=rootspring.datasource.password=root_pwdspring.datasource.driver-class-name=com.mysql.jdbc.Driver### xxl-job, access token 秘钥填了下⾯的⼦项⽬要和这个⼀致xxl.job.accessToken=需要注意的是⼦项⽬中的配置地址要和admin中的访问⾸页地址⼀致:### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin④启动项⽬我们⾸选需要启动项⽬中的admin,然后再启动xxl-job-executor-samples下⾯的内容,这⾥我们启动,这⾥⽐较简单的⽅式是通过springboot的例⼦进⾏启动,这也是作者推荐的启动⽅式。

(19)国家知识产权局(12)发明专利申请(10)申请公布号 (43)申请公布日 (21)申请号 202210021289.X(22)申请日 2022.01.10(71)申请人 广东联合电子服务股份有限公司地址 510000 广东省广州市天河区体育西路189号15楼(72)发明人 黄强　李昊淼　张佳松　(74)专利代理机构 广州市越秀区哲力专利商标事务所(普通合伙) 44288专利代理师 徐鹏(51)Int.Cl.G06F 9/48(2006.01)G06F 21/31(2013.01)G06F 21/62(2013.01)(54)发明名称基于XXL-JOB的任务调度系统(57)摘要本申请公开了一种基于XXL ‑JOB的任务调度系统，涉及计算机技术，包括：Web模块，用于响应浏览器的访问请求，并向浏览器返回可交互界面；任务调度模块，用于根据Web模块采集的针对所述可交互界面的操作指令进行响应，所述任务调度模块至少用于调度针对数据库的操作任务；其中，所述可交互界面的输入框配置有校验程序，所述校验程序用于校验所述输入框的输入数据是否为SQL指令，当所述输入数据为SQL指令时，拦截该输入数据。

本申请实施例可以在采用XXL ‑JOB实现数据库任务调度的场景下，通过防注入措施保障系统得到安全。

权利要求书1页 说明书4页 附图1页CN 114528077 A 2022.05.24C N 114528077A1.一种基于XXL ‑JOB的任务调度系统，其特征在于，包括：Web模块，用于响应浏览器的访问请求，并向浏览器返回可交互界面；任务调度模块，用于根据Web模块采集的针对所述可交互界面的操作指令进行响应，所述任务调度模块至少用于调度针对数据库的操作任务；其中，所述可交互界面的输入框配置有校验程序，所述校验程序用于校验所述输入框的输入数据是否为SQL指令，当所述输入数据为SQL指令时，拦截该输入数据。

2.根据权利要求1所述的基于XXL ‑JOB的任务调度系统，其特征在于，所述可交互界面中包括任务调度列表和所述任务调度列表中各任务项的信息和操作按钮，所述任务调度模块根据针对所述操作按钮的操作执行进行响应。

xxl-job调度任务简单使⽤1. 简介XXL-JOB是⼀个分布式任务调度平台，其核⼼设计⽬标是开发迅速、学习简单、轻量级、易扩展。

现已开放源代码并接⼊多家公司线上产品线，开箱即⽤。

2. 使⽤步骤1：源码下载数据库脚本再源码/xxl-job/doc/db/tables_xxl_job.sql3.调度中⼼项⽬：xxl-job-admin修改配置⽂件中的数据库地址或端⼝/xxl-job/xxl-job-admin/src/main/resources/application.properties4.启动xxl-job-admin⼯程访问地址为：账号/密码 admin/1234565.⾄此，xxl-job服务启动完成，接下来将xxl植⼊到所要添加定时任务的⼯程中此次测试我使⽤的是：2.3.0版本<!-- /maven2/com/xuxueli/xxl-job-core/ --><dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.3.0</version></dependency>6.修改⼯程的yml⽂件，引⼊xxl配置#引⼊xxl-jobxxl:job:admin:# 调度中⼼部署跟地址 [选填]：如调度中⼼集群部署存在多个地址则⽤逗号分隔。

# 执⾏器将会使⽤该地址进⾏"执⾏器⼼跳注册"和"任务结果回调"；为空则关闭⾃动注册；addresses: http://localhost:8080/xxl-job-adminexecutor:# 执⾏器AppName [选填]：执⾏器⼼跳注册分组依据；为空则关闭⾃动注册appname: springcloudalibaba-user-experience-job# 执⾏器IP [选填]：默认为空表⽰⾃动获取IP，多⽹卡时可⼿动设置指定IP，该IP不会绑定Host仅作为通讯实⽤；# address: http://192.168.2.29:9191# 地址信息⽤于 "执⾏器注册" 和 "调度中⼼请求并触发任务"；# ip: 192.168.2.29# 执⾏器运⾏⽇志⽂件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使⽤默认路径；logpath: ./logs/xxl-job# 执⾏器⽇志⽂件保存天数 [选填] ：过期⽇志⾃动清理, 限制值⼤于等于3时⽣效; 否则, 如-1, 关闭⾃动清理功能；logretentiondays: 30# 执⾏器端⼝号 [选填]：⼩于等于0则⾃动获取；默认端⼝为9999，# 单机部署多个执⾏器时，注意要配置不同执⾏器端⼝；port: 9192# 执⾏器通讯TOKEN [选填]：⾮空时启⽤；# accessToken:7.添加config配置⽂件import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.Profile;/*** xxl-job config** @author* @date 2020/11/23*/@Slf4j@Configuration@Profile("!dev")public class XxlJobConfig {@Value("${xxl.job.admin.addresses}")private String adminAddresses;@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;/*** 注意：如果想本机调试，需要设置address、ip* @return*/@Beanpublic XxlJobSpringExecutor xxlJobExecutor() {XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); xxlJobSpringExecutor.setAdminAddresses(adminAddresses);xxlJobSpringExecutor.setAppname(appName);//xxlJobSpringExecutor.setAddress(address);xxlJobSpringExecutor.setPort(port);//xxlJobSpringExecutor.setIp(ip);xxlJobSpringExecutor.setLogPath(logPath);xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);return xxlJobSpringExecutor;}}8.执⾏器管理--》添加执⾏器添加完成后，可以点击查看详情9.再代码中创建定时任务import com.alibaba.fastjson.JSONObject;import com.xxl.job.core.context.XxlJobHelper;import com.xxl.job.core.handler.annotation.XxlJob;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.InitializingBean;import ponent;import java.util.Date;@Slf4j@Componentpublic class UserJob1 implements InitializingBean {/*** 定时同步群发任务结果** @return*/@XxlJob("xxlJobTest")public String execute() {("start userTodoJob, time at:" + new Date());String params = XxlJobHelper.getJobParam();JSONObject jsonObject = JSONObject.parseObject(params);Integer orgId = jsonObject.getInteger("orgId");String corpId = jsonObject.getString("corpId");System.out.println("执⾏了"+params);return "执⾏了";}@Overridepublic void afterPropertiesSet() throws Exception {("Combination Job init suc at: " + new Date());}}10.任务管理中添加新的任务添加完成后，可再后⾯对该任务进⾏操作。

xxl-job介绍什么是任务调度什么是任务调度？某⼀时间段进⾏任务的操作。

具体任务调度有哪些应⽤的场景？数据同步、交易信息、清除⽤户的信息、定期发送报表数据、活动推送等。

传统实现定时任务的⽅式？Thread、TimeTask、ScheduleExecutorService、Quartz 等；不过，这⼏种⽅式都是在单点系统使⽤，⼀旦Job服务器宕机之后，就必须采取⼀些措施；具体操作如下：(1) 使⽤⼼跳检测监控⾃动重启、任务补偿机制（任务做标记）(2) 定时任务在执⾏代码的时候中间突然报错，使⽤⽇志记录错误，跳过继续执⾏，在使⽤定时Job 扫描⽇志错误记录，进⾏补偿信息。

(3) 定时Job 在执⾏的时候，导致整个 Job 异常结束掉，发送邮件通知给运维⼈员。

分布式定时任务的⽅式？XXL-Job、Elastic-job等。

不过，既然采⽤分布式，那么肯定会遇到项⽬部署集群，导致任务重复执⾏多次；具体操作如下：(1) Zookeeper 实现分布式锁，每次保证拿到锁再执⾏，效率⽐较低。

(2) 配置⽂件中加⼊定时任务的开关，但是只能保证⼀台服务器执⾏，变为单击服务器。

(3) 启动的时候使⽤数据库唯⼀标识；同样是效率低。

(4) 分布式调度任务平台，解决了任务幂等问题，Job 负载均衡轮询机制（推荐）。

那么现在我们来总结下，⾸先传统的定时任务，⼏乎⽆法做到⾼可⽤，再加上项⽬部署集群，会导致任务幂等性问题；此时分布式定时任务调度平台便发挥了作⽤，咱们拿 XXL-Job 来进⾏说明；相关作⽤如下：(1) ⽀持Job集群，Job 负载均衡轮询机制保证幂等性问题。

(2) ⽀持Job补偿，如果Job执⾏失败的话，会⾃动实现重试机制，超过重启次数后，会发送邮件通知运维⼈员。

(3) ⽀持Job⽇志记录。

(4) 动态配置定时规则，传统定时Job触发规则都是写死在代码中。

XXL-JOB简介开源社区：环境：Maven3+Jdk1.8+Mysql5.7+xxl-job执⾏原理调度平台、执⾏器、任务管理，相关解释如下：调度平台：统⼀管理任务调度的平台，负责转发任务到对应的执⾏服务器。

分布式任务调度平台XXL-JOB《分布式任务调度平台XXL-JOB》[TOCM][TOC]⼀、简介1.1 概述XXL-JOB是⼀个分布式任务调度平台，其核⼼设计⽬标是开发迅速、学习简单、轻量级、易扩展。

现已开放源代码并接⼊多家公司线上产品线，开箱即⽤。

1.2 社区交流1.3 特性1、简单：⽀持通过Web页⾯对任务进⾏CRUD操作，操作简单，⼀分钟上⼿；2、动态：⽀持动态修改任务状态、启动/停⽌任务，以及终⽌运⾏中任务，即时⽣效；3、调度中⼼HA（中⼼式）：调度采⽤中⼼式设计，“调度中⼼”⾃研调度组件并⽀持集群部署，可保证调度中⼼HA；4、执⾏器HA（分布式）：任务分布式执⾏，任务"执⾏器"⽀持集群部署，可保证任务执⾏HA；5、注册中⼼: 执⾏器会周期性⾃动注册任务, 调度中⼼将会⾃动发现注册的任务并触发执⾏。

同时，也⽀持⼿动录⼊执⾏器地址；6、弹性扩容缩容：⼀旦有新执⾏器机器上线或者下线，下次调度时将会重新分配任务；7、路由策略：执⾏器集群部署时提供丰富的路由策略，包括：第⼀个、最后⼀个、轮询、随机、⼀致性HASH、最不经常使⽤、最近最久未使⽤、故障转移、忙碌转移等；8、故障转移：任务路由策略选择"故障转移"情况下，如果执⾏器集群中某⼀台机器故障，将会⾃动Failover切换到⼀台正常的执⾏器发送调度请求。

9、阻塞处理策略：调度过于密集执⾏器来不及处理时的处理策略，策略包括：单机串⾏（默认）、丢弃后续调度、覆盖之前调度；10、任务超时控制：⽀持⾃定义任务超时时间，任务运⾏超时将会主动中断任务；11、任务失败重试：⽀持⾃定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进⾏重试；其中分⽚任务⽀持分⽚粒度的失败重试；12、任务失败告警；默认提供邮件⽅式失败告警，同时预留扩展接⼝，可⽅便的扩展短信、钉钉等告警⽅式；13、分⽚⼴播任务：执⾏器集群部署时，任务路由策略选择"分⽚⼴播"情况下，⼀次任务调度将会⼴播触发集群中所有执⾏器执⾏⼀次任务，可根据分⽚参数开发分⽚任务；14、动态分⽚：分⽚⼴播任务以执⾏器为维度进⾏分⽚，⽀持动态扩容执⾏器集群从⽽动态增加分⽚数量，协同进⾏业务处理；在进⾏⼤数据量业务操作时可显著提升任务处理能⼒和速度。

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号 (43)申请公布日 (21)申请号 202111626396.7(22)申请日 2021.12.28(71)申请人 苏州小棉袄信息技术股份有限公司地址 215000 江苏省苏州市东吴北路299号1901室(1909、1910、1911)(72)发明人 乐涛　肖书恒　李天阁　靳涛涛　刘肖　冯志远　金涛　韩阳　(74)专利代理机构 绍兴市越兴专利事务所(普通合伙) 33220代理人 高林(51)Int.Cl.G06F 9/48(2006.01)G06F 9/54(2006.01)(54)发明名称基于XXL-JOB分布式任务调度系统的路由策略(57)摘要本发明涉及分布式任务调度技术领域，尤其涉及一种基于XXL ‑JOB分布式任务调度系统的路由策略，包括以下步骤：各执行器自身根据任务流控规则判断当前是否可参与新任务；可执行新任务的执行器与调度中心之间确认系统标识，调度中心选定其中一台执行器为任务调度机器；任务调度机器接收任务参数并执行；优势在于：基于XXL ‑JOB分布式任务调度平台第10种分片广播路由策略，通过广播模式广播任务，所有任务流控规则验证通过的执行器机器均会尝试拉取任务，根据业务逻辑最终仅有一台机器能完整的完成系统标记身份确认以及任务调度确认，降低了出现“抢占式”业务执行逻辑时的负载风险。

权利要求书1页 说明书4页 附图1页CN 114265681 A 2022.04.01C N 114265681A1.一种基于XXL ‑JOB分布式任务调度系统的路由策略，其特征在于，包括以下步骤：S10.各执行器自身根据任务流控规则判断当前是否可参与新任务；S20.可执行新任务的执行器与调度中心之间确认系统标识，调度中心选定其中一台执行器为任务调度机器；S30. 任务调度机器接收任务参数并执行。

2.如权利要求1所述的一种基于XXL ‑JOB分布式任务调度系统的路由策略，其特征在于，所述任务流控规则包括执行器的正在执行的任务数、待重试任务数、队列等待任务数和延时任务数，在所述步骤S10中，执行器根据任务流控规则判断自身健康情况和负载情况，若执行器属于健康且负载未超阈值，则可参与新的调度任务。

本技术公开了一种基于XXL JOB实现分布式调度任务的方法及系统，属于计算机软件开发技术领域。

本技术的基于XXL JOB实现分布式调度任务的方法配置部署调度中心，统一管理任务调度平台上调度任务，触发调度执行，并提供任务管理平台；配置部署执行器项目，接收调度中心的调度并执行；在可视化界面配置执行器及新建任务。

该技术的基于XXL JOB实现分布式调度任务的方法能够减轻服务器压力，提高系统的运行效率，在确保各用户数据间隔的同时能完成调度任务，具有很好的推广应用价值。

权利要求书1.一种基于XXL-JOB实现分布式调度任务的方法，其特征在于：该方法配置部署调度中心，统一管理任务调度平台上调度任务，触发调度执行，并提供任务管理平台；配置部署执行器项目，接收调度中心的调度并执行；在可视化界面配置执行器及新建任务。

2.根据权利要求1所述的基于XXL-JOB实现分布式调度任务的方法，其特征在于：具体包括以下步骤：S1、初始化调度数据，创建数据库；S2、配置调度中心；S3、配置执行器项目，配置项目中的配置文件；S4、新增执行器；S5、新建任务；S6、编写代码来实现执行调度任务的执行器。

3.根据权利要求2所述的基于XXL-JOB实现分布式调度任务的方法，其特征在于：步骤S1中，创建名为XXL-JOB的数据库，在XXL-JOB数据库中创建XXL-JOB使用的表。

4.根据权利要求3所述的基于XXL-JOB实现分布式调度任务的方法，其特征在于：步骤S2包括：配置XXL-JOB中的配置文件，配置下访问的端口和路径，然后配置数据库连接信息，再可以选择的配置发送邮件信息。

5.根据权利要求4所述的基于XXL-JOB实现分布式调度任务的方法，其特征在于：步骤S4中，登录任务调度中心系统，点击执行器管理菜单，点击新增管理器，保存即可。

6.根据权利要求5所述的基于XXL-JOB实现分布式调度任务的方法，其特征在于：步骤S5中，登录任务调度中心系统，点击任务管理菜单中的新增任务，进入新增页面后，配置创建的执行器。

（xxl_jobquartz）：XXL_JOB对⽐Quartz⼀决⾼下！概述： XXL-JOB是⼀个轻量级分布式任务调度平台，其核⼼设计⽬标是开发迅速、学习简单、轻量级、易扩展。

现已开放源代码并接⼊多家公司线上产品线，开箱即⽤。

易信 (⽹易)等等.... Quartz作为开源作业调度中的佼佼者，是作业调度的⾸选。

集群环境中Quartz采⽤API的⽅式对任务进⾏管理，Quartz存在以下问题：Quartz的不⾜：问题⼀：调⽤API的的⽅式操作任务，不⼈性化；问题⼆：需要持久化业务QuartzJobBean到底层数据表中，系统侵⼊性相当严重。

问题三：调度逻辑和QuartzJobBean耦合在同⼀个项⽬中，这将导致⼀个问题，在调度任务数量逐渐增多， 同时调度任务逻辑逐渐加重的情况加，此时调度系统的性能将⼤⼤受限于业务；问题四：quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运⾏任务，会导致节点负载悬殊⾮常⼤； ⽽XXL-JOB通过执⾏器实现“协同分配式”运⾏任务，充分发挥集群优势，负载各节点均衡。

XXL-JOB弥补了quartz的上述不⾜之处。

XXL-JOB特性：简单：⽀持通过Web页⾯对任务进⾏CRUD操作，操作简单，⼀分钟上⼿动态：⽀持动态修改任务状态、启动/停⽌任务，以及终⽌运⾏中任务，即时⽣效调度中⼼HA（中⼼式）：调度采⽤中⼼式设计，“调度中⼼”基于集群Quartz实现并⽀持集群部署，可保证调度中⼼HA执⾏器HA（分布式）：任务分布式执⾏，任务"执⾏器"⽀持集群部署，可保证任务执⾏HA注册中⼼: 执⾏器会周期性⾃动注册任务, 调度中⼼将会⾃动发现注册的任务并触发执⾏。

同时，也⽀持⼿动录⼊执⾏器地址弹性扩容缩容：⼀旦有新执⾏器机器上线或者下线，下次调度时将会重新分配任务路由策略：执⾏器集群部署时提供丰富的路由策略，包括：第⼀个、最后⼀个、轮询、随机、⼀致性HASH、最不经常使⽤、最近最久未使⽤、故障转移、忙碌转移等故障转移：任务路由策略选择"故障转移"情况下，如果执⾏器集群中某⼀台机器故障，将会⾃动Failover切换到⼀台正常的执⾏器发送调度请求。