## 概述 XXL-JOB是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。官方地址中文版：[http://www.xuxueli.com/xxl-job](https://links.jianshu.com/go?to=http%3A%2F%2Fwww.xuxueli.com%2Fxxl-job)目前已有多家公司接入xxl-job，包括比较知名的大众点评，京东，优信二手车，北京尚德，360金融 (360)，联想集团 (联想)，易信 (网易)等等....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切换到一台正常的执行器发送调度请求。 * 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度 * 任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务 * 任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试 * 任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式 * 分片广播任务：执行器集群部署时，任务路由策略选择"分片广播"情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务 * 动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度 * 事件触发：除了"Cron方式"和"任务依赖方式"触发任务执行之外，支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务，可根据业务事件灵活触发 * 任务进度监控：支持实时监控任务进度 * Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志 * GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯 * 脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本 * 命令行任务：原生提供通用命令行任务Handler（Bean任务，"CommandJobHandler"）；业务方只需要提供命令行即可 * 任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔 * 一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行 * 自定义任务参数：支持在线配置调度任务入参，即时生效 * 调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞 * 数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性 * 邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件 * 推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用 * 运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等 * 全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行 * 跨平台：原生提供通用HTTP任务Handler（Bean任务，"HttpJobHandler"），业务方只需要提供HTTP链接即可，不限制语言、平台 * 国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文 * 容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用 * 线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入"Slow"线程池，避免耗尽调度线程，提高系统稳定性 ## 快速入门 解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可，源码结构如下： xxl-job-admin：调度中心 xxl-job-core：公共依赖 xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用） ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式； ：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用； ：xxl-job-executor-sample-frameless：无框架版本； ：xxl-job-executor-sample-jfinal：JFinal版本，通过JFinal管理执行器； ：xxl-job-executor-sample-nutz：Nutz版本，通过Nutz管理执行器； #### **1.初始化"调度数据库"** 到官网下载项目源码并解压，获取 "调度数据库初始化SQL脚本" 并执行即可，正常情况下应该生成16张表。SQL脚本位置：/xxl-job/doc/db/tables\_xxl\_job.sql注意⚠️：调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例;如果mysql做主从,调度中心集群节点务必强制走主库 #### **2.部署调度中心** 调度中心项目：xxl-job-admin作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。**步骤一：调度中心配置**调度中心配置文件地址：application.properties ~~~ #-------------任务控制台系统------------------------- server.port=9003 server.context-path=/hmall-job-admin ### actuator management.context-path=/actuator management.health.mail.enabled=false ### resources spring.mvc.static-path-pattern=/static/** spring.resources.static-locations=classpath:/static/ ### freemarker spring.freemarker.templateLoaderPath=classpath:/templates/ spring.freemarker.suffix=.ftl spring.freemarker.charset=UTF-8 spring.freemarker.request-context-attribute=request spring.freemarker.settings.number_format=0.########## ### mybatis mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml ### xxl-job, datasource spring.datasource.url=jdbc:mysql://********:3306/hj_mall_job?Unicode=true&characterEncoding=UTF-8 spring.datasource.username=root spring.datasource.password=root spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource spring.datasource.tomcat.max-wait=10000 spring.datasource.tomcat.max-active=30 spring.datasource.tomcat.test-on-borrow=true spring.datasource.tomcat.validation-query=SELECT 1 spring.datasource.tomcat.validation-interval=30000 ### xxl-job email spring.mail.host=smtp.qq.com spring.mail.port=25 spring.mail.username=xxx@qq.com spring.mail.password=xxx spring.mail.properties.mail.smtp.auth=true spring.mail.properties.mail.smtp.starttls.enable=true spring.mail.properties.mail.smtp.starttls.required=true spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory ### xxl-job, access token xxl.job.accessToken= ### xxl-job, i18n (default empty as chinese, "en" as english) xxl.job.i18n= ## xxl-job, triggerpool max size xxl.job.triggerpool.fast.max=200 xxl.job.triggerpool.slow.max=100 ### xxl-job, log retention days xxl.job.logretentiondays=30 ~~~ **步骤二：部署项目**如果已经正确进行上述配置，可将项目编译打包部署。 调度中心访问地址：http://localhost:8080/hmall-job-admin/ (该地址执行器将会使用到，作为回调地址)，登录后运行界面如下图所示  至此“调度中心”项目已经部署成功。 #### **3.部署执行器项目** 执行器负责接收“调度中心”的调度并执行；在源码中作者已经贴心的给出了多种执行器项目示例，可根据你的喜好直接将其部署作为你自己的执行器，当然你也可以将执行器集成到现有业务项目中去 **步骤一：在你的项目里引入xxl-job-core的依赖** ~~~ <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>${xxl-job-core.version}</version> </dependency> ~~~ **步骤二：执行器配置**将源码中/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties下的配置信息copy一份，添加到你的项目的application.properties文件中去，注意修改自己的配置信息 ``` xxl: job: admin: addresses: http://127.0.0.1:9003/hj-job-admin ### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册； executor: appname: hmall-job ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册 ip: 127.0.0.1 ### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"； port: 9999 ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口； logpath: /usr/hj/log ### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径； logretentiondays: 30 ### 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效； accessToken: ``` **步骤三：执行器组件配置**执行器组件配置信息位置：/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java找到这个XxlJobConfig.java复制一份到你的项目里 ``` package com.hjf.job.config; import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; import lombok.extern.slf4j.Slf4j; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * 功能说明:【定时任务：分布式任务调度配置】 * 作 者：lihaijun * 创建日期：2019-11-09 */ @Slf4j @Configuration public class XxlJobConfig { @Value("${xxl.job.admin.addresses}") private String adminAddresses; @Value("${xxl.job.executor.appname}") private String appName; @Value("${xxl.job.executor.ip}") private String ip; @Value("${xxl.job.executor.port}") private int port; @Value("${xxl.job.accessToken}") private String accessToken; @Value("${xxl.job.executor.logpath}") private String logPath; @Value("${xxl.job.executor.logretentiondays}") private int logRetentionDays; @Bean public XxlJobSpringExecutor xxlJobExecutor() { log.info(">>>>>>>>>>> xxl-job config init."); XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); xxlJobSpringExecutor.setAdminAddresses(adminAddresses); xxlJobSpringExecutor.setAppName(appName); 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(); */ } ``` **步骤五：执行器项目集群（可选）**执行器支持集群部署，提升调度系统可用性，同时提升任务处理能力。执行器集群部署时，几点要求和建议： * 执行器回调地址（xxl.job.admin.addresses）需要保持一致；执行器根据该配置进行执行器自动注册等操作 * 同一个执行器集群内AppName（xxl.job.executor.appname）需要保持一致；调度中心根据该配置动态发现不同集群的在线执行器列表 ## **4.开发自己的任务** **4.1在执行器项目中新建自己的任务，代码示例：** ~~~css /** * 功能说明:【定时任务：交易统计 每天统计一次】【作废：启用延时消息处理】 * 作 者：lihaijun * 创建日期：2020-01-02 */ @Transactional @Slf4j @Component @JobHandler(value = "orderPayJob") public class OrderPayJob extends IJobHandler { @Resource OrderInfoMapper orderInfoMapper; @Resource OrderProductMapper orderProductMapper; @Resource ProductSKUMapper productSKUMapper; @Override public ReturnT<String> execute(String param) throws Exception { try { log.info("【 订单库存处理任务】任务开始执行...."); Query query=new Query(); query.append("createdTime", TimeUtil.getSpecialMinute(-30)); query.append("status", OrderStatus.WaitPay.getValue()); List list = orderInfoMapper.queryList(query); if (list==null||list.size()<1) { log.info("【 未支付订单任务】 没有检查到过期订单"); return SUCCESS; } log.info(" 【 订单库存处理任务】...结束..."); }catch(Exception e){ log.error("【 订单库存处理任务】...异常.." + e.getMessage()); } return SUCCESS; } } ~~~ **4.2在调度中心新建任务**登录调度中心，点击下图所示“新建任务”按钮，新建示例任务。然后，参考下面截图中任务的参数配置，点击保存。  点击右侧启动此任务，将任务启动 **4.3启动调度中心，启动执行器项目** **** **** ********