基于单机redis的分布式锁实现

Posted 2020-11-22 Ayato

最近我们有个服务经常出现存储的数据出现重复，首先上一个系统流程图：

 

用户通过http请求可以通知任务中心结束掉自己发送的任务，这时候任务中心会通过MQ通知结束服务去结束任务保存数据，由于任务结束数据计算保存有一定延时，所以存在用户短时间内多次结束同一个任务，这时候就会导致我们结束服务对同一个任务保存多次数据。恰好我们也是用了redis，所以对于这个问题我当时想到使用分布式锁来解决，那么如何用redis实现分布式锁呢？

首先要明确一个分布式锁应具备的原则：

1. 互斥性。在任意时刻，只有一个客户端能持有锁；
2. 不会发生死锁。即使一个客户端持有锁的期间崩溃而没有主动释放锁，也需要保证后续其他客户端能够加锁成功；
3. 加锁和解锁必须是同一个客户端；
4. 有高可用的获取锁和释放锁功能。

由于我们只使用了单机的redis，所以本文的实现不具备第四点原则。

我们这个锁的实现就包括两点：加锁、解锁。首先看加锁。先上代码：

public boolean tryGetDistributedLock(String lockKey, String requestId, int expireTime) throws Exception{
        Jedis jedis = null;
        try {
            jedis = getJedisClient();
            String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
            if (LOCK_SUCCESS.equals(result)) {
                return true;
            }
            return false;
        } finally {
            returnResource(jedis);
        }
 }

我们的加锁就是设置一个键值对，并且满足以下条件：

1. 确保只有当键不存在时才设置有效；
2. 设置的值必须是当前客户端生成的uuid；
3. 键必须要有过期时间。

这三点条件就可以满足上述的原则1、原则2。

接下来看下解锁，代码如下：

public boolean releaseDistributedLock(String lockKey, String requestId) throws Exception{
        Jedis jedis = null;
        try {
            jedis = getJedisClient();
            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(lockKey), Collections.singletonList(requestId));
            if (RELEASE_SUCCESS.equals(result)) {
                return true;
            }
            return false;
        }finally {
            returnResource(jedis);
        }
}

 解锁是通过一段lua脚本实现，逻辑如下：

1、获取锁键值看是否与当初设置的值一致；

2、如果一致则删除键。

由于解锁过程分为两步，为了确保原子性所以通过让redis执行lua脚本来实现，校验键值可以确保加锁解锁都是同一个客户端。

这样一个简易的分布式锁就实现完毕了，当然在本文开头就说了，这个实现只能满足单机redis的情况，对于redis集群其实是不严谨的，对于redis集群有一个redlock方案，我也在研究中，后面也会总结一下。