lock4j是一個(gè)分布式鎖組件，其提供了多種不同的支持以滿足不同性能和環(huán)境的需求。

立志打造一個(gè)簡(jiǎn)單但富有內(nèi)涵的分布式鎖組件。

特性

1、簡(jiǎn)單易用，功能強(qiáng)大，擴(kuò)展性強(qiáng)。

2、支持redission,redisTemplate,zookeeper。可混用，支持?jǐn)U展。

如何使用

1、引入相關(guān)依賴(支持同時(shí)存在,不同方法不同鎖實(shí)現(xiàn))。

 <dependencies>
<!--若使用redisTemplate作為分布式鎖底層，則需要引入-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>lock4j-redis-template-spring-boot-starter</artifactId>
<version>${latest.version}</version>
</dependency>
<!--若使用redisson作為分布式鎖底層，則需要引入-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>lock4j-redisson-spring-boot-starter</artifactId>
<version>${latest.version}</version>
</dependency>
<!--若使用zookeeper作為分布式鎖底層，則需要引入-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>lock4j-zookeeper-spring-boot-starter</artifactId>
<version>${latest.version}</version>
</dependency>
</dependencies>

 2、根據(jù)底層需要配置redis或zookeeper。

spring:
redis:
host: 127.0.0.1
...
coordinate:
zookeeper:
zkServers: 127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183

3、在需要分布式的地方使用Lock4j注解。

@Service
public class DemoService {//默認(rèn)獲取鎖超時(shí)3秒，30秒鎖過(guò)期
@Lock4j
public void simple() {
//do something
}

//完全配置，支持spel
@Lock4j(keys = {"#user.id", "#user.name"}, expire = 60000, acquireTimeout = 1000)
public User customMethod(User user) {
return user;
}

}

 高級(jí)使用

1、配置全局默認(rèn)的獲取鎖超時(shí)時(shí)間和鎖過(guò)期時(shí)間。

 lock4j:
acquire-timeout: 3000 #默認(rèn)值3s，可不設(shè)置
expire: 30000 #默認(rèn)值30s，可不設(shè)置
primary-executor: com.baomidou.lock.executor.RedisTemplateLockExecutor #默認(rèn)redisson>redisTemplate>zookeeper，可不設(shè)置
lock-key-prefix: lock4j #鎖key前綴, 默認(rèn)值lock4j，可不設(shè)置

 acquire-timeout 可以理解為排隊(duì)時(shí)長(zhǎng)，超過(guò)這個(gè)時(shí)才就退出排隊(duì)，拋出獲取鎖超時(shí)異常。

為什么必須要有這個(gè)參數(shù)?現(xiàn)實(shí)你會(huì)一直排隊(duì)等下去嗎?所有人都一直排隊(duì)有沒(méi)有問(wèn)題 ?

expire 鎖過(guò)期時(shí)間 。 主要是防止死鎖。 建議估計(jì)好你鎖方法運(yùn)行時(shí)常，正常沒(méi)有復(fù)雜業(yè)務(wù)的增刪改查最多幾秒，留有一定冗余，10秒足夠。 我們默認(rèn)30秒是為了兼容絕大部分場(chǎng)景。

2、自定義執(zhí)行器。

@Service
public class DemoService {

//可在方法級(jí)指定使用某種執(zhí)行器，若自己實(shí)現(xiàn)的需要提前注入到Spring。
@Lock4j(executor = RedissonLockExecutor.class)
public Boolean test() {
return "true";
}
}
 

3、自定義鎖key生成器。

默認(rèn)的鎖key生成器為 com.baomidou.lock.DefaultLockKeyBuilder 。

@Component
public class MyLockKeyBuilder extends DefaultLockKeyBuilder {

@Override
public String buildKey(MethodInvocation invocation, String[] definitionKeys) {
String key = super.buildKey(invocation, definitionKeys);
// do something
return key;
}
}

4、自定義鎖獲取失敗策略。

默認(rèn)的鎖獲取失敗策略為 com.baomidou.lock.DefaultLockFailureStrategy 。

@Component
public class MyLockFailureStrategy implements LockFailureStrategy {

@Override
public void onLockFailure(String key, long acquireTimeout, int acquireCount) {
// write my code
}
}

5、手動(dòng)上鎖解鎖。

@Service
public class ProgrammaticService {
@Autowired
private LockTemplate lockTemplate;

public void programmaticLock(String userId) {
// 各種查詢操作 不上鎖
// ...
// 獲取鎖
final LockInfo lockInfo = lockTemplate.lock(userId, 30000L, 5000L, RedissonLockExecutor.class);
if (null == lockInfo) {
throw new RuntimeException("業(yè)務(wù)處理中,請(qǐng)稍后再試");
}
// 獲取鎖成功，處理業(yè)務(wù)
try {
System.out.println("執(zhí)行簡(jiǎn)單方法1 , 當(dāng)前線程:" + Thread.currentThread().getName() + " , counter：" + (counter++));
} finally {
//釋放鎖
lockTemplate.releaseLock(lockInfo);
}
//結(jié)束
}
}

6、指定時(shí)間內(nèi)不釋放鎖(限流)

默認(rèn)的鎖獲取失敗策略為 com.baomidou.lock.DefaultLockFailureStrategy 。

@Service
public class DemoService {

// 用戶在5秒內(nèi)只能訪問(wèn)1次
@Lock4j(keys = {"#user.id"}, acquireTimeout = 0, expire = 5000, autoRelease = false)
public Boolean test(User user) {
return "true";
}
}