SpringBoot怎麼整合ShedLock實現分散式定時任務

一、背景

在專案服務是叢集部署的時候，程式碼在每個人都會有定時任務，但是如果讓每個節點都去跑定時任務是不不合適的。 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.#n .jdbc.Driver
    type: com.mysql.cj.jdbc.MysqlDataSource

1.3 建立Mysql資料表

CREATE TABLE `shedlock` (
	`name`  varchar(64) NOT NULL COMMENT 'name' ,
	`lock_until`  timestamp(3) NULL DEFAULT NULL ,
	`locked_at`  timestamp(3) NULL DEFAULT NULL ,
	`locked_by`  varchar(255) NULL DEFAULT NULL ,
	PRIMARY KEY (`name`)
)
ENGINE=InnoDB
DEFAULT CHARACTER SET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
ROW_FORMAT=DYNAMIC
;

1.4 設定LockProvider

##ShedLock#

import net.javacrumbs.shedlock.core.LockProvider;
import net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import javax.sql.DataSource;
/**
 * @description: Shedlock集成Jdbc配置类
 */
@Component
public class ShedLockConfig {
    @Resource
    private DataSource dataSource;
    @Bean
    private LockProvider lockProvider() {
        return new JdbcTemplateLockProvider(dataSource);
    }
}

1.4 設定LockProvider

##ShedLock#

import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;
import org.mybatis.spring.annotation.MapperScan;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
/**
 * @version 1.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})
public class MerakQuartzApplication {
    public static final Logger log = LoggerFactory.getLogger(MerakQuartzApplication.class);
    public static void main(String[] args) {
        SpringApplication.run(MerakQuartzApplication.class, args);
    }
    private int taskSchedulerCorePoolSize = 15;
    private int awaitTerminationSeconds = 60;
    private String threadNamePrefix = "taskExecutor-";
    /**
     * @description: 实例化ThreadPoolTaskScheduler对象，用于创建ScheduledFuture<?> scheduledFuture
     */
    @Bean
    public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
        taskScheduler.setPoolSize(taskSchedulerCorePoolSize);
        taskScheduler.setThreadNamePrefix(threadNamePrefix);
        taskScheduler.setWaitForTasksToCompleteOnShutdown(false);
        taskScheduler.setAwaitTerminationSeconds(awaitTerminationSeconds);
        /**需要实例化线程*/
        taskScheduler.initialize();
//        isinitialized = true;
        log.info("初始化ThreadPoolTaskScheduler ThreadNamePrefix=" + threadNamePrefix + ",PoolSize=" + taskSchedulerCorePoolSize
                + ",awaitTerminationSeconds=" + awaitTerminationSeconds);
        return taskScheduler;
    }
    /**
     * @description: 实例化ThreadPoolTaskExecutor对象，管理线程
     */
    @Bean("asyncTaskExecutor")
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        taskExecutor.setCorePoolSize(5);
        taskExecutor.setMaxPoolSize(50);
        taskExecutor.setQueueCapacity(200);
        taskExecutor.setKeepAliveSeconds(60);
        taskExecutor.setThreadNamePrefix("asyncTaskExecutor-");
        taskExecutor.setWaitForTasksToCompleteOnShutdown(true);
        taskExecutor.setAwaitTerminationSeconds(60);
        //修改拒绝策略为使用当前线程执行
        taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        //初始化线程池
        taskExecutor.initialize();
        return taskExecutor;
    }
}

. java:

package com.merak.hyper.automation.quartz.task;
import net.javacrumbs.shedlock.spring.annotation.SchedulerLock;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.util.List;
/**
 * @version 1.0
 * @ClassName: BizOrderTask
 * @description: 任务队列服务调度
 */
@Component
public class DigitalEmpTask {
    public static final Logger log = LoggerFactory.getLogger(DigitalEmpTask.class);
    @Scheduled(cron = "0/30 * * * * ?")
    @SchedulerLock(name = "digitalEmpTaskScheduler", lockAtMostFor = "PT25S", lockAtLeastFor = "PT25S")
    protected void digitalEmpTaskScheduler() {
        log.info("云执行调度中心1:任务开始执行,时间:" + DateUtils.dateTimeNow(DateUtils.YYYY_MM_DD_HH_MM_SS));
        try { 
        } catch (Exception e) {
            log.error("云执行调度中心1调度失败，原因：" + e.getMessage());
        }  
    }
}

springboot主啟動類別MerakQuartzApplication：

rrreee

1.5 建立定時Job

DigitalEmpTask：

rrreee

四、結果分析

#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  <46>
<46>
<46>
<46>

<46>
<46>
<46>
<46>
<46>
<46>
<46><46><46>
<46>
<46>
<46>
<46>
<46>

<46>
<46>
<

<46><46>
<46>
<46><46>
<46>
<46>
<46>
<46>
<46>
<46>
<46>
<46>
<46><46>
<46>

以上是SpringBoot怎麼整合ShedLock實現分散式定時任務的詳細內容。更多資訊請關注PHP中文網其他相關文章！