XXL-JOB快速入门搭建
XXL-JOB快速入门搭建
- 1. 官方地址
- 2. 概述
- 2.1 XXL-JOB特性
- 3. 快速入门搭建
- 3.1 初始化`调度数据库`
- 3.2 部署调度中心
- 3.2.1 调度中心配置
- 3.2.2 项目部署
- 3.2.3 调度中心集群(可选)
- 3.2.3 部署执行器项目
- 3.3 集成到现有项目(为例)
- 3.3.1 项目里引入`xxl-job-core`的依赖
- 3.3.2 执行器配置
- 3.3.3 执行器组件配置
- 3.3.4 部署执行器项目
- 3.3.5 执行器项目集群(可选)
- 3.4 自己项目任务开发
- 3.4.1 在执行器项目中新建自己的调度任务
- 3.4.2 在调度中心新建任务
- 3.4.1 启动调度中心，启动执行器项目
1. 官方地址
点击访问 官方地址（中文版）
2. 概述
XXL-JOB是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。
2.1 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"线程池，避免耗尽调度线程，提高系统稳定性
3. 快速入门搭建
以 version 2.3.0 为例，解压源码，按照maven格式将源码导入IDE， 使用maven进行编译即可，源码结构如下：
xxl-job-admin 调度中心
xxl-job-core 公共依赖
xxl-job-executor-samples 执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
xxl-job-executor-sample-frameless无框架版本
xxl-job-executor-sample-springbootSpringboot版本，通过Springboot管理执行器，推荐这种方式
3.1 初始化调度数据库
官网下载项目源码并解压，获取 调度数据库初始化SQL脚本 执行即可，正常情况下应该生成8张表。
SQL脚本位置：/xxl-job/doc/db/tables_xxl_job.sql
⚠️注意⚠️
调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例；如果mysql做主从,调度中心集群节点务必强制走主库
3.2 部署调度中心
调度中心项目：xxl-job-admin
作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。
3.2.1 调度中心配置
调度中心配置文件地址：/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties
### web
server.port=8080
server.servlet.context-path=/xxl-job-admin### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false### resources
spring.mvc.servlet.load-on-startup=0
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
#mybatis.type-aliases-package=com.xxl.job.admin.core.model### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@qq.com
spring.mail.password=xxx_pwd
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 is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN## 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
修改mysql的连接信息：
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
修改email的链接信息：
### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@qq.com
spring.mail.password=xxx_pwd
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
3.2.2 项目部署
如已经正确进行上述配置，可将项目编译打包部署。
调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)
账号/密码：admin/123456
登录后运行界面，如下图所示：
至此调度中心管理中心已经部署成功了~~
3.2.3 调度中心集群(可选)
调度中心支持集群部署，提升调度系统容灾和可用性。
调度中心集群部署时，几点要求和建议：
- DB配置保持一致；
- 登陆账号配置保持一致；
- 集群机器时钟保持一致（单机集群忽视）；
- 建议：推荐通过nginx为调度中心集群做负载均衡，分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。
3.2.3 部署执行器项目
执行器负责接收“调度中心”的调度并执行；在源码中已经给出了多种执行器项目示例，可根据项目实际情况直接将其部署作为你自己的执行器，当然你也可以将执行器集成到现有业务项目中去。
3.3 集成到现有项目(为例)
3.3.1 项目里引入xxl-job-core的依赖
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.3.0</version>
</dependency>
3.3.2 执行器配置
将源码中
/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties
下的配置信息copy一份
添加到你的项目的application.yml 文件中去，注意修改自己的配置信息
xxl:job:admin:# 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；addresses: http://127.0.0.1:8080/xxl-job-admin# 执行器通讯TOKEN [选填]：非空时启用；accessToken:executor:# 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册appname: xxl-job-executor-sampleaddress:# 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；ip:# 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；port: 9999# 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；logpath: /data/applogs/xxl-job/jobhandler/# 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；logretentiondays: -1
3.3.3 执行器组件配置
执行器组件配置信息位置
\xxl-job\xxl-job-executor-samples\xxl-job-executor-sample-springboot\src\main\java\com\xxl\job\executor\core\config\XxlJobConfig.java
找到这个 XxlJobConfig.java
复制一份到你的项目里即可
3.3.4 部署执行器项目
如果已经正确进行上述配置，可将执行器项目编译打部署，源码中执行器示例项目各自的部署方式如下：
xxl-job-executor-sample-springboot 项目编译打包成springboot类型的可执行JAR包，命令启动即可
至此执行器项目已经部署结束~~
3.3.5 执行器项目集群(可选)
执行器支持集群部署，提升调度系统可用性，同时提升任务处理能力。
执行器集群部署时，几点要求和建议：
- 执行器回调地址（
xxl.job.admin.addresses）需要保持一致；执行器根据该配置进行执行器自动注册等操作 - 同一个执行器集群内AppName（
xxl.job.executor.appname）需要保持一致；调度中心根据该配置动态发现不同集群的在线执行器列表
3.4 自己项目任务开发
3.4.1 在执行器项目中新建自己的调度任务
代码示例：
package michael.spica.demo.jobhandler;import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;/*** Created by michael on 2018/10/25.*/
@Slf4j
@Component
public class EntranceJobHandler {@XxlJob("demoJobHandler")public void demoJobHandler() throws Exception {System.out.println("XXL-JOB Hello World");// 获取参数String param = XxlJobHelper.getJobParam();log.info("接收调度中心参数:\n{}", param);// 控制台输出日志log.info("myXxlJobHandler execute...");try {//书写业务逻辑// TODO-MICHAEL: 2018/10/25 // 写日志到调度中心日志中XxlJobHelper.log("myXxlJobHandler execute Success...");// 设置任务结果XxlJobHelper.handleSuccess();} catch (Exception e) {log.error("myXxlJobHandler execute Fail ...", e);//写日志到调度中心日志中XxlJobHelper.log("myXxlJobHandler execute Fail...");// 设置任务结果XxlJobHelper.handleFail();}}
}
3.4.2 在调度中心新建任务
登录调度中心，点击下图所示 新建任务 按钮，新建示例任务；然后，参考下面截图中任务的参数配置，点击保存
页面中的 JobHandler 属性要与自己任务 @XxlJob("demoJobHandler") 的value值保持一致
设置完成之后，点击保存
点击此任务右侧操作，选择将任务启动
3.4.1 启动调度中心，启动执行器项目
运行效果如下：
至此，xxl-job 快速入门搭建已完成 ~~
XXL-JOB快速入门搭建相关推荐
- webpy快速入门 搭建python服务器
1.从一个web.py的hello world的DEMO服务说起 (1)编写web.py的web应用 import web #引入web.py的包#定义web应用的路由规则 urls = ('/', ...
- 服务器搭建快速入门——适用于Android应用服务器、微信小程序服务器（一）
目录 服务器搭建快速入门--适用于Android应用服务器.微信小程序服务器 适用人群 使用方案 准备工作 硬件方面 软件方面 开始搭建 服务器搭建快速入门--适用于Android应用服务器.微信小程 ...
- 说一下dubbo项目简单的搭建过程_dubbo学习(1)--简单的入门搭建实例
1 简介 dubbo是一个分布式服务框架,由阿里巴巴的工程师开发,致力于提供高性能和透明化的RPC远程服务调用.可惜的是该项目在2012年之后就没有再更新了,之后由当当基于dubbo开发了dubbox ...
- 001-ant design安装及快速入门【基于纯antd的基本项目搭建】
一.安装使用 1.1.安装 推荐使用 npm 或 yarn 的方式进行开发 npm install antd --save yarn add antd 1.2.浏览器引入 在浏览器中使用 script ...
- 教你从0到1搭建秒杀系统-Canal快速入门（番外篇）
Canal用途很广,并且上手非常简单,小伙伴们在平时完成公司的需求时,很有可能会用到.本篇介绍一下数据库中间件Canal的使用. 很多时候为了缩短调用延时,我们会对部分接口数据加入了缓存.一旦这些数据 ...
- 【机器学习-数据科学】第二节：ipython开发环境搭建以及pandas快速入门
ipython开发环境搭建以及pandas快速入门 0.开发环境搭建 技巧 网页版ipython:ipython notebook numpy 1.pandas 快速入门一 导入 创建对象 2. pa ...
- 【Vue 快速入门】从零开始搭建 VUE + Element UI后台管理系统框架
[Vue 快速入门]从零开始搭建 VUE + Element UI后台管理系统框架 前言 后台管理系统前端框架,现在很流行的形式都是,上方和左侧都是导航菜单,中间是具体的内容.比如阿里云.七牛云.头条 ...
- ELK系列(1) - Elasticsearch + Logstash + Kibana + Log4j2快速入门与搭建用例
前言 最近公司分了个ELK相关的任务给我,在一边学习一边工作之余,总结下这些天来的学习历程和踩坑记录. 首先介绍下使用ELK的项目背景:在项目的数据库里有个表用来存储消息队列的消费日志,这些日志用于开 ...
- springboot aop使用_Springboot 完整搭建快速入门，必看！
点击上方蓝字关注我们 作者:CansluckCSDN博客:https://blog.csdn.net/xgx120413 前言 手把手教你Springboot微服务项目搭建快速入门,通过本文学习Spr ...
- thinkcmf搭建教程_5分钟快速入门
# 5分钟快速入门 [TOC=1,5] ## 1.创建模板目录 在`public/themes/`目录下创建`quick_start`目录 ## 2.添加模板描述文件 在`public/themes/ ...
最新文章
- 独家 | 人工智能先锋人物杰夫·辛顿说：“深度学习将无所不能”
- 11.系统安全分析与设计
- Thrift的java和php数据交互
- 【深度学习入门到精通系列】nnU-Net论文解析
- Apiggs —— 非侵入性的 RestDoc 文档生成工具
- mysql 有索引 不被使用方法_MySQL教程100-索引在什么情况下不会被使用?
- 【连载】如何掌握openGauss数据库核心技术？秘诀五：拿捏数据库安全（1）
- python1加到100总和_从1加到一百总和是多少？有什么公式吗？
- 小波变换原理_基于电压行波原理故障测距的相关问题
- easyui 扩展tree 获取选中节点的级数
- Android开发-数据回传
- Java批量下载有道单词发音+与Anki卡片整合
- vue结合element 输入框输入纯数字以及限制输入小数
- makefile 目标：依赖文件写法
- html中如何使用正方形符号,正方形符号如何用MathType编辑
- 瑞吉外卖项目（一）软件开发流程设计及环境搭建
- XML 和 JSON 相互转换
- POE原理，千兆POE供电分离方案
- 每日新闻 | 特斯拉“太空跑车”完成第一圈绕日飞行 向火星靠近
- antdpro 中 使用 antd select 组件，defaultValue 与 value 使用问题