SpringBoot怎么集成ShedLock实现分布式定时任务(shedlock,springboot,开发技术)

一、背景

在项目服务是集群部署的时候，代码在每个人都会有定时任务，但是如果让每个节点都去跑定时任务是不大合适的。SpringBoot 中的 ShedLock 可以很好解决这个问题，下面我将为大家详细介绍 SpringBoot 如何集成 ShedLock，而 ShedLock 又是如何实现分布式定时的。

二、ShedLock是什么

以下是ShedLock锁提供者，通过外部存储实现锁，由下图可知外部存储集成的库还是很丰富:

三、落地实现

1.1 引入依赖包

shedlock所需依赖包：

<!--web工程依赖包--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>net.javacrumbs.shedlock</groupId><artifactId>shedlock-spring</artifactId><version>4.2.0</version></dependency><!--每个外部存储实例所需依赖包不一样，这里是jdbc--><dependency><groupId>net.javacrumbs.shedlock</groupId><artifactId>shedlock-provider-jdbc-template</artifactId><version>4.2.0</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-jdbc</artifactId></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope></dependency>

依赖包树形图：

1.2 配置数据库连接信息

server:
port: 8105
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/testjdbc?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.mysql.cj.jdbc.MysqlDataSource

1.3 创建Mysql数据表

CREATETABLE`shedlock`( `name`varchar(64)NOTNULLCOMMENT'name', `lock_until`timestamp(3)NULLDEFAULTNULL, `locked_at`timestamp(3)NULLDEFAULTNULL, `locked_by`varchar(255)NULLDEFAULTNULL, PRIMARYKEY(`name`))ENGINE=InnoDBDEFAULTCHARACTERSET=utf8mb4COLLATE=utf8mb4_0900_ai_ciROW_FORMAT=DYNAMIC;

1.4 配置LockProvider

ShedLockConfig.java:

importnet.javacrumbs.shedlock.core.LockProvider;importnet.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;importorg.springframework.context.annotation.Bean;importorg.springframework.stereotype.Component;importjavax.annotation.Resource;importjavax.sql.DataSource;/***@description:Shedlock集成Jdbc配置类*/@ComponentpublicclassShedLockConfig{@ResourceprivateDataSourcedataSource;@BeanprivateLockProviderlockProvider(){returnnewJdbcTemplateLockProvider(dataSource);}}

springboot主启动类MerakQuartzApplication：

importnet.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;importorg.mybatis.spring.annotation.MapperScan;importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;importorg.springframework.context.annotation.Bean;importorg.springframework.scheduling.annotation.EnableAsync;importorg.springframework.scheduling.annotation.EnableScheduling;importorg.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;importorg.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;importjava.util.concurrent.Executor;importjava.util.concurrent.ThreadPoolExecutor;/***@version1.0*@ClassName:MerakQuartzApplication*@description:工单任务调度*///开启定时器@EnableScheduling//开启定时任务锁，指定一个默认的锁的时间30秒@EnableSchedulerLock(defaultLockAtMostFor="PT30S")@EnableAsync@MapperScan(basePackages={"com.merak.hyper.automation.persist.**.mapper"})@SpringBootApplication(scanBasePackages={"com.merak.hyper.automation.**"},exclude={SecurityAutoConfiguration.class})publicclassMerakQuartzApplication{publicstaticfinalLoggerlog=LoggerFactory.getLogger(MerakQuartzApplication.class);publicstaticvoidmain(String[]args){SpringApplication.run(MerakQuartzApplication.class,args);}privateinttaskSchedulerCorePoolSize=15;privateintawaitTerminationSeconds=60;privateStringthreadNamePrefix="taskExecutor-";/***@description:实例化ThreadPoolTaskScheduler对象，用于创建ScheduledFuture<?>scheduledFuture*/@BeanpublicThreadPoolTaskSchedulerthreadPoolTaskScheduler(){ThreadPoolTaskSchedulertaskScheduler=newThreadPoolTaskScheduler();taskScheduler.setPoolSize(taskSchedulerCorePoolSize);taskScheduler.setThreadNamePrefix(threadNamePrefix);taskScheduler.setWaitForTasksToCompleteOnShutdown(false);taskScheduler.setAwaitTerminationSeconds(awaitTerminationSeconds);/**需要实例化线程*/taskScheduler.initialize();//isinitialized=true;log.info("初始化ThreadPoolTaskSchedulerThreadNamePrefix="+threadNamePrefix+",PoolSize="+taskSchedulerCorePoolSize+",awaitTerminationSeconds="+awaitTerminationSeconds);returntaskScheduler;}/***@description:实例化ThreadPoolTaskExecutor对象，管理线程*/@Bean("asyncTaskExecutor")publicExecutortaskExecutor(){ThreadPoolTaskExecutortaskExecutor=newThreadPoolTaskExecutor();taskExecutor.setCorePoolSize(5);taskExecutor.setMaxPoolSize(50);taskExecutor.setQueueCapacity(200);taskExecutor.setKeepAliveSeconds(60);taskExecutor.setThreadNamePrefix("asyncTaskExecutor-");taskExecutor.setWaitForTasksToCompleteOnShutdown(true);taskExecutor.setAwaitTerminationSeconds(60);//修改拒绝策略为使用当前线程执行taskExecutor.setRejectedExecutionHandler(newThreadPoolExecutor.CallerRunsPolicy());//初始化线程池taskExecutor.initialize();returntaskExecutor;}}

1.5 创建定时Job

DigitalEmpTask：

packagecom.merak.hyper.automation.quartz.task;importnet.javacrumbs.shedlock.spring.annotation.SchedulerLock;importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.scheduling.annotation.Scheduled;importorg.springframework.stereotype.Component;importjava.util.List;/***@version1.0*@ClassName:BizOrderTask*@description:任务队列服务调度*/@ComponentpublicclassDigitalEmpTask{publicstaticfinalLoggerlog=LoggerFactory.getLogger(DigitalEmpTask.class);@Scheduled(cron="0/30****?")@SchedulerLock(name="digitalEmpTaskScheduler",lockAtMostFor="PT25S",lockAtLeastFor="PT25S")protectedvoiddigitalEmpTaskScheduler(){log.info("云执行调度中心1:任务开始执行,时间:"+DateUtils.dateTimeNow(DateUtils.YYYY_MM_DD_HH_MM_SS));try{}catch(Exceptione){log.error("云执行调度中心1调度失败，原因："+e.getMessage());}}}

四、结果分析

1.分别启动两个服务节点，配置如下：

server:
port: 12105
servlet:
context-path: /automation-quartz-one

server:
port: 12106
servlet:
context-path: /automation-quartz-two

2.运行日志(片断）

节点automation-quartz-one 运行日志：
2023-02-22 12:01:00.143 [taskExecutor-1] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:01:00
2023-02-22 12:05:00.114 [taskExecutor-3] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:05:00
2023-02-22 12:05:30.122 [taskExecutor-6] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:05:30
2023-02-22 12:19:30.110 [taskExecutor-3] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:19:30

节点automation-quartz-two运行日志：
2023-02-22 12:01:30.109 [taskExecutor-3] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:01:30
2023-02-22 12:02:00.101 [taskExecutor-1] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:02:00
2023-02-22 12:02:30.105 [taskExecutor-2] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:02:30
2023-02-22 12:03:00.118 [taskExecutor-3] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:03:00
2023-02-22 12:03:30.101 [taskExecutor-4] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:03:30
2023-02-22 12:04:00.110 [taskExecutor-1] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:04:00
2023-02-22 12:04:30.111 [taskExecutor-5] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:04:30
2023-02-22 12:06:00.114 [taskExecutor-13] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:06:00
2023-02-22 12:06:30.108 [taskExecutor-14] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:06:30
2023-02-22 12:07:00.114 [taskExecutor-15] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:07:00
2023-02-22 12:07:30.115 [taskExecutor-1] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:07:30
2023-02-22 12:08:00.102 [taskExecutor-5] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:08:00
2023-02-22 12:08:30.103 [taskExecutor-11] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:08:30
2023-02-22 12:09:00.099 [taskExecutor-6] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:09:00
2023-02-22 12:09:30.113 [taskExecutor-3] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:09:30
2023-02-22 12:10:00.107 [taskExecutor-7] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:10:00
2023-02-22 12:10:30.110 [taskExecutor-15] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:10:30
2023-02-22 12:11:00.111 [taskExecutor-1] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:11:00
2023-02-22 12:11:30.100 [taskExecutor-5] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:11:30
2023-02-22 12:12:00.112 [taskExecutor-11] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:12:00
2023-02-22 12:12:30.102 [taskExecutor-6] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:12:30
2023-02-22 12:13:00.097 [taskExecutor-3] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:13:00
2023-02-22 12:13:30.107 [taskExecutor-14] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:13:30
2023-02-22 12:14:00.111 [taskExecutor-4] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:14:00
2023-02-22 12:14:30.106 [taskExecutor-8] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:14:30
2023-02-22 12:15:00.095 [taskExecutor-9] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:15:00
2023-02-22 12:15:30.101 [taskExecutor-10] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:15:30
2023-02-22 12:16:00.105 [taskExecutor-2] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:16:00
2023-02-22 12:16:30.130 [taskExecutor-12] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:16:30
2023-02-22 12:17:00.107 [taskExecutor-13] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:17:00
2023-02-22 12:17:30.113 [taskExecutor-7] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:17:30
2023-02-22 12:18:00.104 [taskExecutor-15] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:18:00
2023-02-22 12:18:30.112 [taskExecutor-1] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:18:30
2023-02-22 12:19:00.103 [taskExecutor-5] INFO <DigitalEmpTask:46> - 云执行调度中心1:任务开始执行,时间:2023-02-22 12:19:00

3、shedlock表记录信息：