官网: https://www.xuxueli.com/xxl-job/
论坛: https://www.xuxueli.com/page/community.html
概述
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
特性
1、简单:支持通过Web页面对任务进行CRUD操作,操作简单,一分钟上手;
2、动态:支持动态修改任务状态、启动/停止任务,以及终止运行中任务,即时生效;
3、调度中心HA(中心式):调度采用中心式设计,“调度中心”自研调度组件并支持集群部署,可保证调度中心HA;
4、执行器HA(分布式):任务分布式执行,任务”执行器”支持集群部署,可保证任务执行HA;
5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时,也支持手动录入执行器地址;
6、弹性扩容缩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务;
7、路由策略:执行器集群部署时提供丰富的路由策略,包括:第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等;
8、故障转移:任务路由策略选择”故障转移”情况下,如果执行器集群中某一台机器故障,将会自动Failover切换到一台正常的执行器发送调度请求。
9、阻塞处理策略:调度过于密集执行器来不及处理时的处理策略,策略包括:单机串行(默认)、丢弃后续调度、覆盖之前调度;
10、任务超时控制:支持自定义任务超时时间,任务运行超时将会主动中断任务;
11、任务失败重试:支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;其中分片任务支持分片粒度的失败重试;
12、任务失败告警;默认提供邮件方式失败告警,同时预留扩展接口,可方便的扩展短信、钉钉等告警方式;
13、分片广播任务:执行器集群部署时,任务路由策略选择”分片广播”情况下,一次任务调度将会广播触发集群中所有执行器执行一次任务,可根据分片参数开发分片任务;
14、动态分片:分片广播任务以执行器为维度进行分片,支持动态扩容执行器集群从而动态增加分片数量,协同进行业务处理;在进行大数据量业务操作时可显著提升任务处理能力和速度。
15、事件触发:除了”Cron方式”和”任务依赖方式”触发任务执行之外,支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务,可根据业务事件灵活触发。
16、任务进度监控:支持实时监控任务进度;
17、Rolling实时日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志;
18、GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。支持30个版本的历史版本回溯。
19、脚本任务:支持以GLUE模式开发和运行脚本任务,包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
20、命令行任务:原生提供通用命令行任务Handler(Bean任务,”CommandJobHandler”);业务方只需要提供命令行即可;
21、任务依赖:支持配置子任务依赖,当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔;
22、一致性:“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行;
23、自定义任务参数:支持在线配置调度任务入参,即时生效;
24、调度线程池:调度系统多线程触发调度运行,确保调度精确执行,不被堵塞;
25、数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性;
26、邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;
27、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
28、运行报表:支持实时查看运行数据,如任务数量、调度次数、执行器数量等;以及调度报表,如调度日期分布图,调度成功分布图等;
29、全异步:任务调度流程全异步化设计实现,如异步调度、异步运行、异步回调等,有效对密集调度进行流量削峰,理论上支持任意时长任务的运行;
30、跨语言:调度中心与执行器提供语言无关的 RESTful API 服务,第三方任意语言可据此对接调度中心或者实现执行器。除此之外,还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案;
31、国际化:调度中心支持国际化设置,提供中文、英文两种可选语言,默认为中文;
32、容器化:提供官方docker镜像,并实时更新推送dockerhub,进一步实现产品开箱即用;
33、线程池隔离:调度线程池进行隔离拆分,慢任务自动降级进入”Slow”线程池,避免耗尽调度线程,提高系统稳定性;
34、用户管理:支持在线管理系统用户,存在管理员、普通用户两种角色;
35、权限控制:执行器维度进行权限控制,管理员拥有全量权限,普通用户需要分配执行器权限后才允许相关操作;
1.初始化“调度数据库”
请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可。
“调度数据库初始化SQL脚本” 位置为:
解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下:
/xxl-job/doc/db/tables_xxl_job.sql
编译源码
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管理执行器;
:xxl-job-executor-sample-jboot:jboot版本,通过jboot管理执行器;
其他请看官方文档.很详细不想复制了.
https://www.xuxueli.com/xxl-job/#2.1%20%E5%88%9D%E5%A7%8B%E5%8C%96%E2%80%9C%E8%B0%83%E5%BA%A6%E6%95%B0%E6%8D%AE%E5%BA%93%E2%80%9D
下面是在项目中使用的
修修改改就可以使用在你自己的项目了.
XXL-JOB 依赖 – 尽量跟你的项目对应版本
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.1.2</version>
</dependency>
配置中心:
application.yml
xxl:
job:
admin:
addresses: http://127.0.0.1:8080/xxl-job-admin #任务调度web pc 端
executor:
appname: bookshop-pc-executor # 服务名称
address:
ip:
port: 33001
logpath: /data/applogs/xxl-job/jobhandler
logretentiondays: -1
accessToken:
配置bean
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;
@Configuration
@Slf4j
public class JobHandleConfig {
@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.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;
/**
*设置参数化对应XXL-Job
*/
@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;
}
}
执行任务
import cn.hutool.core.date.DateUtil;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
@Component
public class JobHandler {
@Autowired
private AlipayUtil alipayUtil;
@Autowired
private WxPayUtil wxPayUtil;
@Autowired
private OrderMapper orderMapper;
@Autowired
private OrderLogMapper orderLogMapper;
@Autowired
private PaymentApiAction paymentApiAction;
/**
*开始执行你的业务逻辑.
*/
@XxlJob("payStatusHandler") // 这个是对应的是 xxL-job-admin pc端一致 看下面截图
public ReturnT<String> payStatusHandler(String param) {
XxlJobLogger.log("开始执行支付结果查询,更新订单");
Date now = new Date();
List<Order> orderList = orderMapper.listByPayStatus(OrderStatus.PAY_NO);
for (Order order : orderList) {
if (order.getPaymentId().equals(1)) {
String tradeStatus = alipayUtil.trade_query(order.getSn());
if (StringUtils.isNotEmpty(tradeStatus)) {
switch (tradeStatus) {
case "TRADE_SUCCESS": {
boolean resultFlag = paymentApiAction.successPay(order.getSn());
break;
}
case "TRADE_CLOSED": {
order.setStatus(OrderStatus.ORDER_CANCELLATION);
orderMapper.updateById(order);
OrderLog orderLog = new OrderLog().setOrderId(order.getOrderId()).setMessage("取消订单").setOpId(order.getMemberId()).setOpTime(System.currentTimeMillis());
orderLogMapper.insert(orderLog);
}
}
}
} else if (order.getPaymentId().equals(7)) {
String tradeStatus = wxPayUtil.trade_query(order.getSn());
if (StringUtils.isNotEmpty(tradeStatus)) {
switch (tradeStatus) {
case "SUCCESS": {
boolean resultFlag = paymentApiAction.successPay(order.getSn());
break;
}
case "CLOSED": {
order.setStatus(OrderStatus.ORDER_CANCELLATION);
orderMapper.updateById(order);
OrderLog orderLog = new OrderLog().setOrderId(order.getOrderId()).setMessage("取消订单").setOpId(order.getMemberId()).setOpTime(System.currentTimeMillis());
orderLogMapper.insert(orderLog);
}
case "NOTPAY": {
if (DateUtil.compare(now, new Date(order.getExpireTime())) > 0) {
order.setStatus(OrderStatus.ORDER_CANCELLATION);
orderMapper.updateById(order);
OrderLog orderLog = new OrderLog().setOrderId(order.getOrderId()).setMessage("取消订单").setOpId(order.getMemberId()).setOpTime(System.currentTimeMillis());
orderLogMapper.insert(orderLog);
}
}
}
}
}
}
XxlJobLogger.log("结束执行支付结果查询,更新订单");
//返回执行成功.结果
return ReturnT.SUCCESS;
}
}