官方文档:
- [中文文档](https://www.xuxueli.com/xxl-job/)
- [English Documentation](https://www.xuxueli.com/xxl-job/en/)
源码:
[https://github.com/xuxueli/xxl-job](https://github.com/xuxueli/xxl-job) | [Download](https://github.com/xuxueli/xxl-job/releases)
[http://gitee.com/xuxueli0323/xxl-job](http://gitee.com/xuxueli0323/xxl-job) | [Download](http://gitee.com/xuxueli0323/xxl-job/releases)
关于调度中心和执行器的架构图
xxl-job主要是分为两个部分,调度中心主要是进行定时作业的配置,执行器则是各个业务系统执行定时作业的具体逻辑。
关于调度中心:
调度中心这块比较简单,直接拉源码中admin模块作为一个项目运行,调度中心就完成了,需要修改的配置如下:
第一步:初始化数据库,把源码中/xxl-job/doc/db/tables_xxl_job.sql 的sql脚本运行,数据库就初始化完成了。
第二步:修改配置文件
### 调度中心JDBC链接:初始化数据地址
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.jdbc.Driver
### 报警邮箱 (不需要可以不配置)
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.password=xxx
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
### 调度中心通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### 调度中心国际化配置 [必填]: 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文;
xxl.job.i18n=zh_CN
## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### 调度中心日志表数据保存天数 [必填]:过期日志自动清理;限制大于等于7时生效,否则, 如-1,关闭自动清理功能;
xxl.job.logretentiondays=30
第三步,启动项目,调度中心完成,调度中心访问地址:http://localhost:8080/xxl-job-admin ,默认登录账号 “admin/123456”
关于执行器(笔者用的项目是基于springboot的,以下只是一个简单的demo):
目前,笔者用的是spring容器方式自动扫描任务并注入执行器,主要是文档中提到的3.2 BEAN模式(方法形式)这种模式去构建执行器,这里有个坑是2.0.0及以下版本好像不支持@XxlJob注解。笔者再搭建执行器主要用到的版本是2.3.0。
第一步:引入maven依赖
第二步:执行器的相关配置修改
### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用,与上边的调度中心保持一致
xxl.job.accessToken=
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”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
第三步:添加XxlJobConfig.java,初始化xxl-job配置。初始化参数与上边的properties参数一一对应,用不到的可以自行去掉。
@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;
}
第四步:执行器任务编码
通过@Component把javabean注入到spring容器中,然后@XxlJob("调度任务handler名称"),调度中心新增定时任务时候会根据对应的handler执行对应的定时任务。
第五步:项目打包并运行,执行器到此完成。
如何使用调度任务:
第一步:新增执行器,AppName与执行器配置属性xxl.job.executor.appname对应,主要是用于分组管理以及自动注册,名称随意写。appname不为空,执行器会自动注册,如果为空则需手动录入执行器机器ip。
第二步,新增调度任务,其中JobHandler名称与执行器编码过程中的命名一致,调度中心才能执行到对应的定时任务。配置完以上信息后,启动定时任务。至此,调度中心以及执行器就搭建完成。