原创声明
：本文系作者原创，谢绝个人、媒体、公众号或网站
未经授权
转载，违者追究其法律责任。
通常如果在单机环境，使用synchronized或juc ReentrantLock 实现锁机制，但如果是分布式系统，则需要借助第三方工具实现，比如redis、zookeeper等。
redis为单进程单线程模式，操作都是原子过程，采用队列模式将并发访问变成串行访问，且多客户端对redis的连接并不存在竞争关系。本文参考redis官网setnx命令篇及其他Coder分享，实现基于redis的准生产级不可重入分布式锁。
一、redis 基本命令
setnx 命令（『SET if Not eXists』(如果不存在，则 SET)的简写）：
设置成功，返回 1 。
设置失败，返回 0 。
该命令是原子操作。
getset 命令：
自动将key对应到value并且返回原来key对应的value。如果key存在但是对应的value不是字符串，就返回错误。
* 返回值 *：
返回之前的旧值，如果之前Key不存在将返回nil。
该命令是原子操作。
get
命令：
get <key> 获取key的值，如果存在，则返回；如果不存在，则返回nil；
del 命令
：
del <key> 删除key及key对应的值，如果key不存在，程序忽略
二、使用SETNX实现分布式锁
redis官网推荐的setnx实现分布式锁如下，多个进程执行以下Redis命令：
SETNX lock.foo {current Unix time + lock timeout + 1}
如果 SETNX 返回1，说明该进程获得锁，SETNX将键 lock.foo 的值设置为锁的超时时间（当前时间 + 锁的有效时间）。
如果 SETNX 返回0，说明其他进程已经获得了锁，进程不能进入临界区。进程可以在一个循环中不断地尝试 SETNX 操作，以获得锁。
三、死锁问题
基于setnx、getset命令的分布式锁实现过程中如果细节不反复测试，很容易出现死锁问题:
考虑一种情况，如果进程获得锁后，断开了与 Redis 的连接（可能是进程挂掉，或者网络中断），如果没有有效的释放锁的机制，那么其他进程都会处于一直等待的状态，即出现“死锁”。上面在使用 SETNX 获得锁时，我们将键 lock.foo 的值设置为锁的有效时间，进程获得锁后，其他进程还会不断的检测锁是否已超时，如果超时，那么等待的进程也将有机会获得锁。然而，锁超时时，我们不能简单地使用 DEL 命令删除键 lock.foo 以释放锁。考虑以下情况，进程P1已经首先获得了锁 lock.foo，然后进程P1挂掉了。进程P2，P3正在不断地检测锁是否已释放或者已超时，执行流程如下：
- P2和P3进程读取键 lock.foo 的值，检测锁是否已超时（通过比较当前时间和键 lock.foo 的值来判断是否超时）
- P2和P3进程发现锁 lock.foo 已超时
- P2执行 DEL lock.foo命令
- P2执行 SETNX lock.foo命令，并返回1，即P2获得锁
- P3执行 DEL lock.foo命令将P2刚刚设置的键 lock.foo 删除（这步是由于P3刚才已检测到锁已超时）
- P3执行 SETNX lock.foo命令，并返回1，即P3获得锁
- P2和P3同时获得了锁
从上面的情况可以得知，在检测到锁超时后，进程不能直接简单地执行 DEL 删除键的操作以获得锁。为了解决上述算法可能出现的多个进程同时获得锁的问题，我们再来看以下的算法。
我们同样假设进程P1已经首先获得了锁 lock.foo，然后进程P1挂掉了。接下来的情况：
- 进程P4执行 SETNX lock.foo 以尝试获取锁
- 由于进程P1已获得了锁，所以P4执行 SETNX lock.foo 返回0，即获取锁失败
- P4执行 GET lock.foo 来检测锁是否已超时，如果没超时，则等待一段时间，再次检测
- 如果P4检测到锁已超时，即当前的时间大于键 lock.foo 的值，P4会执行以下操作
GETSET lock.foo {current Unix timestamp + lock timeout + 1}
- 由于 GETSET 操作在设置键的值的同时，还会返回键的旧值，通过比较键 lock.foo 的旧值是否小于当前时间，可以判断进程是否已获得锁。
- 假如另一个进程P5也检测到锁已超时，并在P4之前执行了 GETSET 操作，那么P4的 GETSET 操作返回的是一个大于当前时间的时间戳，这样P4就不会获得锁而继续等待。注意到，即使P4接下来将键 lock.foo 的值设置了比P5设置的更大的值也没影响。
- 另外，值得注意的是，在进程释放锁，即执行 DEL lock.foo 操作前，需要先判断锁是否已超时。如果锁已超时，那么锁可能已由其他进程获得，这时直接执行 DEL lock.foo 操作会导致把其他进程已获得 的锁释放掉。
四、代码实现
本文基于jedis2.9, 以java语言代码实现，如下:
测试代码入口：
private
static
final
String lockKey =
"lock:user_13"
;
public
static
void
main(String[] args) {
Jedis jedis =
new
Jedis(
"127.0.0.1"
,
6379
);
DistributedLockHandler distributedLockHandler =
new
DistributedLockHandler().setJedis(jedis);
try
{
boolean
getLock = distributedLockHandler.tryLock(lockKey, Long.valueOf(
5
));
if
(getLock){
// Do your job
System.out.println(
"Do your job........"
);
}
}
catch
(Exception e){
System.out.println(e);
}
finally
{
distributedLockHandler.realseLock(lockKey);
}
}
分布式锁实现代码:
public
class
DistributedLockHandler {
private
static
final
Integer Lock_Timeout =
3
;
private
Jedis jedis;
/**
* 外部调用加锁的方法
* @param lockKey 锁的key
* @param timeout 超时时间（放置时间长度，如：5L）
* @return
*/
public
boolean
tryLock(String lockKey, Long timeout) {
try
{
Long currentTime = System.currentTimeMillis();
//开始加锁的时间
boolean
result =
false
;
while
(
true
) {
if
((System.currentTimeMillis() - currentTime) /
1000
> timeout) {
//当前时间超过了设定的超时时间
System.out.println(
"Execute DistributedLockHandler.tryLock method, Time out."
);
break
;
}
else
{
result = innerTryLock(lockKey);
if
(result) {
break
;
}
else
{
System.out.println(
"Try to get the Lock,and wait 100 millisecond...."
);
Thread.sleep(
100
);
}
}
}
return
result;
}
catch
(Exception e) {
System.out.println(
"Failed to run DistributedLockHandler.getLock method."
+ e);
return
false
;
}
}
/**
* 释放锁
* @param lockKey 锁的名字
*/
public
void
realseLock(String lockKey) {
if
(!checkIfLockTimeout(System.currentTimeMillis(), lockKey)){
jedis.del(lockKey);
}
}
/**
* 内部获取锁的实现方法
* @param lockKey 锁的名字
* @return
*/
private
boolean
innerTryLock(String lockKey) {
long
currentTime = System.currentTimeMillis();
//当前时间
String lockTimeDuration = String.valueOf(currentTime + Lock_Timeout +
1
);
//锁的持续时间
Long result = jedis.setnx(lockKey, lockTimeDuration);
if
(result ==
1
) {
return
true
;
}
else
{
if
(checkIfLockTimeout(currentTime, lockKey)) {
String preLockTimeDuration = jedis.getSet(lockKey, lockTimeDuration);
if
(currentTime > Long.valueOf(preLockTimeDuration)) {
return
true
;
}
}
return
false
;
}
}
/**
* 判断加锁是否超时
* @param currentTime 当前时间
* @param lockKey 锁的名字
* @return
*/
private
boolean
checkIfLockTimeout(Long currentTime, String lockKey) {
if
(currentTime > Long.valueOf(jedis.get(lockKey))) {
//当前时间超过锁的持续时间
return
true
;
}
else
{
return
false
;
}
}
public
DistributedLockHandler setJedis(Jedis jedis) {
this
.jedis = jedis;
return
this
;
}
}
上述代码已完整实现基于redis setnx的分布式锁，不过该锁机制是不可重入的，与juc中ReentrantLock 可重入锁仍存在距离，之后再分章节实现基于setnx的可重入锁。
参考: