原文地址:?https://blog.csdn.net/qq_32182637/article/details/111871188

https://blog.csdn.net/qq_35913663/article/details/124910631

寫在前面

本篇文章僅作為近日參考其他文章后，自己實(shí)踐的記錄和總結(jié)，場(chǎng)景到細(xì)節(jié)尚有很多不足，有待補(bǔ)充和修正。

概述

ShedLock只做一件事。它可以確保計(jì)劃的任務(wù)在同一時(shí)間最多執(zhí)行一次。如果任務(wù)正在一個(gè)節(jié)點(diǎn)上執(zhí)行，它將獲得一個(gè)鎖，該鎖阻止從另一個(gè)節(jié)點(diǎn)（或線程）執(zhí)行相同的任務(wù)。請(qǐng)注意，如果一個(gè)任務(wù)已經(jīng)在一個(gè)節(jié)點(diǎn)上執(zhí)行，那么在其他節(jié)點(diǎn)上的執(zhí)行不會(huì)等待，只會(huì)跳過它。

目前，支持通過Mongo、JDBC數(shù)據(jù)庫、Redis、Hazelcast或ZooKeeper協(xié)調(diào)的Spring計(jì)劃任務(wù)。預(yù)計(jì)未來會(huì)有更多的時(shí)間安排和協(xié)調(diào)機(jī)制。

ShedLock需要使用@SchedulerLock注解來為某個(gè)方法實(shí)現(xiàn)鎖，分布式場(chǎng)景是其應(yīng)用的主要且典型的場(chǎng)景，但這并不代表ShedLock僅能使用在分布式上，這取決于你理解他的原理后如何去使用它。

ShedLock原理簡(jiǎn)析

ShedLock的原理很簡(jiǎn)單,首先來看@SchedulerLock注解類：

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})

@Retention(RetentionPolicy.RUNTIME)

public @interface SchedulerLock {

? ? String name() default "";

? ? long lockAtMostFor() default -1L;

? ? String lockAtMostForString() default "";

? ? long lockAtLeastFor() default -1L;

? ? String lockAtLeastForString() default "";

}

1

2

3

4

5

6

7

8

9

10

11

12

13

根據(jù)注解類可知

可以使用在方法（ElementType.METHOD）上，這是該注解的常用方式

可以使用在其他注解類上（ElementType.ANNOTATION_TYPE）上，此種情景我尚不知道如何應(yīng)用，有過簡(jiǎn)單的嘗試，但是沒有想要的效果

name屬性表示鎖的名稱，區(qū)分大小寫

lockAtMostFor占用鎖的最長(zhǎng)時(shí)間，單位毫秒

lockAtMostForString 占用鎖的最長(zhǎng)時(shí)間,字符類型，"PT1S"表示1秒，"PT1M"表示1分鐘，如果與lockAtMostFor屬性同時(shí)設(shè)置，以lockAtMostFor 為準(zhǔn)

lockAtLeastFor 占用鎖的最短時(shí)間，單位毫秒

lockAtLeastForString 占用鎖的最短時(shí)間,字符類型，"PT1S"表示1秒，"PT1M"表示1分鐘，如果與lockAtLeastFor 屬性同時(shí)設(shè)置，以lockAtLeastFor 為準(zhǔn)

ShedLock的實(shí)現(xiàn)依賴外部存儲(chǔ)，包括常規(guī)的數(shù)據(jù)庫、redis緩存等，然而無論選用哪種方式，存儲(chǔ)的數(shù)據(jù)內(nèi)容都基本一致，以mysql數(shù)據(jù)庫為例：

字段名 說明

name 鎖的名稱，唯一值，區(qū)分大小寫

lock_until 鎖占用的結(jié)束時(shí)間= locked_at +lockAtMostFor

locked_at 開始占用鎖的時(shí)間

locked_by 占用者，通常是主機(jī)名

觀察源碼可以發(fā)現(xiàn)，在需要獲取鎖的時(shí)候，會(huì)嘗試向shedlock表插入一條記錄，而name作為主鍵，如果不存在相同名稱的鎖，則插入記錄，并成功占用該鎖

INSERT INTO? shedlock(name, lock_until, locked_at, locked_by) VALUES(?, ?, ?, ?)

1

如果已經(jīng)存在同名的鎖，則將違反主鍵唯一約束，插入失敗，此時(shí)會(huì)嘗試篩選出shedlock表中鎖名稱相同并且已經(jīng)釋放（lock_until<當(dāng)前時(shí)間）的記錄，如果有符合條件的，則更新該記錄，并成功占用該鎖

UPDATE shedlock SET lock_until = ?, locked_at = ?, locked_by = ? WHERE name = ? AND lock_until <= ?

1

如果沒能篩選出符合條件的記錄，則代表獲取鎖失敗，將會(huì)放棄本次執(zhí)行任務(wù)。

在任務(wù)方法執(zhí)行完成后，如果當(dāng)前時(shí)間還未超過lock_until時(shí)間，則更新記錄的lock_until時(shí)間為locked_at+lockAtLeastFor ，即將占用鎖的時(shí)長(zhǎng)改為最低時(shí)長(zhǎng)

此外需要注意的是ShedLock是基于時(shí)間的鎖機(jī)制，在分布式情景中，如果不同節(jié)點(diǎn)部署在不同的主機(jī)上,將默認(rèn)使用主機(jī)的時(shí)間，這時(shí)則需要強(qiáng)調(diào)各主機(jī)之間的時(shí)間同步，當(dāng)然在較高版本的依賴包中，會(huì)提供設(shè)置使用外部存儲(chǔ)的主機(jī)時(shí)間，如數(shù)據(jù)庫主機(jī)時(shí)間

更多詳情可以參考另一篇文章《SchedulerLock 分布式鎖 原理》

ShedLock+Mysql

首先需要導(dǎo)入依賴

<!--此依賴是shedlock核心依賴包，與spring接洽，有時(shí)候版本不對(duì)會(huì)導(dǎo)致不生效-->

<dependency>

? ?<groupId>net.javacrumbs.shedlock</groupId>

? ? <artifactId>shedlock-spring</artifactId>

? ? <version>2.2.0</version>

</dependency>

<!--數(shù)據(jù)庫訪問所需-->

<dependency>

? ? <groupId>net.javacrumbs.shedlock</groupId>

? ? <artifactId>shedlock-provider-jdbc-template</artifactId>

? ? <version>2.2.0</version>

</dependency>

1

2

3

4

5

6

7

8

9

10

11

12

創(chuàng)建數(shù)據(jù)庫表

CREATE TABLE shedlock (

? name varchar(64) COLLATE utf8mb4_bin NOT NULL,

? lock_until timestamp(3) NOT NULL,

? locked_at timestamp(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),

? locked_by varchar(255) COLLATE utf8mb4_bin NOT NULL,

? PRIMARY KEY (name)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

1

2

3

4

5

6

7

實(shí)現(xiàn)配置類，以提供LockProvider

import net.javacrumbs.shedlock.core.LockProvider;

import net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;

import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.jdbc.core.JdbcTemplate;

import org.springframework.scheduling.annotation.EnableScheduling;

import javax.sql.DataSource;

import static net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider.Configuration.builder;

@Configuration

@EnableScheduling

@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")

public class SchedulerConfiguration {

? ? @Bean

? ? public LockProvider lockProvider(DataSource dataSource) {

//可以自定義數(shù)據(jù)源，可以作為一種考慮，一般不使用這個(gè)

? ? ? ? org.apache.tomcat.jdbc.pool.DataSource dataSource1 = new org.apache.tomcat.jdbc.pool.DataSource();

? ? ? ? dataSource1.setUrl("jdbc:mysql://127.0.0.1:3601/ICSP?useUnicode=true&characterEncoding=utf8&useSSL=false");

? ? ? ? dataSource1.setUsername("tom");

? ? ? ? dataSource1.setPassword("tommy");

? ? ? ? LockProvider lockProvider= new JdbcTemplateLockProvider(builder()

? ? ? ? //指定表名

? ? ? ? ? ? ? ? .withTableName("shedlock")

? ? ? ? ? ? ? ? //指定數(shù)據(jù)源，一般使用dataSource而非手動(dòng)定義的數(shù)據(jù)源

? ? ? ? ? ? ? ? .withJdbcTemplate(new JdbcTemplate(dataSource1))

? ? ? ? ? ? ? ? //指定表字段名稱，字段數(shù)量固定，只能改名稱，且只有較高版本的shedlock-provider-jdbc-template依賴才提供該配置項(xiàng)

//? ? ? ? ? ? ? ? .withColumnNames(new JdbcTemplateLockProvider.ColumnNames("name","lock_until","locked_at","locked_by"))

//使用數(shù)據(jù)庫時(shí)間，只有較高版本的shedlock-provider-jdbc-template依賴才提供該配置項(xiàng)

//? ? ? ? ? ? ? ? .usingDbTime()

//作用未知，只有較高版本的shedlock-provider-jdbc-template依賴才提供該配置項(xiàng)

//? ? ? ? ? ? ? ? .withLockedByValue("myvalue")

//作用未知，只有較高版本的shedlock-provider-jdbc-template依賴才提供該配置項(xiàng)

//? ? ? ? ? ? ? ? .withIsolationLevel(1)

? ? ? ? ? ? ? ? .build());

? ? ? ? return? lockProvider;

? ? }

}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

關(guān)于以上配置，需要做一些補(bǔ)充說明：

@EnableScheduling是在使用定時(shí)任務(wù)的時(shí)候才需要加上，這也是shedlock最典型的應(yīng)用場(chǎng)景

@EnableSchedulerLock注解除了可以設(shè)置默認(rèn)的占用鎖最長(zhǎng)最短時(shí)間外，還有一個(gè)mode參數(shù)，可供設(shè)置的值有

值 說明

EnableSchedulerLock.InterceptMode.PROXY_SCHEDULER 與@Scheduled搭配使用

EnableSchedulerLock.InterceptMode.PROXY_METHOD 單獨(dú)使用在方法上，這意味著只要該方法被調(diào)用，則會(huì)嘗試占用鎖，這也是shedlock的另一種使用場(chǎng)景

shedlock-provider-jdbc-template版本新增JdbcTemplateLockProvider.Configuration.builder方法對(duì)照

版本 新增方法

4.1.0 .withColumnNames

.withLockedByValue

4.9.0 .usingDbTime

4.27.0 .withIsolationLevel

4.使用較高的shedlock-provider-jdbc-template依賴版本的話，也需要使用使用較高版本的shedlock-spring依賴版本，否則在執(zhí)行時(shí)會(huì)報(bào)錯(cuò)。而如果使用了較高的shedlock-spring依賴版本，則可能還需要和spring context的依賴版本（只是猜測(cè)，具體是哪個(gè)依賴未能確認(rèn)）相匹配，可以確認(rèn)的是，過高的shedlock-spring依賴版本會(huì)導(dǎo)致注冊(cè)Task的時(shí)候，不會(huì)將任務(wù)設(shè)置為L(zhǎng)ockabaleRunable,而是普通的ScheduledMethodRunable，直接的影響就是定時(shí)任務(wù)shedlock失效。

所以在這我只是發(fā)現(xiàn)問題，但是如何解決尚不得而知，如果各位有知道 想要使用4.27.0及以上版本的shedlock-provider-jdbc-template依賴時(shí) 其他的依賴包可以使用的版本搭配，歡迎告知

然后就可以使用@SchedulerLock注解啦

ShedLock+Redis

1.pom文件

redis必須項(xiàng)：

<dependency>

? ? <groupId>org.springframework.boot</groupId>

? ? <artifactId>spring-boot-starter-data-redis</artifactId>

</dependency>

shedlock必須項(xiàng)：

<dependency>

? ? <groupId>net.javacrumbs.shedlock</groupId>

? ? <artifactId>shedlock-spring</artifactId>

? ? <version>4.19.1</version>

</dependency>

shedlock可選項(xiàng)（此處采用redis實(shí)現(xiàn)，也可采用其他數(shù)據(jù)庫，詳見官網(wǎng)https://github.com/lukas-krecan/ShedLock）：

<dependency>

? ? <groupId>net.javacrumbs.shedlock</groupId>

? ? <artifactId>shedlock-provider-redis-spring</artifactId>

? ? <version>2.5.0</version>

</dependency>

————————————————

@Configuration

@EnableScheduling

@EnableSchedulerLock(defaultLockAtMostFor = "10m")

public class ShedLockConfig {

? ? @Resource

? ? RedisTemplate<String, Object> redisTemplate;

?

? ? @Bean

? ? public LockProvider lockProvider() {

? ? ? ? return new RedisLockProvider(redisTemplate.getConnectionFactory());

? ? }

}

@Slf4j

@Component

public class TaskRun {

?

? ? @Scheduled(cron = "0 0 */1 * * ?")

? ? @SchedulerLock(name = "fylr")

? ? public void fylr() {

? ? ? ? System.out.println("run ...");

? ? }

}

ShedLock+Mongo

待補(bǔ)充

ShedLock+ZooKeeper

待補(bǔ)充

————————————————

版權(quán)聲明：本文為CSDN博主「趙加恩」的原創(chuàng)文章，遵循CC 4.0 BY-SA版權(quán)協(xié)議，轉(zhuǎn)載請(qǐng)附上原文出處鏈接及本聲明。

原文鏈接：https://blog.csdn.net/qq_35913663/article/details/124910631