Redis系列-5 Redis分布式锁

背景：

本文介绍Redis分布式锁的内容，包括Redis相关命令和Lua脚本的介绍，以及操作分布式锁的流程与消息，最后结合Redission源码介绍分布式锁的实现原理。

1.基本命令

1.1 基本键值对的设置

设值: set key value
取值: get key
删除: del key

>set key1 value1
"OK"
>get key1
"value1"
>del key1
"1"

1.2 setnx用法

setnx key value:
当key不存在时，进行设置，返回1(表示操作成功)
当key存在时，不进行设置，返回0(表示操作失败)

>setnx key1 value1
"1"
>setnx key1 value1
"0"

1.3 setex和psetex

setex key seoconds value
等价于原子性地执行了 set key value和expire key seconds
psetex用法与setex相同，区别是setex单位为秒，而psetex是毫秒;

>setex key1 1000 value1
"OK"
>ttl key1
"997"

1.4 set扩展用法

set key value [EX seconds | PX millSeconds] [NX | XX]
seconds EX 表示设置过期时间以秒为单位，millSeconds PX 表示设置过期时间以毫秒为单位;
NX表示当键不存在时执行，并返回OK；否则返回null
XX表示当键存在时执行，并返回OK；否则返回null

>set key1 value1 EX 1000 NX
"OK"
>set key1 value1 EX 1000 NX
null
>set key1 value1 EX 2000 XX
"OK"
>ttl key1
"1996"

2.lua脚本

由于redis是单线程执行的，因此可以原子性地执行lua脚本。因此可通过lua脚本对基本命令进行组合。
格式如下：

EVAL "lua脚本" n KEY... , ARGV...

(1) 通过EVAL命令执行lua脚本;
(2) 可对脚本进行传参，可以传多个KEY和多个ARGV，KEY和ARGV建议使用逗号(,)隔开;
(3) 需要显示指定KEY个数;
(4) lua脚本通过KEYS[i] 和 ARGV[j] 获取传入的参数，下标从1开始;
以下通过案例的方式介绍一下lua脚本的使用。

2.1 加锁

分布式锁的数据结构可以被定义为如下格式:

{
 "lockKey":  {
        "uuid: threadId": num
    }
}

lockKey表示分布式锁：数据库存中存在lockKey键时，表示已有客户端占据了lockKey锁，否则表示lockKey锁未被获取。
uuid: threadId结构包含了UUID唯一字符串，num为获取锁的次数。UUID用于保证上锁和解锁是同一个客户端，num用于实现锁的可重入。
案例:

// 如果锁不存在，则加锁并设置过期时间
if (redis.call('exists', KEYS[1]) == 0) then
    // 设置锁记录锁的获取次数为1
    redis.call('hincrby', KEYS[1], ARGV[2], 1);
    // 设置锁的过期时间
    redis.call('pexpire', KEYS[1], ARGV[1]);
    return nil;
end;

// 如果锁存在，且为自己，锁+1，并重新设置过期时间
if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then
    // 设置锁记录锁的获取次数+1
    redis.call('hincrby', KEYS[1], ARGV[2], 1);
    // 重置锁的过期时间
    redis.call('pexpire', KEYS[1], ARGV[1]);
    return nil;
end;

// 锁已存在，不是自己，则返回锁到期时间
return redis.call('pttl', KEYS[1]);

说明:
上述LUA脚本返回空，说明锁获取成功；否则获取失败并得到锁的过期时间(毫秒)。

其中,redis.call('exists', KEYS[1])表示KEY[1]键是否存在，存在返回1，不存在返回0；redis.call('hincrby', KEYS[1], ARGV[2], 1)表示对哈希类型数据KEYS[1]和ARGV[2]键对应的值加1；redis.call('pexpire', KEYS[1], ARGV[1])表示设置KEYS[1]键的有效期为ARGV[1]，单位毫秒;

在redis客户端进行如下操作：

>EVAL "if (redis.call('exists', KEYS[1]) == 0) then redis.call('hincrby', KEYS[1], ARGV[2], 1); redis.call('pexpire', KEYS[1], ARGV[1]); return nil; end; if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then redis.call('hincrby', KEYS[1], ARGV[2], 1); redis.call('pexpire', KEYS[1], ARGV[1]); return nil; end; return redis.call('pttl', KEYS[1]);" 1 myLock 60000 80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12
null

>hget myLock 80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12
"1"

>ttl myLock
"54"

>EVAL "if (redis.call('exists', KEYS[1]) == 0) then redis.call('hincrby', KEYS[1], ARGV[2], 1); redis.call('pexpire', KEYS[1], ARGV[1]); return nil; end; if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then redis.call('hincrby', KEYS[1], ARGV[2], 1); redis.call('pexpire', KEYS[1], ARGV[1]); return nil; end; return redis.call('pttl', KEYS[1]);" 1 myLock 60000 80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12
null

>ttl myLock
"56"

>hget myLock 80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12
"2"

给上述lua脚本的传参为1 myLock 60000 80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12

1表示只有一个Key, 其他为ARGV，即
KEY[1] = myLock
ARGV[1]=60000
ARGV[2]=80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12

得到的结果如下:

{
 "myLock":  {
        "80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12": 2
    }
}

表示"myLock"分布式锁已被占用, 获取锁的次数为2次。

2.2 解锁

案例:

// 解锁成功返回1，失败返回0
if (redis.call('del', KEYS[1]) == 1) then 
    // 向Redis发布消息
    redis.call('publish', KEYS[2], ARGV[1]); 
    return 1 
else 
    return 0 
end

说明:
解锁成功后，该lua脚本返回1，解锁失败返回0；
其中: redis.call('del', KEYS[1])表示根据KEYS[1]键删除数据；redis.call('publish', KEYS[2], ARGV[1])表示发布消息 KEYS[2], ARGV[1];

2.3 释放一层锁

// 锁不是被自己占有，直接返回
if (redis.call('hexists', KEYS[1], ARGV[3]) == 0) then
    return nil;
end;

// 锁数量-1，如果还大于0，重新设置过期时间；否则删除锁
local counter = redis.call('hincrby', KEYS[1], ARGV[3], -1);
if (counter > 0) then
    // 重置过期时间
    redis.call('pexpire', KEYS[1], ARGV[2]);
    return 0;
else
    redis.call('del', KEYS[1]);
    redis.call('publish', KEYS[2], ARGV[1]);
    return 1;
end;
return nil;

上述Lua脚本返回1表示删除锁成功，返回0表示锁释放一层，返回空表示释放失败。

2.4 续期

// 锁被自己占用，重新设置过期时间，返回1；否则返回0；
if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then
    redis.call('pexpire', KEYS[1], ARGV[1]);
    return 1;
end;
return 0;

上述Lua脚本返回1表示续期成功，返回0表示续期失败(当前未获取锁)。

3.Redission用法

分布式锁可以直接使用开源的Redission
引入依赖:

<dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson</artifactId>
    <version>3.16.1</version>
</dependency>

编码如下:

public static void lock1() {
    RedissonClient redisson = getRedissonClient();
    RLock lock = redisson.getLock("myLock");
    // 获取锁
    lock.lock();
    try {
        // 业务逻辑
    } catch (InterruptedException e) {
        e.printStackTrace();
    } finally {
        // 释放锁
        lock.unlock();
    }
    redisson.shutdown();
    System.out.println("Begin end");
}

// 获取redis客户端实例
private static RedissonClient getRedissonClient() {
    Config config = new Config();
    config.setLockWatchdogTimeout(600*1000);
    config.useSingleServer().setAddress("redis://127.0.0.1:6001").setPassword("xxx");
    RedissonClient redisson = Redisson.create(config);
    return redisson;
}

说明：redisson.getLock(“myLock”)中的myLock即为分布式锁的键，多个客户端实例需要保证键相同。
lock.lock()用于执行获取锁的逻辑，获取成功后直接返回；获取失败后进入等待队列阻塞；lock.unlock();用于手动解锁。
getRedissonClient方法用于获取redis客户端实例，其中的setLockWatchdogTimeout方法用于设置看门狗的超时时间，单位毫秒，默认为30000(30秒)。
使用lock.lock()方法获取锁时不需要设置锁的过期时间，在获取锁成功后，Redisson通过看门狗机制，进行锁的续期，每经过WatchdogTimeout/3时间执行一次续期操作。
当lock.unlock()释放锁时，会同时关闭看门狗。

4.流程和消息

4.1 流程介绍

屏蔽底层Redis对锁的实现方式，仅用Lock和UnLock表示获取锁和释放锁，分布式锁的竞争流程可表示如下图所示:
在这里插入图片描述
[1] 客户端ClientA向Redis发送获取锁的消息，锁key为myLock(自定义);
[2] Redis响应成功，表示占锁成功;
[3] 客户端ClientB向Redis发送获取锁的消息，key为myLock;
[4] 服务器判断此时myLock锁已被ClientA占有，Redis响应失败;
[5] Client B 向Redis发送订阅消息订阅myChannel频道，等待收到通知;
[6-7] ClientA释放锁同时发布消息至Redis的myChannel频道;
[8] Redis收到publish消息后，向所有订阅了myChannel频道的客户端发送message通知消息;
[9] ClientB收到订阅的消息后，知道锁已被释放，再次获取锁;
其中：消息6和消息7是lua脚本执行的，因此具备原子性；当客户端收到message消息时，表明锁已被释放，可以重新竞争锁。
另外，对于客户端ClientA，在消息2-6之间，Redis的看门狗机制会自动为myLock续期。

4.2 消息介绍

Auth消息:

*2
$4
AUTH
$8
Root@123

+OK

其中：*2 表示由两个输入字符串；
$4表示第一个字符串长度为4，即AUTH；
$8表示第二个字符串长度为8，即Root@123；
+OK为Redis返回的结构，表示鉴权成功；
解析后为:

client: AUTH Root@123
Redis: OK

PING/PONG消息:

*1
$4
PING

+PONG

客户端向Redis发送PING心跳消息，Redis响应PONG消息。

QUITE消息:

*1
$4
QUIT

+OK

客户端向Redis发送QUITE退出消息，Redis响应OK消息。

以下分场景介绍Redis消息，包括成功获取锁—锁的续期—锁的释放和发布通知以及获取锁失败—锁的订阅—收到通知消息—取消订阅等，为简化篇幅，将省略AUTH、PING/PONG、AUITE等重复的内容。

4.2.1 成功获取锁

通过wireshark抓包以及经过tcp.port == 16379 && tcp contains "exists"过滤条件，得到:

*6
$4 
EVAL
$339 
if (redis.call('exists', KEYS[1]) == 0) then redis.call('hincrby', KEYS[1], ARGV[2], 1); redis.call('pexpire', KEYS[1], ARGV[1]); return nil; end; if (redis.call('hexists', KEYS[1], ARGV[2]) == 1) then redis.call('hincrby', KEYS[1], ARGV[2], 1); redis.call('pexpire', KEYS[1], ARGV[1]); return nil; end; return redis.call('pttl', KEYS[1]);
$1
1
$6
myLock
$4
6000
$39
80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12

解析后为:

EVAL "lua脚本" 1 myLock 6000 80e6bb0b-b3bb-4ce0-b120-9c7ce917b767:12