基于redis的分布式鎖spring-boot starter組件，使得項目擁有分布式鎖能力變得異常簡單，支持spring boot，和spirng mvc等spring相關項目

快速開始

spring boot項目接入

1.添加lock starter組件依賴，目前還沒上傳到公共倉庫，需要自己下源碼build ，已上傳到maven中央倉庫

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-klock-starter</artifactId><version>1.2-SNAPSHOT</version> </dependency>

2.application.properties配置redis鏈接：spring.klock.address=127.0.0.1:6379

3.在需要加分布式鎖的方法上，添加注解@Klock，如：

@Service public class TestService {@Klock(waitTime = Long.MAX_VALUE)public String getValue(String param) throws Exception {if ("sleep".equals(param)) {//線程休眠或者斷點阻塞，達到一直占用鎖的測試效果Thread.sleep(1000 * 50);}return "success";} }

支持鎖指定的業務key，如同一個方法ID入參相同的加鎖，其他的放行。業務key的獲取支持Spel，具體使用方式如下

使用參數說明

spring.klock.address : redis鏈接地址 spring.klock.password : redis密碼 spring.klock.database : redis數據索引 spring.klock.waitTime : 獲取鎖最長阻塞時間（默認：60，單位：秒） spring.klock.leaseTime: 已獲取鎖后自動釋放時間（默認：60，單位：秒） spring.klock.cluster-server.node-addresses : redis集群配置 如 127.0.0.1:7000,127.0.0.1:7001，127.0.0.1:7002 spring.klock.address 和 spring.klock.cluster-server.node-addresses 選其一即可

@Klock注解參數說明

@Klock可以標注四個參數，作用分別如下 name：lock的name，對應redis的key值。默認為：類名+方法名 lockType：鎖的類型，目前支持（可重入鎖，公平鎖，讀寫鎖）。默認為：公平鎖 waitTime：獲取鎖最長等待時間。默認為：60s。同時也可通過spring.klock.waitTime統一配置 leaseTime：獲得鎖后，自動釋放鎖的時間。默認為：60s。同時也可通過spring.klock.leaseTime統一配置 lockTimeoutStrategy: 加鎖超時的處理策略，可配置為不做處理、快速失敗、阻塞等待的處理策略，默認策略為不做處理 customLockTimeoutStrategy: 自定義加鎖超時的處理策略，需指定自定義處理的方法的方法名，并保持入參一致。 releaseTimeoutStrategy: 釋放鎖時，持有的鎖已超時的處理策略，可配置為不做處理、快速失敗的處理策略，默認策略為不做處理 customReleaseTimeoutStrategy: 自定義釋放鎖時，需指定自定義處理的方法的方法名，并保持入參一致。

鎖超時說明

因為基于redis實現分布式鎖，如果使用不當，會在以下場景下遇到鎖超時的問題：

加鎖超時處理策略(LockTimeoutStrategy)：

• NO_OPERATION 不做處理，繼續執行業務邏輯
• FAIL_FAST 快速失敗，會拋出KlockTimeoutException
• KEEP_ACQUIRE 阻塞等待，一直阻塞，直到獲得鎖，但在太多的嘗試后，會停止獲取鎖并報錯，此時很有可能是發生了死鎖。
• 自定義(customLockTimeoutStrategy) 需指定自定義處理的方法的方法名，并保持入參一致，指定自定義處理方法后，會覆蓋上述三種策略，且會攔截業務邏輯的運行。

釋放鎖時超時處理策略(ReleaseTimeoutStrategy)：

• NO_OPERATION 不做處理，繼續執行業務邏輯
• FAIL_FAST 快速失敗，會拋出KlockTimeoutException
• 自定義(customReleaseTimeoutStrategy) 需指定自定義處理的方法的方法名，并保持入參一致，指定自定義處理方法后，會覆蓋上述兩種策略, 執行自定義處理方法時，業務邏輯已經執行完畢，會在方法返回前和throw異常前執行。

?

轉載于:https://www.cnblogs.com/luchangjiang/p/10805733.html

總結

以上是生活随笔為你收集整理的spring boot 分布式锁组件 spring-boot-klock-starter的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。