网站运营托管,北京海淀区官网,国外最好的设计网站,网站建设整体设计思路以前带我的人说过#xff0c;最好的学习就是看官方文档#xff0c;个人也有4个T的学习视频#xff0c;但是会发现讲的都是入门#xff0c;有的也比较浅。官方文档比较官方#xff0c;也比较权威#xff0c;打开xxl-job的官网#xff0c;写的贼详细#xff0c;有些人喜欢…以前带我的人说过最好的学习就是看官方文档个人也有4个T的学习视频但是会发现讲的都是入门有的也比较浅。官方文档比较官方也比较权威打开xxl-job的官网写的贼详细有些人喜欢收博客不喜欢看官网因此就直接复制过来了过段时间会参考文档自己来一遍。一、简介1.1 概述XXL-JOB是一个分布式任务调度平台其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线开箱即用。1.2 社区交流1.3 特性1、简单支持通过Web页面对任务进行CRUD操作操作简单一分钟上手2、动态支持动态修改任务状态、启动/停止任务以及终止运行中任务即时生效3、调度中心HA(中心式)调度采用中心式设计“调度中心”自研调度组件并支持集群部署可保证调度中心HA4、执行器HA(分布式)任务分布式执行任务”执行器”支持集群部署可保证任务执行HA5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时也支持手动录入执行器地址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、跨平台原生提供通用HTTP任务Handler(Bean任务”HttpJobHandler”)业务方只需要提供HTTP链接即可不限制语言、平台31、国际化调度中心支持国际化设置提供中文、英文两种可选语言默认为中文32、容器化提供官方docker镜像并实时更新推送dockerhub进一步实现产品开箱即用33、线程池隔离调度线程池进行隔离拆分慢任务自动降级进入”Slow”线程池避免耗尽调度线程提高系统稳定性34、用户管理支持在线管理系统用户存在管理员、普通用户两种角色35、权限控制执行器维度进行权限控制管理员拥有全量权限普通用户需要分配执行器权限后才允许相关操作1.4 下载文档地址源码仓库地址中央仓库地址com.xuxuelixxl-job-core${最新稳定版本}1.6 环境Maven3Jdk1.7Mysql5.7二、快速入门2.1 初始化“调度数据库”请下载项目源码并解压获取 “调度数据库初始化SQL脚本” 并执行即可。“调度数据库初始化SQL脚本” 位置为:/xxl-job/doc/db/tables_xxl_job.sql调度中心支持集群部署集群情况下各节点务必连接同一个mysql实例;如果mysql做主从,调度中心集群节点务必强制走主库;2.2 编译源码解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可源码结构如下xxl-job-admin调度中心xxl-job-core公共依赖xxl-job-executor-samples执行器Sample示例(选择合适的版本执行器可直接使用也可以参考其并将现有项目改造成执行器)xxl-job-executor-sample-springbootSpringboot版本通过Springboot管理执行器推荐这种方式xxl-job-executor-sample-springSpring版本通过Spring容器管理执行器比较通用xxl-job-executor-sample-frameless无框架版本xxl-job-executor-sample-jfinalJFinal版本通过JFinal管理执行器xxl-job-executor-sample-nutzNutz版本通过Nutz管理执行器xxl-job-executor-sample-jbootjboot版本通过jboot管理执行器2.3 配置部署“调度中心”调度中心项目xxl-job-admin作用统一管理任务调度平台上调度任务负责触发调度执行并且提供任务管理平台。步骤一调度中心配置调度中心配置文件地址/xxl-job/xxl-job-admin/src/main/resources/application.properties调度中心配置内容说明### 调度中心JDBC链接链接地址请保持和 2.1章节 所创建的调度数据库的地址一致spring.datasource.urljdbc:mysql://127.0.0.1:3306/xxl_job?UnicodetruecharacterEncodingUTF-8spring.datasource.usernamerootspring.datasource.passwordroot_pwdspring.datasource.driver-class-namecom.mysql.jdbc.Driver### 报警邮箱spring.mail.hostsmtp.qq.comspring.mail.port25spring.mail.usernamexxxqq.comspring.mail.passwordxxxspring.mail.properties.mail.smtp.authtruespring.mail.properties.mail.smtp.starttls.enabletruespring.mail.properties.mail.smtp.starttls.requiredtruespring.mail.properties.mail.smtp.socketFactory.classjavax.net.ssl.SSLSocketFactory### 调度中心通讯TOKEN [选填]非空时启用xxl.job.accessToken### 调度中心国际化配置 [选填] 默认为空表示中文; en 表示英文xxl.job.i18n## 调度线程池最大线程配置【必填】xxl.job.triggerpool.fast.max200xxl.job.triggerpool.slow.max100### 调度中心日志表数据保存天数 [必填]过期日志自动清理限制大于等于7时生效否则, 如-1关闭自动清理功能xxl.job.logretentiondays30步骤二部署项目如果已经正确进行上述配置可将项目编译打包部署。默认登录账号 “admin/123456”, 登录后运行界面如下图所示。至此“调度中心”项目已经部署成功。步骤三调度中心集群(可选)调度中心支持集群部署提升调度系统容灾和可用性。调度中心集群部署时几点要求和建议DB配置保持一致集群机器时钟保持一致(单机集群忽视)建议推荐通过nginx为调度中心集群做负载均衡分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。其他Docker 镜像方式搭建调度中心下载镜像// Docker地址https://hub.docker.com/r/xuxueli/xxl-job-admin/ (建议指定版本号)docker pull xuxueli/xxl-job-admin创建容器并运行docker run -p 8080:8080-v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin/*** 如需自定义 mysql 等配置可通过 PARAMS 指定参数格式 RAMS--keyvalue --key2value2 * 配置项参考文件/xxl-job/xxl-job-admin/src/main/resources/application.properties*/docker run -e PARAMS--spring.datasource.urljdbc:mysql://127.0.0.1:3306/xxl_job?UnicodetruecharacterEncodingUTF-8-p 8080:8080-v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin2.4 配置部署“执行器项目”“执行器”项目xxl-job-executor-sample-springboot (提供多种版本执行器供选择现以springboot 版本为例可直接使用也可以参考其并将现有项目改造成执行器)作用负责接收“调度中心”的调度并执行可直接部署执行器也可以将执行器集成到现有业务项目中。步骤一maven依赖确认pom文件中引入了 “xxl-job-core” 的maven依赖步骤二执行器配置执行器配置配置文件地址/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties执行器配置配置内容说明### 调度中心部署跟地址 [选填]如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行执行器心跳注册和任务结果回调为空则关闭自动注册xxl.job.admin.addresseshttp://127.0.0.1:8080/xxl-job-admin### 执行器AppName [选填]执行器心跳注册分组依据为空则关闭自动注册xxl.job.executor.appnamexxl-job-executor-sample### 执行器IP [选填]默认为空表示自动获取IP多网卡时可手动设置指定IP该IP不会绑定Host仅作为通讯实用地址信息用于 执行器注册 和 调度中心请求并触发任务xxl.job.executor.ip### 执行器端口号 [选填]小于等于0则自动获取默认端口为9999单机部署多个执行器时注意要配置不同执行器端口xxl.job.executor.port9999### 执行器通讯TOKEN [选填]非空时启用xxl.job.accessToken### 执行器运行日志文件存储磁盘路径 [选填] 需要对该路径拥有读写权限为空则使用默认路径xxl.job.executor.logpath/data/applogs/xxl-job/jobhandler### 执行器日志文件保存天数 [选填] 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能xxl.job.executor.logretentiondays30步骤三执行器组件配置执行器组件配置文件地址/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java执行器组件配置内容说明BeanpublicXxlJobSpringExecutorxxlJobExecutor(){logger.info( xxl-job config init.);XxlJobSpringExecutorxxlJobSpringExecutor newXxlJobSpringExecutor();xxlJobSpringExecutor.setAdminAddresses(adminAddresses);xxlJobSpringExecutor.setAppName(appName);xxlJobSpringExecutor.setIp(ip);xxlJobSpringExecutor.setPort(port);xxlJobSpringExecutor.setAccessToken(accessToken);xxlJobSpringExecutor.setLogPath(logPath);xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);returnxxlJobSpringExecutor;}步骤四部署执行器项目如果已经正确进行上述配置可将执行器项目编译打部署系统提供多种执行器Sample示例项目选择其中一个即可各自的部署方式如下。xxl-job-executor-sample-springboot项目编译打包成springboot类型的可执行JAR包命令启动即可xxl-job-executor-sample-spring项目编译打包成WAR包并部署到tomcat中。xxl-job-executor-sample-jfinal同上xxl-job-executor-sample-nutz同上xxl-job-executor-sample-jboot同上至此“执行器”项目已经部署结束。步骤五执行器集群(可选)执行器支持集群部署提升调度系统可用性同时提升任务处理能力。执行器集群部署时几点要求和建议执行器回调地址(xxl.job.admin.addresses)需要保持一致执行器根据该配置进行执行器自动注册等操作。同一个执行器集群内AppName(xxl.job.executor.appname)需要保持一致调度中心根据该配置动态发现不同集群的在线执行器列表。2.5 开发第一个任务“Hello World”本示例以新建一个 “GLUE模式(Java)” 运行模式的任务为例。更多有关任务的详细配置请查看“章节三任务详解”。( “GLUE模式(Java)”的执行代码托管到调度中心在线维护相比“Bean模式任务”需要在执行器项目开发部署上线更加简便轻量)前提请确认“调度中心”和“执行器”项目已经成功部署并启动步骤一新建任务登录调度中心点击下图所示“新建任务”按钮新建示例任务。然后参考下面截图中任务的参数配置点击保存。步骤二“GLUE模式(Java)” 任务开发请点击任务右侧 “GLUE” 按钮进入 “GLUE编辑器开发界面” 见下图。“GLUE模式(Java)” 运行模式的任务默认已经初始化了示例任务代码即打印Hello World。( “GLUE模式(Java)” 运行模式的任务实际上是一段继承自IJobHandler的Java类代码它在执行器项目中运行可使用Resource/Autowire注入执行器里中的其他服务详细介绍请查看第三章节)步骤三触发执行请点击任务右侧 “执行” 按钮可手动触发一次任务执行(通常情况下通过配置Cron表达式进行任务调度出发)。步骤四查看日志请点击任务右侧 “日志” 按钮可前往任务日志界面查看任务日志。在任务日志界面中可查看该任务的历史调度记录以及每一次调度的任务调度信息、执行参数和执行信息。运行中的任务点击右侧的“执行日志”按钮可进入日志控制台查看实时执行日志。在日志控制台可以Rolling方式实时查看任务在执行器一侧运行输出的日志信息实时监控任务进度三、任务详解配置属性详细说明-执行器任务的绑定的执行器任务触发调度时将会自动发现注册成功的执行器,实现任务自动发现功能;另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器,可在执行器管理进行设置;-任务描述任务的描述信息便于任务管理-路由策略当执行器集群部署时提供丰富的路由策略包括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模式时生效对应执行器中新开发的JobHandler类“JobHandler”注解自定义的value值-阻塞处理策略调度过于密集执行器来不及处理时的处理策略单机串行(默认)调度请求进入单机执行器后调度请求进入FIFO队列并以串行方式运行丢弃后续调度调度请求进入单机执行器后发现执行器存在运行的调度任务本次请求将会被丢弃并标记为失败覆盖之前调度调度请求进入单机执行器后发现执行器存在运行的调度任务将会终止运行中的调度任务并清空队列然后运行本地调度任务-子任务每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)当本任务执行结束并且执行成功时将会触发子任务ID所对应的任务的一次主动调度。-任务超时时间支持自定义任务超时时间任务运行超时将会主动中断任务-失败重试次数支持自定义任务失败重试次数当任务失败时将会按照预设的失败重试次数主动进行重试-报警邮件任务调度失败时邮件通知的邮箱地址支持配置多邮箱地址配置多个邮箱地址时用逗号分隔-负责人任务的负责人-执行参数任务执行所需的参数3.1 BEAN模式(类形式)Bean模式任务支持基于类的开发方式每个任务对应一个Java类。优点不限制项目环境兼容性好。即使是无框架项目如main方法直接启动的项目也可以提供支持可以参考示例项目 “xxl-job-executor-sample-frameless”缺点每个任务需要占用一个Java类造成类的浪费不支持自动扫描任务并注入到执行器容器需要手动注入。步骤一执行器项目中开发Job类1、开发一个继承自com.xxl.job.core.handler.IJobHandler的JobHandler类实现其中任务方法。2、手动通过如下方式注入到执行器容器。XxlJobExecutor.registJobHandler(demoJobHandler, new DemoJobHandler());步骤二调度中心新建调度任务后续步骤和 “3.2 BEAN模式(方法形式)”一致可以前往参考。3.2 BEAN模式(方法形式)Bean模式任务支持基于方法的开发方式每个任务对应一个方法。优点缺点要求Spring容器环境每个任务只需要开发一个方法并添加”XxlJob”注解即可更加方便、快速。支持自动扫描任务并注入到执行器容器。基于方法开发的任务底层会生成JobHandler代理和基于类的方式一样任务也会以JobHandler的形式存在于执行器任务容器中。步骤一执行器项目中开发Job方法1、在SpringBean实例中开发Job方法方式格式要求为public ReturnT execute(String param)2、为Job方法添加注解XxlJob(value自定义jobhandler名称, init JobHandler初始化方法, destroy JobHandler销毁方法)注解value值对应的是调度中心新建任务的JobHandler属性的值。3、执行日志需要通过XxlJobLogger.log打印执行日志// 可参考Sample示例执行器中的 com.xxl.job.executor.service.jobhandler.SampleXxlJob 如下XxlJob(demoJobHandler)publicReturnTexecute(Stringparam){XxlJobLogger.log(hello world.);returnReturnT.SUCCESS;}步骤二调度中心新建调度任务参考上文“配置属性详细说明”对新建的任务进行参数配置运行模式选中 “BEAN模式”JobHandler属性填写任务注解“XxlJob”中定义的值原生内置Bean模式任务为方便用户参考与快速实用示例执行器内原生提供多个Bean模式任务Handler可以直接配置实用如下demoJobHandler简单示例任务任务内部模拟耗时任务逻辑用户可在线体验Rolling Log等功能shardingJobHandler分片示例任务任务内部模拟处理分片参数可参考熟悉分片任务httpJobHandler通用HTTP任务Handler业务方只需要提供HTTP链接即可不限制语言、平台commandJobHandler通用命令行任务Handler业务方只需要提供命令行即可如 “pwd”命令3.3 GLUE模式(Java)任务以源码方式维护在调度中心支持通过Web IDE在线更新实时编译和生效因此不需要指定JobHandler。开发流程如下步骤一调度中心新建调度任务参考上文“配置属性详细说明”对新建的任务进行参数配置运行模式选中 “GLUE模式(Java)”步骤二开发任务代码选中指定任务点击该任务右侧“GLUE”按钮将会前往GLUE任务的Web IDE界面在该界面支持对任务代码进行开发(也可以在IDE中开发完成后复制粘贴到编辑中)。版本回溯功能(支持30个版本的版本回溯)在GLUE任务的Web IDE界面选择右上角下拉框“版本回溯”会列出该GLUE的更新历史选择相应版本即可显示该版本代码保存后GLUE代码即回退到对应的历史版本3.4 GLUE模式(Shell)步骤一调度中心新建调度任务参考上文“配置属性详细说明”对新建的任务进行参数配置运行模式选中 “GLUE模式(Shell)”步骤二开发任务代码选中指定任务点击该任务右侧“GLUE”按钮将会前往GLUE任务的Web IDE界面在该界面支持对任务代码进行开发(也可以在IDE中开发完成后复制粘贴到编辑中)。该模式的任务实际上是一段 “shell” 脚本3.4 GLUE模式(Python)步骤一调度中心新建调度任务参考上文“配置属性详细说明”对新建的任务进行参数配置运行模式选中 “GLUE模式(Python)”步骤二开发任务代码选中指定任务点击该任务右侧“GLUE”按钮将会前往GLUE任务的Web IDE界面在该界面支持对任务代码进行开发(也可以在IDE中开发完成后复制粘贴到编辑中)。该模式的任务实际上是一段 “python” 脚本3.5 GLUE模式(NodeJS)步骤一调度中心新建调度任务参考上文“配置属性详细说明”对新建的任务进行参数配置运行模式选中 “GLUE模式(NodeJS)”步骤二开发任务代码选中指定任务点击该任务右侧“GLUE”按钮将会前往GLUE任务的Web IDE界面在该界面支持对任务代码进行开发(也可以在IDE中开发完成后复制粘贴到编辑中)。该模式的任务实际上是一段 “nodeJS” 脚本3.6 GLUE模式(PHP)同上3.7 GLUE模式(PowerShell)同上四、操作指南4.1 配置执行器点击进入”执行器管理”界面, 如下图:1、调度中心OnLine:右侧显示在线的调度中心列表,任务执行结束后,将会以failover的模式进行回调调度中心通知执行结果,避免回调的单点风险;2、执行器列表中显示在线的执行器列表,可通过OnLine 机器查看对应执行器的集群机器。点击按钮 “新增执行器” 弹框如下图, 可新增执行器配置:执行器属性说明AppName:是每个执行器集群的唯一标示AppName,执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器,供任务调度时使用;名称:执行器的名称,因为AppName限制字母数字等组成,可读性不强,名称为了提高执行器的可读性;排序:执行器的排序,系统中需要执行器的地方,如任务新增,将会按照该排序读取可用的执行器列表;注册方式调度中心获取执行器地址的方式自动注册执行器自动进行执行器注册调度中心通过底层注册表可以动态发现执行器机器地址手动录入人工手动录入执行器的地址信息多地址逗号分隔供调度中心使用机器地址注册方式为手动录入时有效支持人工维护执行器的地址信息4.2 新建任务进入任务管理界面点击“新增任务”按钮在弹出的“新增任务”界面配置任务属性后保存即可。详情页参考章节 “三、任务详解”。4.3 编辑任务进入任务管理界面选中指定任务。点击该任务右侧“编辑”按钮在弹出的“编辑任务”界面更新任务属性后保存即可可以修改设置的任务属性信息4.4 编辑GLUE代码该操作仅针对GLUE任务。选中指定任务点击该任务右侧“GLUE”按钮将会前往GLUE任务的Web IDE界面在该界面支持对任务代码进行开发。可参考章节 “3.3 GLUE模式(Java)”。4.5 启动/停止任务可对任务进行“启动”和“停止”操作。需要注意的是此处的启动/停止仅针对任务的后续调度触发行为不会影响到已经触发的调度任务如需终止已经触发的调度任务可查看“4.9 终止运行中的任务”4.6 手动触发一次调度点击“执行”按钮可手动触发一次任务调度不影响原有调度规则。4.7 查看调度日志点击“日志”按钮可以查看任务历史调度日志。在历史调入日志界面可查看每次任务调度的调度结果、执行结果等点击“执行日志”按钮可查看执行器完整日志。调度时间调度中心触发本次调度并向执行器发送任务执行信号的时间调度结果调度中心触发本次调度的结果200表示成功500或其他表示失败调度备注调度中心触发本次调度的日志信息执行器地址本次任务执行的机器地址运行模式触发调度时任务的运行模式运行模式可参考章节三、任务详解任务参数本地任务执行的入参执行时间执行器中本次任务执行结束后回调的时间执行结果执行器中本次任务执行的结果200表示成功500或其他表示失败执行备注执行器中本次任务执行的日志信息操作执行日志按钮点击可查看本地任务执行的详细日志信息详见“4.8查看执行日志”终止任务按钮点击可终止本地调度对应执行器上本任务的执行线程包括未执行的阻塞任务一并被终止4.8 查看执行日志点击执行日志右侧的 “执行日志” 按钮可跳转至执行日志界面可以查看业务代码中打印的完整日志如下图4.9 终止运行中的任务仅针对执行中的任务。在任务日志界面点击右侧的“终止任务”按钮将会向本次任务对应的执行器发送任务终止请求将会终止掉本次任务同时会清空掉整个任务执行队列。任务终止时通过 “interrupt” 执行线程的方式实现, 将会触发 “InterruptedException” 异常。因此如果JobHandler内部catch到了该异常并消化掉的话, 任务终止功能将不可用。因此, 如果遇到上述任务终止不可用的情况, 需要在JobHandler中应该针对 “InterruptedException” 异常进行特殊处理 (向上抛出) , 正确逻辑如下:try{// do something}catch(Exceptione){if(e instanceofInterruptedException){throwe;}logger.warn({},e);}而且在JobHandler中开启子线程时子线程也不可catch处理”InterruptedException”应该主动向上抛出。任务终止时会执行对应JobHandler的”destroy()”方法可以借助该方法处理一些资源回收的逻辑。4.10 删除执行日志在任务日志界面选中执行器和任务之后点击右侧的”删除”按钮将会出现”日志清理”弹框弹框中支持选择不同类型的日志清理策略选中后点击”确定”按钮即可进行日志清理操作4.11 删除任务点击删除按钮可以删除对应任务。4.12 用户管理进入 “用户管理” 界面可查看和管理用户信息目前用户分为两种角色管理员拥有全量权限支持在线管理用户信息为用户分配权限权限分配粒度为执行器普通用户仅拥有被分配权限的执行器及相关任务的操作权限五、总体设计5.1 源码目录介绍-/doc :文档资料-/db :“调度数据库”建表脚本-/xxl-job-admin :调度中心项目源码-/xxl-job-core :公共Jar依赖-/xxl-job-executor-samples :执行器Sample示例项目(大家可以在该项目上进行开发也可以将现有项目改造生成执行器项目)5.2 “调度数据库”配置XXL-JOB调度模块基于自研调度组件并支持集群部署调度数据库表说明如下-xxl_job_lock任务调度锁表-xxl_job_group执行器信息表维护任务执行器信息-xxl_job_info调度扩展信息表用于保存XXL-JOB调度任务的扩展信息如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等-xxl_job_log调度日志表用于保存XXL-JOB任务调度的历史信息如调度结果、执行结果、调度入参、调度机器和执行器等等-xxl_job_log_report调度日志报表用户存储XXL-JOB任务调度日志的报表调度中心报表功能页面会用到-xxl_job_logglue任务GLUE日志用于保存GLUE更新历史用于支持GLUE的版本回溯功能-xxl_job_registry执行器注册表维护在线的执行器和调度中心机器地址信息-xxl_job_user系统用户表5.3 架构设计5.3.1 设计思想将调度行为抽象形成“调度中心”公共平台而平台自身并不承担业务逻辑“调度中心”负责发起调度请求。将任务抽象成分散的JobHandler交由“执行器”统一管理“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。因此“调度”和“任务”两部分可以相互解耦提高系统整体稳定性和扩展性5.3.2 系统组成调度模块(调度中心)负责管理调度信息按照调度配置发出调度请求自身不承担业务代码。调度系统与任务解耦提高了系统可用性和稳定性同时调度系统性能不再受限于任务模块支持可视化、简单且动态的管理调度信息包括任务新建更新删除GLUE开发和任务报警等所有上述操作都会实时生效同时支持监控调度结果以及执行日志支持执行器Failover。执行模块(执行器)负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作开发和维护更加简单和高效接收“调度中心”的执行请求、终止请求和日志请求等。5.3.3 架构图5.4 调度模块剖析5.4.1 quartz的不足Quartz作为开源作业调度中的佼佼者是作业调度的首选。但是集群环境中Quartz采用API的方式对任务进行管理从而可以避免上述问题但是同样存在以下问题问题一调用API的的方式操作任务不人性化问题二需要持久化业务QuartzJobBean到底层数据表中系统侵入性相当严重。问题三调度逻辑和QuartzJobBean耦合在同一个项目中这将导致一个问题在调度任务数量逐渐增多同时调度任务逻辑逐渐加重的情况下此时调度系统的性能将大大受限于业务问题四quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务会导致节点负载悬殊非常大而XXL-JOB通过执行器实现“协同分配式”运行任务充分发挥集群优势负载各节点均衡。XXL-JOB弥补了quartz的上述不足之处。5.4.2 自研调度模块XXL-JOB最终选择自研调度组件(早期调度组件基于Quartz)一方面是为了精简系统降低冗余依赖另一方面是为了提供系统的可控度与稳定性XXL-JOB中“调度模块”和“任务模块”完全解耦调度模块进行任务调度时将会解析不同的任务参数发起远程调用调用各自的远程执行器服务。这种调用模型类似RPC调用调度中心提供调用代理的功能而执行器提供远程服务的功能。5.4.3 调度中心HA(集群)基于数据库的集群方案数据库选用Mysql集群分布式并发环境中进行定时任务调度时会在各个节点会上报任务存到数据库中执行时会从数据库中取出触发器来执行如果触发器的名称和执行时间相同则只有一个节点去执行此任务。5.4.4 调度线程池调度采用线程池方式实现避免单线程因阻塞而引起任务调度延迟。5.4.5 并行调度XXL-JOB调度模块默认采用并行机制在多线程调度的情况下调度模块被阻塞的几率很低大大提高了调度系统的承载量。XXL-JOB的每个调度任务虽然在调度模块是并行调度执行的但是任务调度传递到任务模块的“执行器”确实串行执行的同时支持任务终止。5.4.6 过期处理策略任务调度错过触发时间时的处理策略可能原因服务重启调度线程被阻塞线程被耗尽上次调度持续阻塞下次调度被错过处理策略过期超5s本次忽略当前时间开始计算下次触发时间过期5s内立即触发一次当前时间开始计算下次触发时间5.4.7 日志回调服务调度模块的“调度中心”作为Web服务部署时一方面承担调度中心功能另一方面也为执行器提供API服务。调度中心提供的”日志回调服务API服务”代码位置如下xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback“执行器”在接收到任务执行请求后执行任务在执行结束之后会将执行结果回调通知“调度中心”5.4.8 任务HA(Failover)执行器如若集群部署调度中心将会感知到在线的所有执行器如“127.0.0.1:9997, 127.0.0.1:9998, 127.0.0.1:9999”。当任务”路由策略”选择”故障转移(FAILOVER)”时当调度中心每次发起调度请求时会按照顺序对执行器发出心跳检测请求第一个检测为存活状态的执行器将会被选定并发送调度请求。调度成功后可在日志监控界面查看“调度备注”如下“调度备注”可以看出本地调度运行轨迹执行器的”注册方式”、”地址列表”和任务的”路由策略”。”故障转移(FAILOVER)”路由策略下调度中心首先对第一个地址进行心跳检测心跳失败因此自动跳过第二个依然心跳检测失败……直至心跳检测第三个地址“127.0.0.1:9999”成功选定为“目标执行器”然后对“目标执行器”发送调度请求调度流程结束等待执行器回调执行结果。5.4.9 调度日志调度中心每次进行任务调度都会记录一条任务日志任务日志主要包括以下三部分内容任务信息包括“执行器地址”、“JobHandler”和“执行参数”等属性点击任务ID按钮可查看根据这些参数可以精确的定位任务执行的具体机器和任务代码调度信息包括“调度时间”、“调度结果”和“调度日志”等根据这些参数可以了解“调度中心”发起调度请求时具体情况。执行信息包括“执行时间”、“执行结果”和“执行日志”等根据这些参数可以了解在“执行器”端任务执行的具体情况调度日志针对单次调度属性说明如下执行器地址任务执行的机器地址JobHandlerBean模式表示任务执行的JobHandler名称任务参数任务执行的入参调度时间调度中心发起调度的时间调度结果调度中心发起调度的结果SUCCESS或FAIL调度备注调度中心发起调度的备注信息如地址心跳检测日志等执行时间执行器任务执行结束后回调的时间执行结果执行器任务执行的结果SUCCESS或FAIL执行备注执行器任务执行的备注信息如异常日志等执行日志任务执行过程中业务代码中打印的完整执行日志见“4.8 查看执行日志”5.4.10 任务依赖原理XXL-JOB中每个任务都对应有一个任务ID同时每个任务支持设置属性“子任务ID”因此通过“任务ID”可以匹配任务依赖关系。当父任务执行结束并且执行成功时将会根据“子任务ID”匹配子任务依赖如果匹配到子任务将会主动触发一次子任务的执行。在任务日志界面点击任务的“执行备注”的“查看”按钮可以看到匹配子任务以及触发子任务执行的日志信息如无信息则表示未触发子任务执行可参考下图。5.4.11 全异步化 轻量级全异步化设计XXL-JOB系统中业务逻辑在远程执行器执行触发流程全异步化设计。相比直接在调度中心内部执行业务逻辑极大的降低了调度线程占用时间轻量级设计XXL-JOB调度中心中每个JOB逻辑非常 “轻”在全异步化的基础上单个JOB一次运行平均耗时基本在 “10ms” 之内(基本为一次请求的网络开销)因此可以保证使用有限的线程支撑大量的JOB并发运行异步调度调度中心每次任务触发时仅发送一次调度请求该调度请求首先推送“异步调度队列”然后异步推送给远程执行器异步执行执行器会将请求存入“异步执行队列”并且立即响应调度中心异步运行。得益于上述两点优化理论上默认配置下的调度中心单机能够支撑 5000 任务并发运行稳定运行实际场景中由于调度中心与执行器网络ping延迟不同、DB读写耗时不同、任务调度密集程度不同会导致任务量上限会上下波动。如若需要支撑更多的任务量可以通过 “调大调度线程数” 、”降低调度中心与执行器ping延迟” 和 “提升机器配置” 几种方式优化。5.4.12 均衡调度调度中心在集群部署时会自动进行任务平均分配触发组件每次获取与线程池数量(调度中心支持自定义调度线程池大小)相关数量的任务避免大量任务集中在单个调度中心集群节点5.5 任务 “运行模式” 剖析5.5.1 “Bean模式” 任务开发步骤可参考 “章节三” 原理每个Bean模式任务都是一个Spring的Bean类实例它被维护在“执行器”项目的Spring容器中。任务类需要加“JobHandler(value”名称”)”注解因为“执行器”会根据该注解识别Spring容器中的任务。任务类需要继承统一接口“IJobHandler”任务逻辑在execute方法中开发因为“执行器”在接收到调度中心的调度请求时将会调用“IJobHandler”的execute方法执行任务逻辑。5.5.2 “GLUE模式(Java)” 任务开发步骤可参考 “章节三” 原理每个 “GLUE模式(Java)” 任务的代码实际上是“一个继承自“IJobHandler”的实现类的类代码”“执行器”接收到“调度中心”的调度请求时会通过Groovy类加载器加载此代码实例化成Java对象同时注入此代码中声明的Spring服务(请确保Glue代码中的服务和类引用在“执行器”项目中存在)然后调用该对象的execute方法执行任务逻辑。5.5.3 GLUE模式(Shell) GLUE模式(Python) GLUE模式(NodeJS)开发步骤可参考 “章节三” 原理脚本任务的源码托管在调度中心脚本逻辑在执行器运行。当触发脚本任务时执行器会加载脚本源码在执行器机器上生成一份脚本文件然后通过Java代码调用该脚本并且实时将脚本输出日志写到任务日志文件中从而在调度中心可以实时监控脚本运行情况目前支持的脚本类型如下-shell脚本任务运行模式选择为GLUE模式(Shell)时支持shell脚本任务-python脚本任务运行模式选择为GLUE模式(Python)时支持python脚本任务-nodejs脚本务运行模式选择为GLUE模式(NodeJS)时支持nodejs脚本任务脚本任务通过 Exit Code 判断任务执行结果状态码可参考章节 “5.15 任务执行结果说明”5.5.4 执行器执行器实际上是一个内嵌的Server默认端口9999(配置项xxl.job.executor.port)。在项目启动时执行器会通过“JobHandler”识别Spring容器中“Bean模式任务”以注解的value属性为key管理起来。“执行器”接收到“调度中心”的调度请求时如果任务类型为“Bean模式”将会匹配Spring容器中的“Bean模式任务”然后调用其execute方法执行任务逻辑。如果任务类型为“GLUE模式”将会加载GLue代码实例化Java对象注入依赖的Spring服务(注意Glue代码中注入的Spring服务必须存在与该“执行器”项目的Spring容器中)然后调用execute方法执行任务逻辑。5.5.5 任务日志XXL-JOB会为每次调度请求生成一个单独的日志文件需要通过 “XxlJobLogger.log” 打印执行日志“调度中心”查看执行日志时将会加载对应的日志文件。(历史版本通过重写LOG4J的Appender实现存在依赖限制该方式在新版本已经被抛弃)日志文件存放的位置可在“执行器”配置文件进行自定义默认目录格式为/data/applogs/xxl-job/jobhandler/“格式化日期”/“数据库调度日志记录的主键ID.log”。在JobHandler中开启子线程时子线程将会将会把日志打印在父线程即JobHandler的执行日志中方便日志追踪。5.6 通讯模块剖析5.6.1 一次完整的任务调度通讯流程-1、“调度中心”向“执行器”发送http调度请求:“执行器”中接收请求的服务实际上是一台内嵌Server默认端口9999;-2、“执行器”执行任务逻辑-3、“执行器”http回调“调度中心”调度结果:“调度中心”中接收回调的服务是针对执行器开放一套API服务;5.6.2 通讯数据加密调度中心向执行器发送的调度请求时使用RequestModel和ResponseModel两个对象封装调度请求参数和响应数据, 在进行通讯之前底层会将上述两个对象对象序列化并进行数据协议以及时间戳检验,从而达到数据加密的功能;5.7 任务注册, 任务自动发现自v1.5版本之后, 任务取消了”任务执行机器”属性, 改为通过任务注册和自动发现的方式, 动态获取远程执行器地址并执行。AppName:每个执行器机器集群的唯一标示,任务注册以执行器为最小粒度进行注册;每个任务通过其绑定的执行器可感知对应的执行器机器列表;注册表:见xxl_job_registry表,执行器在进行任务注册时将会周期性维护一条注册记录即机器地址和AppName的绑定关系;调度中心从而可以动态感知每个AppName在线的机器列表;执行器注册:任务注册Beat周期默认30s;执行器以一倍Beat进行执行器注册,调度中心以一倍Beat进行动态任务发现;注册信息的失效时间为三倍Beat;执行器注册摘除执行器销毁时将会主动上报调度中心并摘除对应的执行器机器信息提高心跳注册的实时性为保证系统”轻量级”并且降低学习部署成本没有采用Zookeeper作为注册中心采用DB方式进行任务注册发现5.8 任务执行结果自v1.6.2之后任务执行结果通过 “IJobHandler” 的返回值 “ReturnT” 进行判断当返回值符合 “ReturnT.code ReturnT.SUCCESS_CODE” 时表示任务执行成功否则表示任务执行失败而且可以通过 “ReturnT.msg” 回调错误信息给调度中心从而在任务逻辑中可以方便的控制任务执行结果5.9 分片广播 动态分片执行器集群部署时任务路由策略选择”分片广播”情况下一次任务调度将会广播触发对应集群中所有执行器执行一次任务同时系统自动传递分片参数可根据分片参数开发分片任务“分片广播” 以执行器为维度进行分片支持动态扩容执行器集群从而动态增加分片数量协同进行业务处理在进行大数据量业务操作时可显著提升任务处理能力和速度。“分片广播” 和普通任务开发流程一致不同之处在于可以可以获取分片参数获取分片参数进行分片业务处理。Java语言任务获取分片参数方式BEAN、GLUE模式(Java)// 可参考Sample示例执行器中的示例任务ShardingJobHandler了解试用ShardingUtil.ShardingVOshardingVO ShardingUtil.getShardingVo();脚本语言任务获取分片参数方式GLUE模式(Shell)、GLUE模式(Python)、GLUE模式(Nodejs)// 脚本任务入参固定为三个依次为任务传参、分片序号、分片总数。以Shell模式任务为例获取分片参数代码如下echo 分片序号 index $2echo 分片总数 total $3分片参数属性说明index当前分片序号(从0开始)执行器集群列表中当前执行器的序号total总分片数执行器集群的总机器数量该特性适用场景如1、分片任务场景10个执行器的集群来处理10w条数据每台机器只需要处理1w条数据耗时降低10倍2、广播任务场景广播执行器机器运行shell脚本、广播集群节点进行缓存更新等5.10 访问令牌(AccessToken)为提升系统安全性调度中心和执行器进行安全性校验双方AccessToken匹配才允许通讯调度中心和执行器可通过配置项 “xxl.job.accessToken” 进行AccessToken的设置。调度中心和执行器如果需要正常通讯只有两种设置设置一调度中心和执行器均不设置AccessToken关闭安全性校验设置二调度中心和执行器设置了相同的AccessToken5.11 调度中心API服务调度中心提供了API服务主要分为两种类型5.11.1 提供给执行器的API服务1、任务结果回调服务2、执行器注册服务3、执行器注册摘除服务4、触发任务单次执行服务支持任务根据业务事件触发API服务位置com.xxl.job.core.biz.AdminBiz.javaAPI服务请求参考代码com.xxl.job.adminbiz.AdminBizTest.java5.11.2 提供给业务的API服务1、任务列表查询2、任务新增3、任务更新4、任务删除5、任务启动6、任务停止7、任务触发API服务位置com.xxl.job.admin.controller.JobInfoController.javaAPI服务请求参考代码可参考任务界面操作的ajax请求。任何ajax接口均可配置成为API服务只需在待启用的API服务上添加 “PermissionLimit(limit false)” 注解取消登陆态拦截即可5.12 执行器API服务执行器提供了API服务供调度中心选择使用目前提供的API服务有1、心跳检测调度中心使用2、忙碌检测调度中心使用3、触发任务执行调度中心使用本地进行任务开发时可使用该API服务模拟触发任务4、获取RollingLog调度中心使用5、终止任务调度中心使用API服务位置com.xxl.job.core.biz.ExecutorBizAPI服务请求参考代码com.xxl.job.executor.ExecutorBizTest5.13 故障转移 失败重试一次完整任务流程包括”调度(调度中心) 执行(执行器)”两个阶段。“故障转移”发生在调度阶段在执行器集群部署时如果某一台执行器发生故障该策略支持自动进行Failover切换到一台正常的执行器机器并且完成调度请求流程。“失败重试”发生在”调度 执行”两个阶段支持通过自定义任务失败重试次数当任务失败时将会按照预设的失败重试次数主动进行重试5.14 执行器灰度上线调度中心与业务解耦只需部署一次后常年不需要维护。但是执行器中托管运行着业务作业作业上线和变更需要重启执行器尤其是Bean模式任务。执行器重启可能会中断运行中的任务。但是XXL-JOB得益于自建执行器与自建注册中心可以通过灰度上线的方式避免因重启导致的任务中断的问题。步骤如下1、执行器改为手动注册下线一半机器列表(A组)线上运行另一半机器列表(B组)2、等待A组机器任务运行结束并编译上线执行器注册地址替换为A组3、等待B组机器任务运行结束并编译上线执行器注册地址替换为A组B组操作结束5.15 任务执行结果说明系统根据以下标准判断任务执行结果可参考之。—Bean/Glue(Java)Glue(Shell) 等脚本任务成功IJobHandler.SUCCESS0失败IJobHandler.FAIL-1(非0状态码)5.16 任务超时控制支持设置任务超时时间任务运行超时的情况下将会主动中断任务需要注意的是任务超时中断时与任务终止机制(可查看“4.9 终止运行中的任务”)类似也是通过 “interrupt” 中断任务因此业务代码需要将 “InterruptedException” 外抛否则功能不可用。5.17 跨平台 跨语言跨平台、跨语言主要体现在以下两个方面1、提供Java、Python、PHP……等十来种任务模式可参考章节 “5.5 任务 “运行模式” ”理论上可扩展任意语言任务模式2、提供基于HTTP的任务Handler(Bean任务JobHandler”HttpJobHandler”)业务方只需要提供HTTP链接即可不限制语言、平台5.18 任务失败告警默认提供邮件失败告警可扩展短信、钉钉等方式扩展代码位置为 “JobFailMonitorHelper.failAlarm”5.19 调度中心Docker镜像构建可以通过以下命令快速构建调度中心并启动运行mvn clean packagedocker build -t xuxueli/xxl-job-admin ./xxl-job-admindocker run --name xxl-job-admin -p 8080:8080-d xuxueli/xxl-job-admin5.20 避免任务重复执行调度密集或者耗时任务可能会导致任务阻塞集群情况下调度组件小概率情况下会重复触发针对上述情况可以通过结合 “单机路由策略(如第一台、一致性哈希)” “阻塞策略(如单机串行、丢弃后续调度)” 来规避最终避免任务重复执行。5.21 命令行任务原生提供通用命令行任务Handler(Bean任务”CommandJobHandler”)业务方只需要提供命令行即可如任务参数 “pwd” 将会执行命令并输出数据5.22 日志自动清理XXL-JOB日志主要包含如下两部分均支持日志自动清理说明如下调度中心日志表数据可借助配置项 “xxl.job.logretentiondays” 设置日志表数据保存天数过期日志自动清理详情可查看上文配置说明执行器日志文件数据可借助配置项 “xxl.job.executor.logretentiondays” 设置日志文件数据保存天数过期日志自动清理详情可查看上文配置说明
