redis实现分布式锁的正确方式（java版）

1.组件依赖

通过Maven引入Jedis开源组件，在pom.xml文件加入下面的代码：

<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>

2.加锁的实现

2.1常见的两种错误方式

1.第一种

public static void wrongGetLock(Jedis jedis,String key,String value,int expTime){
        Long result = jedis.setnx(key, value);
        if(result == 1){
            //若在这里程序突然崩溃，则无法设置过期时间，将发生死锁
            jedis.expire(key, expTime);
        }
    }

2.第二种

    public static boolean wrongGetLock2(Jedis jedis,String key,String value,int expTime){
        long expires = System.currentTimeMillis() + expTime;
        String expiresStr = String.valueOf(expires);
        
        // 如果当前锁不存在，返回加锁成功
        if (jedis.setnx(key, expiresStr) == 1) {
            return true;
        }
        // 如果锁存在，获取锁的过期时间
        String currentValueStr = jedis.get(key);
        if(currentValueStr != null && Long.valueOf(currentValueStr)<System.currentTimeMillis()){
            // 锁已过期，获取上一个锁的过期时间，并设置现在锁的过期时间
            String oldString = jedis.getSet(key, expiresStr);
            if(oldString != null && oldString.equals(currentValueStr)){
                return true;
            }
        }
        return false;
    }

问题所在：

由于是客户端自己生成过期时间，所以需要强制要求分布式下每个客户端的时间必须同步。

当锁过期的时候，如果多个客户端同时执行jedis.getSet()方法，那么虽然最终只有一个客户端可以加锁，但是这个客户端的锁的过期时间可能被其他客户端覆盖。

锁不具备拥有者标识，即任何客户端都可以解锁。

2.2 正确的加锁方式

public class RedisTool {
    
    private static final Logger logger = LoggerFactory.getLogger(RedisTool.class);
    
    //加锁成功标志
    private static final String LOCK_SUCCESS = "OK";
    //解锁成功标志
    private static final String RELEASE_SUCCESS = "1";
    //加锁标志
    private static final String SET_IF_NOT_EXIST = "NX";
    //给锁设置过期时间的标志
    private static final String SET_WITH_EXPIRE_TIME = "PX";
    
    
    /**
     * 尝试获得锁
     * @param jedis    redis实例
     * @param key      具体的锁
     * @param value    锁的值，解锁的时候用
     * @param expTime  锁的失效时间
     * @return 加锁成功标志
     */
    public static boolean getDistributedLock(Jedis jedis,String key,String value,int expTime){
        boolean isLocked = false;
        try {
            String result = jedis.set(key, value, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expTime);
            if (LOCK_SUCCESS.equals(result)) {
                isLocked = true;
            }
        } catch (Exception e) {
            e.printStackTrace();
            logger.error("redis加锁失败："+e.getMessage());
        }
        return isLocked;
    }
}

可以看到，我们加锁就一行代码：jedis.set(String key, String value, String nxxx, String expx, int time)，这个set()方法一共有五个形参：

第一个为key，我们使用key来当锁，因为key是唯一的。

第二个为value，在解锁的时候就可以有依据。value可以使用UUID.randomUUID().toString()方法生成。

第三个为nxxx，这个参数我们填的是NX，意思是SET IF NOT EXIST，即当key不存在时，我们进行set操作；若key已经存在，则不做任何操作；

第四个为expx，这个参数我们传的是PX，意思是我们要给这个key加一个过期的设置，具体时间由第五个参数决定。

第五个为time，与第四个参数相呼应，代表key的过期时间。

首先，set()加入了NX参数，可以保证如果已有key存在，则函数不会调用成功，也就是只有一个客户端能持有锁，满足互斥性。其次，由于我们对锁设置了过期时间，即使锁的持有者后续发生崩溃而没有解锁，锁也会因为到了过期时间而自动解锁（即key被删除），不会发生死锁。最后，因为我们将value赋值为requestId，代表加锁的客户端请求标识，那么在客户端在解锁的时候就可以进行校验是否是同一个客户端。由于我们只考虑Redis单机部署的场景，所以容错性我们暂不考虑。

3.解锁

3.1 解锁的常见两种错误方式

1.第一种

public static void wrongReleaseLock1(Jedis jedis, String lockKey) {
        jedis.del(lockKey);
}

最常见的解锁代码就是直接使用jedis.del()方法删除锁，这种不先判断锁的拥有者而直接解锁的方式，会导致任何客户端都可以随时进行解锁，即使这把锁不是它的。

2.第二种

public static void wrongReleaseLock2(Jedis jedis, String lockKey, String requestId) {

      // 判断加锁与解锁是不是同一个客户端
      if (requestId.equals(jedis.get(lockKey))) {
          // 若在此时，这把锁突然不是这个客户端的，则会误解锁
          jedis.del(lockKey);
      }
}

如代码注释，问题在于如果调用jedis.del()方法的时候，这把锁已经不属于当前客户端的时候会解除他人加的锁。那么是否真的有这种场景？答案是肯定的，比如客户端A加锁，一段时间之后客户端A解锁，在执行jedis.del()之前，锁突然过期了，此时客户端B尝试加锁成功，然后客户端A再执行del()方法，则将客户端B的锁给解除了。

3.2 正确的解锁方式

    /**
     * 尝试解锁(删除key)
     * @param jedis  redis实例
     * @param key    具体的锁
     * @param value   
     * @return
     */
    public static boolean releaseDistributedLock(Jedis jedis, String key, String value){
        boolean isUnlocked = false;
        try {
            //获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁);eval()方法执行Lua脚本是原子性的
            String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
            Object result = jedis.eval(script, Collections.singletonList(key), Collections.singletonList(value));
            if(!CommonUtils.check(result) && RELEASE_SUCCESS.equals(result.toString())){
                isUnlocked = true;
            }
        } catch (Exception e) {
            e.printStackTrace();
            logger.error("redis解锁异常:"+e.getMessage());
        }
        return isUnlocked;
    }

那么这段Lua代码的功能是什么呢？其实很简单，首先获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁）。那么为什么要使用Lua语言来实现呢？因为要确保上述操作是原子性的。
简单来说，就是在eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其他命令。

原文链接