为什么需要任务调度平台
在实际开发时,会有很多任务,也会有一些定时任务。需要一个任务调度平台,用于做平台服务定时任务的集中管理。
下面我们介绍一个基于XXL-JOB开源框架构建的任务管理平台。平台提供了对定时任务的常规管理操作、执行情况查看、异常报警等功能。
XXL-BOX概述
XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
官方地址中文版:http://www.xuxueli.com/xxl-job
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"线程池,避免耗尽调度线程,提高系统稳定性
使用
1 pom加jar包
<properties>
<xxljob.version>2.0.0</xxljob.version>
</properties>
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.0.1</version>
</dependency>
2 创立 JobHandler
/**
* HandlerBean
*
*
* 1"IJobHandler"“com.xxl.job.core.handler.IJobHandler”
* 2Spring“@Component”SpringBean
* 3“@JobHandler(value="jobhandler")”valueJobHandler
* 4 "XxlJobLogger.log"
*
* @author xuxueli 2015-12-19 19:43:36
*/
@JobHandler(value="demoJobHandler")
@Component
public class DemoJobHandler extends IJobHandler {
@Override
public ReturnT<String> execute(String param) throws Exception {
XxlJobLogger.log("XXL-JOB, Hello World.");
//
return SUCCESS;
}
}
这里补充一下 override和overload
override是重写:重写父类的函数
overload是重载: 重写这个class里面的同名函数,但是参数类型/个数 必须和之前的重名函数不同,否则无法重载。
3 访问调度中心管理界面
在浏览器输入 http://localhost:8080/xxl-job-admin
公司会有自己的任务调度中心管理界面。自己学习就可以本地起来的管理界面
4 配置 config
需要在配置项中配置xxlJobExecutor,参考Demo程序。(官方 github:https://github.com/xuxueli/xxl-job/tree/master/xxl-job-executor-samples)
SpringBoot项目配置在XxlJobConfig
common/config/XxlJobProperties.java
package com.xxx.common.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
@Data
@ConfigurationProperties(prefix = "xxl.job")
public class XxlJobProperties {
private String adminAddresses;
private String accessToken;
private String appName;
private String ip;
private int port;
private int logRetentionDays;
private String logPath;
}
src/main/resources/application.properties
#查看 http://ip:port/xxx/
swagger.enabled=true
swagger.base-package=com.xxx.controller
swagger.title=Leads API Documents
swagger.version=0.0.1
xxl.job.accessToken=
xxl.job.appName=xxx-task
xxl.job.ip=
xxl.job.port=20802
// common/config/XxlJobConfig.java
package com.xxx..common.config;
import com.xxl.job.core.executor.XxlJobExecutor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@Slf4j
@EnableConfigurationProperties(XxlJobProperties.class)
public class XxlJobConfig {
private final XxlJobProperties xxlJob;
public XxlJobConfig(XxlJobProperties xxlJob) {
this.xxlJob = xxlJob;
}
@Bean(initMethod = "start", destroyMethod = "destroy")
public XxlJobExecutor xxlJobExecutor() {
log.info(">>>>>>>>>>> xxl-job config init.")