redis分布式锁java实现

redis与redis分布式锁java实现@TOC

分布式锁

什么是分布式锁?在分布式系统中，常常需要协调他们的动作。如果不同的系统或是同一个系统的不同主机之间共享了一个或一组资源，那么访问这些资源的时候，往往需要互斥来防止彼此干扰来保证一致性 .为了确保分布式锁可用，我们至少要确保锁的实现同时满足以下四个条件：
1.互斥性,在任何时候,只有一个客户端能持有锁
2.不会发生死锁.即使一个客户端在持有锁期间因奔溃没有自动解锁,也能保证后续客户端能加锁
3.具有容错性,只要大部分的redis节点能正常工作,客户端就能加锁和解锁
4.解铃还需系铃人,解锁和加锁必须是同一个客户端,其他客户端不能把别人的锁解了.
分布式锁业界上有三种实现方式:1.基于zookeeper实现的分布式锁;2.基于redis实现的分布式锁;3.基于数据库乐观锁实现.本博客主要讲解是第二种,基于redis实现. redis作为缓存中间件,无论是在电商项目,还是传统的ERP项目,想必大家都有所用到,特别是2016年来,分布式spring cloud,dubbo等分布式框架的使用,redis作为分布式缓存,提高系统的性能,加强系统的健壮性.

java代码实现

添加依赖组件

本文是基于maven实现

  <!-- Redis客户端 -->
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
        </dependency>
        <!--redis分布式集群-->
        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson</artifactId>
            <version>3.9.0</version>
        </dependency>

正确的加锁姿势

    private static final String LOCKED_SUCCESS = "OK";
    private static final String SET_IF_NOT_EXIST  = "NX";
    private static final String SET_WITH_EXPIRE_TIME  = "PX";
    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * 获取分布式锁
     * @param jedis
     * @param lockkey
     * @param uniqueId   请求标识
     * @param expireTime
     * @return 是否获取到锁
     */
    public  boolean tryDistributedLock(Jedis jedis, String lockkey, String uniqueId, long expireTime) {
        String result = jedis.set(lockkey, uniqueId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME , expireTime);
        return LOCKED_SUCCESS.equals(result);

    }

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

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

第二个为value，我们传的是requestId，很多童鞋可能不明白，有key作为锁不就够了吗，为什么还要用到value？原因就是我们在上面讲到可靠性时，分布式锁要满足第四个条件解铃还须系铃人，通过给value赋值为requestId，我们就知道这把锁是哪个请求加的了，在解锁的时候就可以有依据。requestId可以使用UUID

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

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

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

总的来说，执行上面的set()方法就只会导致两种结果：1. 当前没有锁（key不存在），那么就进行加锁操作，并对锁设置个有效期，同时value表示加锁的客户端。2. 已有锁存在，不做任何操作。

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

错误的加锁示例一

比较常见的错误示例就是使用jedis.setnx()和jedis.expire()组合实现加锁，代码如下:

public static void wrongGetLock(Jedis jedis, String lockKey, String requestId, int expireTime) {

    Long result = jedis.setnx(lockKey, requestId);
    if (result == 1) {
        // 若在这里程序突然崩溃，则无法设置过期时间，将发生死锁
        jedis.expire(lockKey, expireTime);
    }

}

setnx()方法作用就是SET IF NOT EXIST，expire()方法就是给锁加一个过期时间。乍一看好像和前面的set()方法结果一样，然而由于这是两条Redis命令，不具有原子性，如果程序在执行完setnx()之后突然崩溃，导致锁没有设置过期时间。那么将会发生死锁.

错误示例二

    long expires = System.currentTimeMillis() + expireTime;
    String expiresStr = String.valueOf(expires);

    // 如果当前锁不存在，返回加锁成功
    if (jedis.setnx(lockKey, expiresStr) == 1) {
        return true;
    }

    // 如果锁存在，获取锁的过期时间
    String currentValueStr = jedis.get(lockKey);
    if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
        // 锁已过期，获取上一个锁的过期时间，并设置现在锁的过期时间
        String oldValueStr = jedis.getSet(lockKey, expiresStr);
        if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
            // 考虑多线程并发的情况，只有一个线程的设置值和当前值相同，它才有权利加锁
            return true;
        }
    }

    // 其他情况，一律返回加锁失败
    return false;

}

这一种错误示例就比较难以发现问题，而且实现也比较复杂。实现思路：使用jedis.setnx()命令实现加锁，其中key是锁，value是锁的过期时间。执行过程：1. 通过setnx()方法尝试加锁，如果当前锁不存在，返回加锁成功。2. 如果锁已经存在则获取锁的过期时间，和当前时间比较，如果锁已经过期，则设置新的过期时间，返回加锁成功。代码如下：

那么这段代码问题在哪里？1. 由于是客户端自己生成过期时间，所以需要强制要求分布式下每个客户端的时间必须同步。 2. 当锁过期的时候，如果多个客户端同时执行jedis.getSet()方法，那么虽然最终只有一个客户端可以加锁，但是这个客户端的锁的过期时间可能被其他客户端覆盖。3. 锁不具备拥有者标识，即任何客户端都可以解锁。

正确解锁代码

    /**
     *释放分布式锁
     * @param jedis
     * @param lockkey
     * @param uniqueId 请求标志
     * @return 是否释放锁
     */
    public  boolean releaseLock(Jedis jedis, String lockkey, String uniqueId) {
        //lua脚本
        String luaScript = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
        Object result = jedis.eval(luaScript, Collections.singletonList(lockkey), Collections.singletonList(uniqueId));
       //如下释放分布式锁存在问题： Client A去加锁lockKey，然后释放锁，在执行del(lockKey)之前，这时lockKey锁expire到期失效了，此时Client B尝试加锁lockKey成功，Client A接着执行释放锁操作(del)，便释放了Client B的锁.
        /*Object result="";
        if (uniqueId.equals(jedis.get(lockkey))) {
            result = jedis.del(lockkey);
        }*/

        return RELEASE_SUCCESS.equals(result);
    }

可以看到，我们解锁只需要两行代码就搞定了！第一行:我们写了一个简单的lua脚本.第二行:
我们将lua脚本上传带jedis客户端的evla()方法. KEYS[1]赋值为lockkey, ARGV[1]赋值为requestId.
redis服务端执行eval()方法的含义是:首先获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁).

错误的解锁示例一

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

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

错误的解锁示列二

这种解锁代码乍一看也是没问题,与正确姿势差不多，唯一区别的是分成两条命令去执行，代码如下：

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

}

代码解释如下:出现问题在于在调用del()方法的时候,这把锁已经不属于当前客户端的,这样就会解除他人的锁.比如客户端A加锁,一段时间后A去解锁,但是恰好在执行del()方法之前,锁刚好过期啦,此时变成是B客户端加锁,此时A再去解锁,则把B客户端的锁解啦.

总结

总的来说,redis实现分布式锁,不是很难,但是要保证锁的可靠性.本文列举了经典的错误加错和解锁代码,希望童鞋们认真思考,保持质疑之心,在往后的编程之路越走越远.