点击访问 官方地址(中文版)
XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
CommandJobHandler
);业务方只需要提供命令行即可HttpJobHandler
),业务方只需要提供HTTP链接即可,不限制语言、平台以 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-springboot
Springboot版本,通过Springboot管理执行器,推荐这种方式
调度数据库
官网下载项目源码并解压,获取 调度数据库初始化SQL脚本
执行即可,正常情况下应该生成8张表。
SQL脚本位置:/xxl-job/doc/db/tables_xxl_job.sql
⚠️注意⚠️
调度中心支持集群部署,集群情况下各节点务必连接同一个mysql实例;如果mysql做主从,调度中心集群节点务必强制走主库
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
调度中心配置文件地址:/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
[email protected]
[email protected]
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
[email protected]
[email protected]
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
如已经正确进行上述配置,可将项目编译打包部署。
调度中心访问地址:http://localhost:8080/xxl-job-admin
(该地址执行器将会使用到,作为回调地址)
账号/密码:admin/123456
登录后运行界面,如下图所示:
至此调度中心管理中心
已经部署成功了~~
调度中心支持集群部署,提升调度系统容灾和可用性。
调度中心集群部署时,几点要求和建议:
执行器负责接收“调度中心”的调度并执行;在源码中已经给出了多种执行器项目示例,可根据项目实际情况直接将其部署作为你自己的执行器,当然你也可以将执行器集成到现有业务项目中去。
xxl-job-core
的依赖<dependency>
<groupId>com.xuxueligroupId>
<artifactId>xxl-job-coreartifactId>
<version>2.3.0version>
dependency>
将源码中
/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-sample
address:
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip:
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 9999
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logpath: /data/applogs/xxl-job/jobhandler/
# 执行器日志保存天数 [选填] :值大于3时生效,启用执行器Log文件定期清理功能,否则不生效;
logretentiondays: -1
执行器组件配置信息位置
\xxl-job\xxl-job-executor-samples\xxl-job-executor-sample-springboot\src\main\java\com\xxl\job\executor\core\config\XxlJobConfig.java
找到这个 XxlJobConfig.java
复制一份到你的项目里即可
如果已经正确进行上述配置,可将执行器项目编译打部署,源码中执行器示例项目各自的部署方式如下:
xxl-job-executor-sample-springboot
项目编译打包成springboot类型的可执行JAR包,命令启动即可
至此执行器
项目已经部署结束~~
执行器支持集群部署,提升调度系统可用性,同时提升任务处理能力。
执行器集群部署时,几点要求和建议:
xxl.job.admin.addresses
)需要保持一致;执行器根据该配置进行执行器自动注册等操作xxl.job.executor.appname
)需要保持一致;调度中心根据该配置动态发现不同集群的在线执行器列表代码示例:
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();
}
}
}
登录调度中心,点击下图所示 新建任务
按钮,新建示例任务;然后,参考下面截图中任务的参数配置,点击保存
页面中的 JobHandler
属性要与自己任务 @XxlJob("demoJobHandler")
的value
值保持一致
设置完成之后,点击保存
点击此任务右侧操作
,选择将任务启动