1. XXL-JOB简介
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。它的有两个核心模块,一个模块叫做调度中心,另外一个模块叫做执行器,它把任务调度和任务执行分成两个部分。这样调度模块只需要负责任务的调度属性,触发调度信号。执行模块只需要接收调度信号,去执行具体的业务逻辑,两者可以各自的进行扩容和缩容。下图是一张来自官方的架构图。
2. XXL-JOB搭建
我们使用xxl-job搭建一个demo,主要包括以下几个步骤,初始化调度中心数据库、搭建“调度中心”、搭建“执行器”。
2.1 初始化数据
2.1.1 下载源码
源码地址:github.com/xuxueli/xxl-job
我使用的源码是2.2.0版本,源码包含了文档(数据库初始化脚本、官方文档、架构图等)、调度中心源码、核心core、各个版本的执行器源码。如图所示:
2.1.2 初始化数据库
找到上图所示的数据库初始化脚本,执行脚本
2.2 搭建调度中心
2.2.1 配置调度中心
修改xxl-job-admin下的配置文件
配置文件如下,按实际需求进行调整
### web
server.port=8080
server.servlet.context-path=/xxl-job-admin
### actuator
management.server.servlet=/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
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
配置文件可参考:XXL-JOB分布式任务调度平台配置详解_xxl.job.executor.address-优快云博客
2.2.2 启动调度中心
在idea直接运行XxlJobAdminApplication,如果使用的是macOS系统的话,可能会出现错误:Failed to create parent directories for [/data/applogs/xxl-job/xxl-job-admin.log],如图所示:
解决办法是:将logback.xml中的“/data/applogs/xxl-job/xxl-job-admin.log”改为“./data/applogs/xxl-job/xxl-job-admin.log”,如图所示。后续在测试运行的时候,执行器端会抛出类似异常,用同样的方式可以解决。
调度中心访问地址:http://localhost:8080/xxl-job-admin
(该地址执行器将会使用到,作为回调地址)
账号/密码:admin/123456
登录后运行界面,如下图所示:
2.3 搭建“执行器”
2.3.1 项目里引入xxl-job-core
的依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.2.0</version>
</dependency>
2.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-sample
address:
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip:
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 9999
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logpath: /data/applogs/xxl-job/jobhandler/
# 执行器日志保存天数 [选填] :值大于3时生效,启用执行器Log文件定期清理功能,否则不生效;
logretentiondays: -1
2.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 复制一份到自己的项目中
2.3.4 项目中新建调度任务
代码示例:
/**
* 定时任务
*/
@Component
public class EntranceJobHandler {
/**
* xxl-job测试
*/
@XxlJob("testDemo")
public ReturnT<String> test(String s) {
System.out.println("test");
return ReturnT.SUCCESS;
}
}
2.3.4 调度中心新建任务
配置完成之后 可在任务管理找到新增的任务,点击执行一次测试或者直接启动就行
可以看到后台的执行结果: