入门介绍
XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。整个产品开箱即用,非常方便,而且优势也是非常明显的。
产品优势(这也是我使用感觉的最大优势)
1.XXL-JOB支持Web页面操作并且可以对任务进行CRUD非常方便。
2.XXL-JOB支持动态修改任务状态、启动、运行、停止以及终止运行中任务,即时生效。
3.支持注册中心集中式部署: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行,也支持手动录入执行器地址,配置相关操作。
4.弹性扩容缩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务
5.支持任务失败告警,默认提供邮件方式失败告警,同时预留扩展接口,可方便用其他方式告示。
6.事件触发:除了"Cron方式"和"任务依赖方式"触发任务执行之外,支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务,可根据业务事件灵活触发。
7.XXL-JOB还是全异步模式:如异步调度、异步运行、异步回调等,更加有效的对调度密集的任务进行流量削峰,理论上支持任意时长任务的运行。
还有更多优势详见XXL-JOB任务调度详解
下面我们就来介绍使用方法
简单使用
1.导入maven依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.2.0</version>
</dependency>
2.增加config配置文件
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.java.Log;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Log
@Configuration
public class XxlJobConfig {
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.executor.appname}")
private String appName;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
log.info(">>>>> xxl-job config 开始执行 <<<<<");
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;
}
}
3.配置properties配置文件
#任务调度
// 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。
xxl.job.admin.addresses=
// 执行器通讯TOKEN [选填]:非空时启用
xxl.job.accessToken=
// 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=
// 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址
xxl.job.executor.address=
// 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用
xxl.job.executor.ip=
// 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口
xxl.job.executor.port=
// 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=
// 执行器日志文件保存天数[选填]:过期日志自动清理, 限制值大于等于3时生效
xxl.job.executor.logretentiondays=
4.通过注解方式写定时任务创建JobHandler
@XxlJob(value = "这里是你页面新增JobHandler的名称要一致")
public ReturnT<String> jobexecute(String xxx) {
log.info("XXL-JOB Hello World ");
return ReturnT.SUCCESS;
}
5.在调度中心界面上配置执行器
首先登录任务调度中心,然后新增执行器
6.然后配置定时任务