分布式任务调度平台XXL-JOB
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。
1. 文档地址
2. 源码仓库地址:
3. 环境配置
需要的配置版本要求:
Maven3+
Jdk1.8+
Mysql5.7+(5.7以下会出现某些字段太短的情况-报异常)
初始化数据库
下载号项目之后,找到数据库脚本并执行:/xxl-job/doc/db/tables_xxl_job.sql
这里我新建的数据库名称为:xxl-job-dy,创建的数据库如下图所示:
4. 配置部署“调度中心”
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
调度中心配置文件地址:
/xxl-job/xxl-job-admin/src/main/resources/application.properties
此处我选择的版本是2.2.0,注意端口号,更改自己创建的数据库。
调度中心配置内容说明:
### 调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
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.username=xxx@qq.com
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:9080/xxl-job-admin/toLogin
登录名:admin
密码:123456
至此“调度中心”项目已经部署成功。
5. 配置部署“执行器项目”
“执行器”项目:xxl-job-executor-sample-springboot (提供多种版本执行器供选择,现以 springboot 版本为例,可直接使用,也可以参考其并将现有项目改造成执行器)
作用:负责接收“调度中心”的调度并执行;可直接部署执行器,也可以将执行器集成到现有业务项目中。
5.1 maven依赖
确认pom文件中引入了 “xxl-job-core” 的maven依赖;
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.2.0</version>
</dependency>
5.2 执行器配置
配置项目目录下的application.yml文件:
xxl:
job:
admin:
# 9080 调度中心配置的端口号
addresses: http://127.0.0.1:9080/xxl-job-admin
executor:
# 执行器AppName
appname: xxl-job-executor-sample
address:
ip:
# 执行器端口号
port: 9999
# 执行器运行日志文件存储磁盘路径
logpath: /data/applogs/xxl-job/jobhandler
# 执行器日志文件保存天数
logretentiondays: 30
# 执行器通讯TOKEN
accessToken:
注意AccessToken的设置,此处采用设置一,调度中心和执行器均不设置AccessToken,即关闭安全性校验。
官网参数说明
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
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
5.3 执行器组件配置
package com.yupi.usercenter.config;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* xxl-job config
*
* @author liudy23 2022-11-09
*/
@Configuration
public class XxlJobConfig {
private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.appname}")
private String appname;
@Value("${xxl.job.executor.address}")
private String address;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
logger.info(">>>>>>>>>>> xxl-job config init.");
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appname);
xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
/**
* 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
*
* 1、引入依赖:
* <dependency>
* <groupId>org.springframework.cloud</groupId>
* <artifactId>spring-cloud-commons</artifactId>
* <version>${version}</version>
* </dependency>
*
* 2、配置文件,或者容器启动变量
* spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
*
* 3、获取IP
* String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
*/
}
5.4 部署执行器项目
package com.yupi.usercenter.handler;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import org.apache.commons.lang3.time.DateFormatUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.util.Date;
/**
* @author : liudy23
* @date : 2022/11/9
*/
@Component
public class XxlJobHandler {
private static Logger logger = LoggerFactory.getLogger(XxlJobHandler.class);
private String PATTERN = "yyyy-MM-dd HH:mm:ss";
/**
* 简单的任务示例
*/
@XxlJob("testHandlerDemo")
public ReturnT<String> xxlJobHandler(String name) {
XxlJobLogger.log("XXL-JOB, Learning!");
System.out.println("====" + DateFormatUtils.format(new Date(),PATTERN) + " 阳光明媚,风和日丽!");
// todo 通知逻辑,以什么形势通知目标人
return ReturnT.SUCCESS;
}
}
启动项目即可,出现如下信息**xxl-job register jobhandler success, name:testHandlerDemo,**说明xxl-job注册成功。
![启动项目
6.部署任务
部署任务的前提:确认“调度中心”和“执行器”项目已经成功部署并启动
6.1 新建任务
登录调度中心,进入任务管理,点击新增:
6.2 编辑执行器
执行器管理,对Online机器地址进行配置
6.3 测试任务执行
点击任务管理,操作,执行一次进行测试:
查看调度日志:显示成功说明调度成功!
6.4 启动任务
进入任务管理——操作——启动,状态显示为RUNNING,启动成功!
查看后台打印日志,每3秒执行一次
至此,常规的XXL-JOB分布式任务调度平台部署成功!