解决定时任务在多台服务器上重复执行的问题可以采取以下方法:
- 1. 使用分布式锁:在任务执行前获取分布式锁,执行完毕后释放锁。这样只有一个服务器可以获取到锁并执行任务,其他服务器在获取锁时会被阻塞。
- 2. 使用数据库或缓存:在执行任务前,先在数据库或缓存中记录任务执行的状态,当一个服务器开始执行任务时,将任务状态设置为“进行中”,其他服务器在执行任务之前先查询任务状态,如果任务状态为“进行中”,则放弃任务执行。
- 3. 使用分布式任务调度框架:如Quartz、XXL-JOB、Elastic Job等。这些框架提供了分布式任务调度的能力,可以保证同一任务在多台服务器上只执行一次。这些框架通常基于分布式锁或者数据库实现任务的协调和调度。
- 4. 使用消息队列:将任务放入消息队列中,每个服务器从队列中获取任务执行。消息队列可以保证任务只被消费一次,确保多台服务器上的任务不会重复执行。
以上方法可以根据实际情况选择使用,不同方法适用于不同的场景和需求。
(1)首先添加依赖
org.springframework.boot
spring-boot-starter-data-redis
(2)配置redis的信息
(3)业务代码实现
@Autowired
private RedisTemplate redisTemplate;
/** 定时任务的名称作为key **/
String key = "QuartzJob";
/** 设置随机key **/
String value = UUID.randomUUID().toString().replace("-", "");
//如果键不存在则新增,存在则不改变已经有的值。(备注:失效时间要大于多台服务器之间的时间差,如果多台服务器时间差大于超时时间,定时任务可能会执行多次)
Boolean flag = redisTemplate.opsForValue().setIfAbsent(key, value, 20, TimeUnit.SECONDS);
if (flag != null && flag) {
log.info("{} 锁定成功,开始处理业务", key);
/** 此处填写业务逻辑 **/
/*
* 业务逻辑处理完毕,释放锁,正常情况下,由于上边 setIfAbsent 已经设置过期时间了,
* 所以在规定时间内,Redis 会自动删除过期的 key,但是这个删除由于不确实是什么删除策略,
* 所以最后执行完再删除一遍比较保险。
*/
String lockValue = (String) redisTemplate.opsForValue().get(key);
/** 只有:值未被释放(也就是当前未达到过期时间),且是自己加锁设置的值(不要释放别人的所),这种情况下才会释放锁 **/
if (lockValue != null && lockValue.equals(value)) {
redisTemplate.delete(key);
log.info("{} 解锁成功,结束处理业务", key);
}
} else {
log.info("{} 获取锁失败", key);
}
(1)在配置文件中配置开关,spring会通过类上的注解判断是否加载该实例,如果不加载,就不会执行定时任务
(2)在业务代码类上定义注解
havingValue中的内容与配置类中相同则执行,否则不执行。
Quartz
- 优点:部署支持集群
- 缺点:没有自带的管理界面;调度逻辑和执行任务耦合在一起;维护需要重启服务
xxl-job
- 优点:支持集群部署;提供运维界面维护成本小;自带错误预警;相对elastic-job来说不需要额外的组件(zookeeper);支持调度策略;支持分片; 故障转移 ;更适合分布式
- 缺点:相对Quartz来说需要多部署调度中心
elastic-job
- 优点:支持集群部署;维护成本小
- 缺点:elastic-job需要zookeeper,zookeeper集群高可用至少需要三台服务器
分布式任务调度任务框架老大哥:Quartz
使用起来也比较麻烦,不尽人意,个人总结其使用缺点如下:
Quzrtz
并没有内置 UI 管理控制台,导致任务动态管理不够友好Quartz
的表放到单独库还是和业务库都不好,放在单独库,那么业务服务就是多数据源,需要视频,放在业务库会导致数据库繁琐,耦合。XXL-JOB
弥补了quartz的上述不足之处。XXL-JOB
是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展
将调度行为抽象形成“调度中心”公共平台,而平台自身并不承担业务逻辑,“调度中心”负责发起调度请求。将任务抽象成分散的JobHandler,交由“执行器”统一管理,“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。因此,“调度”和“任务”两部分可以相互解耦,提高系统整体稳定性和扩展性;
调度模块(调度中心): 负责管理调度信息,按照调度配置发出调度请求,自身不承担业务代码。调度系统与任务解耦,提高了系统可用性和稳定性,同时调度系统性能不再受限于任务模块; 支持可视化、简单且动态的管理调度信息,包括任务新建,更新,删除,GLUE开发和任务报警等,所有上述操作都会实时生效,同时支持监控调度结果以及执行日志,支持执行器Failover。
执行模块(执行器): 负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作,开发和维护更加简单和高效;接收“调度中心”的执行请求、终止请求和日志请求等。
XXL-JOB
主要分为调度中心和执行器。一般来说,XXL-JOB 执行器可以内嵌到应用服务里。例如说,一个提供 Restful API 的 Spring Boot 项目中,引入 xxl-job-core
依赖,同时也作为一个 XXL-JOB 执行器。本质上,每次 Restful API 是请求任务,而每次任务调度是定时任务。所在接下来我们需要先部署调度中心服务。
(1)调度中心服务部署
使用下载源码启动xxl-job-admin
调度中心服务,测试的话,源码gitee上面找一个就可以
(2)执行器服务部署
XXL-JOB 执行器可以内嵌到应用服务里。
com.xuxueli
xxl-job-core
2.3.0
引入 XxlJobConfig 配置类
package com.plasticene.shorturl.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;
/**
* @author fjzheng
* @version 1.0
* @date 2022/9/5 14:13
*/
@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;
}
}
接下来修改业务服务的配置文件
xxl:
job:
admin:
# 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。
# 执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
addresses: http://127.0.0.1:8080/xxl-job-admin
# 执行器通讯TOKEN [选填]:非空时启用;
accessToken:
executor:
# 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
appname: short-url-job
# 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。
#从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
address:
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;
# 地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";如果你本地开启,这里ip最好填写一下
ip: 10.8.6.235
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 6066
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logpath: /Users/shepherdmy/Desktop/logs/xxl-job/jobhandler
# 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
logretentiondays: 30
编写JOB
任务测试类
package com.plasticene.shorturl.task;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
/**
* @author fjzheng
* @version 1.0
* @date 2022/9/5 14:23
*/
@Component
public class SampleXxlJob {
private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
private final AtomicInteger counts = new AtomicInteger();
/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");
// 打印日志
logger.info("[execute][定时第 ({}) 次执行]", counts.incrementAndGet());
}
}
启动业务服务,至此执行器部署成功了。
(3)调度中心管理界面配置执行器和任务
首先,在调度中心配置新增执行器,AppName
需要配置成和执行器业务服务配置的一样,AppName
: 是每个执行器集群的唯一标示 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
这里根据自动注册获取到执行器服务机器地址,如果集群部署了多个执行器业务服务,这里会有多个地址,供后续执行任务选择负载均衡。
接下来就是在执行器下面创建任务JOB
了,XXL-JOB
支持创建很多种任务类型,如“Bean模式” 任务、“GLUE模式(Java)” 任务、GLUE模式(Shell) + GLUE模式(Python) + GLUE模式(PHP) + GLUE模式(NodeJS) + GLUE模式(Powershell),这里我演示Bean模式和GLUE模式(Java),其他模式自行查看官网
Bean模式
每个任务只需要开发一个方法,并添加@XxlJob
注解即可
@Component
public class SampleXxlJob {
private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
private final AtomicInteger counts = new AtomicInteger();
/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");
// 打印日志
logger.info("[execute][定时第 ({}) 次执行]", counts.incrementAndGet());
}
}
GLUE模式(Java)
任务以源码方式维护在调度中心,支持通过Web IDE在线更新,实时编译和生效,原理:每个 “GLUE模式(Java)” 任务的代码,实际上是“一个继承自“IJobHandler”的实现类的类代码”,“执行器”接收到“调度中心”的调度请求时,会通过Groovy类加载器加载此代码,实例化成Java对象,同时注入此代码中声明的Spring服务(请确保Glue代码中的服务和类引用在“执行器”项目中存在),然后调用该对象的execute方法,执行任务逻辑。它在执行器项目中运行,可使用@Resource/@Autowire注入执行器里中的其他服务。
以上两个模式的任务配置如下
这时候只要我们启动执行器业务服务,通过操作
按钮可以执行一次任务、启动任务、停止任务等等