【Redis系列7】Redis高级特性之发布/订阅和Lua脚本执行原理分析
Redis高级特性之发布/订阅和Lua脚本执行原理分析
- 前言
- 发布与订阅
-
- 基于频道的实现
-
- 实现原理分析
- 基于模式的实现
-
- 实现原理分析
- Lua脚本
-
- Lua脚本的调用
-
- Lua脚本中执行Redis命令
- Lua脚本摘要
- Lua脚本文件
- 脚本异常
-
- 脚本超时
- 脚本陷入死循环
- 为什么可以执行script kill命令
- 总结
前言
Redis当中除了之前介绍的事务，持久化等高级特性之外，还提供了发布与订阅，Lua脚本，事件机制等高级特性，本文会继续介绍Redis的另外两大高级特性：发布与订阅和Lua脚本。
发布与订阅
理论上来说通过双端链表就可以实现发布与订阅功能，但是这种通过链表来实现的发布与订阅功能有两个局限性：
- 1、如果生产者生产消息的速度远大于消费者消费消息的速度，那么链表中未消费的消息会占用大量的内存。
- 2、基于链表实现的消息队列，不支持一对多的消息分发。
为了解决这两个局限性，Redis当中选择了通过其他命令来实现发布与订阅模式，主要命令有：subscribe uncubscribe publish等。
在Redis中的发布与订阅也分为两种类型，一种是基于频道来实现，一种是基于模式来实现。
基于频道的实现
基于频道的实现方式主要通过以下三个命令：
- subscribe channel-1 channel-2：订阅一个或者多个频道
- unsubscribe channel-1：取消频道的订阅(基于命令操作，界面上无法退订)
- publish channel-1 message：向频道channel-1发送消息message
下图就是客户端1订阅对应频道之后，最后两个红框内就是客户端2发送消息之后这边同步收到的消息：
客户端2发布消息
同时，还有以下2个命令可以查看订阅的频道信息
- punsub channels [channel_name] ：查看当前服务器被订阅的频道。不带参数则返回所有频道，后面的参数可以使用通配符?或者*
- pubsub numsub channel-1 channel-2：查看指定频道的订阅数
实现原理分析
客户端与其订阅的频道信息被保存在redisServer对象中的pubsub_channels属性中。
struct redisServer {
dict *pubsub_channels;//保存了客户端及其订阅的频道信息
//省略其他信息
};
pubsub_channels属性是一个字典，其key值保存的就是频道名，value是一个链表，链表中保存的就是客户端id。
- 订阅
订阅的时候首先会检查字典内是否存在这个频道：如果不存在，则需要为当前频道创建一个字典，同时创建一个链表作为value，并将当前客户端id放入链表；如果存在，则直接将当前客户端id放入链表即可。 - 取消订阅
取消订阅的时候需要将客户端id从对应的链表中移除，如果移除之后链表为空，则需要同时将该频道从字典内删除。 - 发送消息
发送消息时首先会去pubsub_channels字典内寻找键，如果发现有可以匹配上的键，则会找到对应的链表，进行遍历发送消息。
基于模式的实现
基于模式的实现方式主要通过以下三个命令：
- psubscribe pattern-1 pattern-2：订阅一个或者多个模式，模式可以通过通配符?和*来表示
- punsubscribe pattern-1 pattern-1：取消模式的订阅(基于命令操作，界面上无法退订)
- publish channel-1 message ：向频道channel-1发送消息message。注意，这里和上面基于频道命令是一样的
客户端1订阅了模式m*，客户端2向频道movie发送消息，此时客户端1可以收到消息：
同样的，其提供了一个查询命令：
- pubsub numpat：查询当前服务器被订阅模式的数量
实现原理分析
客户端与其订阅的模式信息被保存在redisServer对象中的pubsub_patterns属性中。
struct redisServer {
list pubsub_patterns;//保存了客户端及其订阅的模式信息
//省略其他信息
};
pubsub_patterns属性是一个列表，其列表内结构(源码serer.h内)定义如下：
typedef struct pubsubPattern {
client *client;//订阅模式的客户端
robj *pattern;//被订阅的模式
} pubsubPattern;
- 订阅
新建一个pubsubPattern数据结构加入到链表pubsub_patterns的结尾 - 取消订阅
从链表中将当前取消订阅的客户端pubsubPattern从链表pubsub_patterns中移除 - -发送消息
此时需要遍历整个链表来寻找能匹配的模式。之所以基于模式场景使用链表是因为模式支持通配符，所以没有办法直接用字典实现。
PS：当基于频道和基于模式两种订阅都存在时，Redis会先去寻找频道字典，再去遍历模式链表进行消息发送。
Lua脚本
Redis从2.6版本开始支持Lua脚本，为了支持Lua脚本，Redis在服务器中嵌入了Lua环境。
使用Lua脚本最大的好处是Redis会将整个脚本作为一个整体执行，不会被其他请求打断，可以保持原子性且减少了网络开销。
Lua脚本的调用
Lua脚本的执行语法如下：
eval lua-script numkeys key [key ...] arg [arg ...]
- eval：执行Lua脚本的命令
- lua-script：lua脚本内容
- numkeys：表示的是Lua脚本中需要用到多少个key，如果没用到则写0
- key [key …]：将key作为参数按顺序传递到Lua脚本，numkeys是0则可省略
- arg：Lua脚本中用到的参数，如果没有可省略
下面就是一个不带任何key和参数的简单脚本：
Lua脚本中执行Redis命令
在Lua脚本中执行Redis命令时需要使用以下语法：
redis.call(command, key [key ...] argv [argv…])
- command：Redis中的命令，如set、get等。
- key：操作Redis中的key值，相当于我们调用方法时的形参。
- param：代表参数，相当于我们调用方法时的实参。
下面就是一个简单的在Lua脚本中执行Redis命令的示例：
需要注意的是：KEYS和ARGV必须要大写，参数的下标从1开始。上面的语句意思等价于在Redis中直接执行命令set name lonely_wolf。
Lua脚本摘要
有时候如果我们执行的一个Lua脚本很长的话，那么直接这么调用Lua脚本的话非常不方便，所以Redis当中提供了一个命令script load来为手动给每一个命令生成摘要，这里之所以要说手动的原因是即使我们不使用这个命令，每次调用完Lua脚本的时候，Redis也会为每个Lua脚本生成一个摘要。
其他相关命令：
script exists 摘要：判断一个摘要是否存在。0表示不存在，1表示存在。
script flush：清除所有Lua脚本缓存。
Lua脚本文件
当我们的Lua脚本很长时，直接在命令窗口中写脚本是不直观的，也很难发现语法问题，所以Redis当中也支持我们直接把先把脚本写入文件中，然后直接调用文件。
比如我们新建一个test.lua脚本：
redis.call('set',KEYS[1],ARGV[1])
return redis.call('get',KEYS[1])
执行的时候参数的数量可以省略，但是注意key和arg参数之间要以逗号隔开，且逗号两边的空格不能省略：
脚本异常
我们知道，Redis的指令是单线程执行的，而现在Lua脚本可以写一些逻辑，那么如果Lua
脚本执行超时或者陷入了死循环，这个时候其他的指令就会被阻塞，导致Redis无法正常使用。这个时候应该如何处理呢？
脚本超时
为了解决超时的问题，Redis提供了一个超时时间的参数lua-time-limit来控制Lua脚本执行的超时时间，默认是5秒。
lua-time-limit 5000
脚本陷入死循环
假如脚本陷入了死循环，这时候超时时间就不起作用了，我们来模拟一下：
首先执行一个死循环的lua脚本：
eval 'while(true) do end' 0
然后打开另一个客户端，执行命令：
set key value
这时候会返回busy，表示当前发执行这个命令
为了解决脚本死循环问题，Redis提供了一个script kill命令来中止脚本，我们执行一下这个命令之后发现执行lua脚本的客户端就被停下来了
上面的死循环命令指示一个普通的没有执行任何Redis指令的命令，那么假如我们的lua脚本执行了一些redis命令之后再陷入死循环又会怎么样呢？
执行一个死循环的lua脚本：
eval "redis.call('set','age','18') while true do end" 0
这时候再去另一个客户端执行script kill命令，会提示无法中止lua脚本。
这时候我们就只能执行shutdown nosave命令来强行中断redis，并且加了nosave之后不会触发持久化，从而保证了数据的一致性：
为什么可以执行script kill命令
Redis当中执行指令是单线程的，那么为什么lua脚本陷入死循环之后还可以执行script kill命令呢？
这是因为lua脚本引擎提供了钩子(hook)函数，它允许在内部虚拟机执行指令时运行钩子代码，所以Redis正是利用了这一原理，在执行Lua脚本之前设置了一个钩子，所以script kill命令正式通过钩子(hook)函数来执行的。
总结
本文主要介绍Redis的另外两大高级特性：发布与订阅和Lua脚本。介绍发布与订阅机制时主要介绍了其执行原理，至于Lua脚本，本文并没有介绍Lua脚本的语法，但是介绍了Redis当中执行Lua脚本的一些特性和原理。