Spring Boot集成ShedLock分佈式定時任務的實現示例

<dependency>
    <groupId>net.javacrumbs.shedlock</groupId>
    <artifactId>shedlock-spring</artifactId>
    <version>4.23.0</version>
</dependency>
 <!--每個外部存儲實例所需依賴包不一樣，這裡是jdbc-->
<dependency>
    <groupId>net.javacrumbs.shedlock</groupId>
    <artifactId>shedlock-provider-jdbc-template</artifactId>
    <version>4.23.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>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

server:
  port: 9999
spring:
  datasource:
    url: jdbc:mysql://192.168.31.158: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

# MySQL, MariaDB
CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until TIMESTAMP(3) NOT NULL,
    locked_at TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3), locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

# Postgres
CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until TIMESTAMP NOT NULL,
    locked_at TIMESTAMP NOT NULL, locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

# Oracle
CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until TIMESTAMP(3) NOT NULL,
    locked_at TIMESTAMP(3) NOT NULL, locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

# MS SQL
CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until datetime2 NOT NULL,
    locked_at datetime2 NOT NULL, locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

# DB2
CREATE TABLE shedlock(name VARCHAR(64) NOT NULL PRIMARY KEY, lock_until TIMESTAMP NOT NULL,
    locked_at TIMESTAMP NOT NULL, locked_by VARCHAR(255) NOT NULL);

/**
 * @description: Shedlock集成Jdbc配置類
 * @author: DT
 * @date: 2021/5/22 0:07
 * @version: v1.0
 */
// 標識該類為配置類
@Configuration
// //開啟定時器
@EnableScheduling
// 開啟定時任務鎖，指定一個默認的鎖的時間30秒
@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")
public class ShedlockJdbcConfig {

    /**
     * 配置鎖的提供者
     */
    @Bean
    public LockProvider lockProvider(DataSource dataSource) {
        return new JdbcTemplateLockProvider(
                JdbcTemplateLockProvider.Configuration.builder()
                        .withJdbcTemplate(new JdbcTemplate(dataSource))
                        .usingDbTime()
                        .build()
        );
    }
}

/**
 * @description: 開啟分佈式鎖定時任務
 * @author: DT
 * @date: 2021/5/22 0:23
 * @version: v1.0
 */
@Component
@CommonsLog
public class TimeTaskJob {

    private static Integer count = 1;

    // @SchedulerLock的作用是保證當前定時任務的方法執行時獲得鎖，忽略其他相同任務的執行
    // name必須要指定，ShedLock就是根據這個name進行相同任務判定的
    // name：定時任務的名字，就是數據庫中的主鍵(name)
    // lockAtMostFor：鎖的最大時間單位為毫秒
    // lockAtLeastFor：鎖的最小時間單位為毫秒

    /**
     * 任務1每5秒執行一次
     * lockAtLeastFor：雖然,定時任務是每隔5秒執行一次,但是,分佈式鎖定義的是:每次任務要鎖住20秒，20秒是持有鎖的最小時間，必須等20秒後才釋放鎖，並且確保在20秒鐘內，該任務不會運行超過1次；
     * lockAtMostFor：鎖最大持有時間30秒，表示最多鎖定30秒鐘，主要用於防止執行任務的節點掛掉（即使這個節點掛掉，在30秒鐘後，鎖也被釋放），一般將其設置為明顯大於任務的最大執行時長；如果任務運行時間超過該值（即任務30秒鐘沒有執行完），則該任務可能被重復執行。
     */
    @Scheduled(cron = "0/5 * * * * ? ")
    @SchedulerLock(name = "testJob1",lockAtLeastFor = "20000", lockAtMostFor = "30000")
    public void scheduledTask1() {
        log.info(Thread.currentThread().getName() + "->>>任務1執行第：" + (count++) + "次");
    }

    /**
     * 任務2每5秒執行一次
     */
    @Scheduled(cron = "0/5 * * * * ? ")
    @SchedulerLock(name = "testJob2")
    public void scheduledTask2() {
        log.info(Thread.currentThread().getName() + "->>>任務2執行第：" + (count++) + "次");
    }

}

@SpringBootApplication
public class JdbcApplication {

    public static void main(String[] args) {
         SpringApplication.run(JdbcApplication.class, args);
    }

}