分布式任务调度平台xxl-job集成spring or springBoot项目 步骤
分布式任务调度平台xxl-job集成spring or springBoot项目 步骤
1、xxl-job简介
xxl-job是一个轻量级分布式任务调度平台，支持通过web页面对任务进行增删改查、动态修改任务状态、启动、停止等；支持多种阻塞处理策略，如串行、丢弃后续调度、覆盖之前调度，支持超时控制、失败重试、邮件报警等处理；更多详情可参考官方网站http://www.xuxueli.com/xxl-job
2、XXL-JOB集成操作步骤
2.1 添加maven依赖
2.2 添加配置文件
配置内容如下：
###调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；
xxl.job.admin.addresses=http://192.168.251.113:8090/xxl-job-admin
###执行器通讯Token[选填]非空时启用
xxl.job.accessToken=
执行器AppName：执行器心跳注册分组依据
xxl.job.executor.appname=xxl-job-executor（名字随便取）
执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 “执行器注册” 和 “调度中心请求并触发任务”；
xxl.job.executor.ip=
执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30
2.3 编写配置类/配置ApplicationContext.xml文件
(1) springBoot项目选择此配置类内容
配置类代码如下：
@Configuration
public class DmpXxlJobConfig {
private Logger logger = LoggerFactory.getLogger(DmpXxlJobConfig.class);
@Value("{xxl.job.accessToken}")
private String accessToken;
@Value("{xxl.job.executor.address}")
private String address;
@Value("{xxl.job.executor.port}")
private int port;
@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.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
(2) spring项目选择此配置文件内容
配置内容如下:
2.4 编写Handler类开发job方法
（1）在Spring Bean实例中，开发Job方法，格式要求为 “public ReturnT execute(String param)”；
（2）为Job方法添加注解 “@XxlJob(value=“自定义jobhandler名称”, init = “JobHandler初始化方法”, destroy = “JobHandler销毁方法”)”，注解value值对应的是调度中心新建任务的JobHandler属性的值。
（3）执行日志：需要通过 “XxlJobLogger.log” 打印执行日志；
2.5 启动执行器项目
以上步骤确认编写无误后可启动执行器项目。
2.6 任务调度中心配置定时任务(此处省略部署步骤)
（1）访问http://localhost:8090/xxl-job-admin
用户名：admin 密码：123456
（2）新增执行器
执行器属性说明：
AppName：是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用（即在2.2中配置的AppName）
名称：执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
排序：执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式：调度中心获取执行器地址的方式；
自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；
（3）新增任务
任务属性说明：
执行器：任务的绑定的执行器，即选择在执行器管理中配置的执行器，每个任务必须绑定一个执行器；
任务描述：任务的描述信息，便于任务管理；
路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
FIRST（第一个）：固定选择第一个机器；
LAST（最后一个）：固定选择最后一个机器；
ROUND（轮询）：；
RANDOM（随机）：随机选择在线的机器；
CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务
Cron：触发任务执行的Cron表达式；
运行模式：
BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 “JobHandler” 属性匹配执行器中任务；
GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 “groovy” 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “shell” 脚本；
GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “python” 脚本；
GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “php” 脚本；
GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “nodejs” 脚本；
GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “PowerShell” 脚本；
JobHandler：运行模式为 “BEAN模式” 时生效，对应执行器中新开发的Handler类中“@JobHandler”注解自定义的value值（注：一定要对应上，否则任务会执行失败）；
阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
子任务：填写任务id，多个则用逗号隔开，当本任务执行成功结束时会触发调度一次所填写的任务id对应的任务；
任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；
报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
负责人：任务的负责人；
执行参数：任务执行所需的参数；