Redis之Lua

╰半夏微凉° 2022-05-08 05:36 143阅读 0赞

## Redis 中使用 Lua ##

在 Redis 中执行 Lua 脚本有两种方法：`eval`和`evalsha`。

1 eval

通过内置的 `Lua` 解释器，可以使用 `EVAL` 命令（也可以使用`redis-cli` 的`--eval` 参数）对 `Lua` 脚本进行解析。需要注意的点是执行`Lua`也会使`Redis`阻塞。  
![eval][]

## 格式
    eval  脚本内容 key 个数 key 列表 参数列表
    ## 使用了key列表和参数列表来为Lua脚本提供更多的灵活性
    127.0.0.1:6379> eval 'return "hello " .. KEYS[1] .. ARGV[1]' 1 redis world
    "hello redisworld"
    复制代码

2 evalsha

`evalsha` 中方式的还就是拆分成两个步骤，首先要将`Lua`脚本加载到`Redis`服务端，得到该脚本的`SHA1`校验码。然后使用`evalsha`命令使用`SHA1`作为参数可以直接执行对应`Lua`脚本。这样做的好处是可以避免每次发送`Lua`脚本的开销，而脚本也会常驻在服务端，脚本功能得到了复用。缺点是要怎么管理这些脚本和命令过多的话会占用`Redis`的内存。 ![evalsha][]

## 在当前目录定义一个Lua文件
    vim myLua.lua
    ## 在文件中添加命令并保存
    return "hello " .. KEYS[1] .. ARGV[1]
    ## 1. script load命令可以将脚本内容加载到Redis内存中
    redis-cli script load "$(cat myLua.lua)"
    ## 2. 进入Redis客户端
    redis-cli
    ## 3. evalsha执行脚本格式
    evalsha  脚本SHA1值 key个数 key列表 参数列表
    ## 4. 执行myLua.lua
    127.0.0.1:6379> evalsha 5ea77eda7a16440abe244e6a88fd9df204ecd5aa 1 redis world
    "hello redisworld"
    复制代码

## Lua 的 Redis API ##

`Lua` 可以使用`redis.call` 和 `redis.pcall` 两个函数实现对`Redis`的访问。 `redis.call`和`redis.pcall`的不同在于，如果`redis.call`执行失败，那么脚本执行结束会直接返回错误，而`redis.pcall`会忽略错误继续执行脚本。好哥哥们根据实际场景选择对应函数吧。  
下面代码使用`redis.call`调用了`Redis`的`set`和`get`操作

-- 格式command指的是对应的命令如set/get，后面的话就是key和val
    redis.call(command, key, arg)
    redis.call("set", "hello", "world")
    redis.call("get", "hello")
    复制代码

使用`Redis`的`eval`执行效果

127.0.0.1:6379> eval 'return redis.call("get", KEYS[1])' 1 hello
    "world"
    复制代码

执行 lua 文件

当`Lua`脚本存在比较多的逻辑时，显然使用上面的方式明显不合适，这时就有必要单独编写一个`Lua`文件。下面的代码逻辑是往`Redis`里面设置一个`key`和`value`，如果`value`等于`hello`就返回 1，等于`world`就返回 2

## 1. 还是定义一个lua文件并编辑它
    vim myRedisLua.lua
    ## 2. 添加简单逻辑
    redis.call('set', KEYS[1], ARGV[1])
    local val = redis.call('get', KEYS[1])
    if "hello" == val   then
        return 1
    end
    if "world" == val then
        return 2
    end
    ## 3. 在redis中执行这个脚本
    ## 例子，返回1
    redis-cli --eval myRedisLua.lua key1 , hello
    (integer) 1
    ## 例子，返回2
    redis-cli --eval myRedisLua.lua key1 , world
    (integer) 2
    复制代码

## Redis 对 Lua 脚本的管理 ##

1 加载 Lua 到 Redis

加载`Lua`脚本到`Redis`使用`script load`，这个上面已经示范过了

## 格式
    script load script
    复制代码

2 判断 sha1 在 Redis 是否存在

使用`script exists` 判断对应的脚本是否已经加载到 Redis 中，返回结果代表 sha1\[sha1…\]被加载到 Redis 内存的个数。

## 格式
    scripts exists sha1 [sha1  … ]
    ## 栗子
    127.0.0.1:6379> script exists 5ea77eda7a16440abe244e6a88fd9df204ecd5aa
    1) (integer) 1
    复制代码

3 清除 Redis 内存已加载的所有 Lua 脚本

使用`script flush`命令来清除 Redis 内存已经加载的所有 Lua 脚本。

## 格式
    script flush
    ## 栗子，先判断脚本是否存在
    127.0.0.1:6379> script exists 5ea77eda7a16440abe244e6a88fd9df204ecd5aa
    1) (integer) 1
    ## 执行清除操作
    127.0.0.1:6379> script flush
    OK
    ## 再次检查已经不存在了
    127.0.0.1:6379> script exists a5260dd66ce02462c5b5231c727b3f7772c0bcc5
    1) (integer) 0
    复制代码

4 停止正在执行的 Lua 脚本

如果`Lua`脚本比较耗时，甚至`Lua`脚本存在问题，那么此时`Lua`脚本的执行会阻塞`Redis`，直到脚本执行完毕或 者外部进行干预将其结束，就可以使用`script kill` 来杀掉正在执行的 Lua 脚本。  
另外`Redis`提供了一个`lua-time-limit`参数，默认是 5 秒，它是`Lua`脚本的“超时时间”，但这个超时时间仅仅是当 Lua 脚本时间超过`lua-time-limit`后，向其他命令调用发送`BUSY`的信号，但是并不会停止掉服务端和客户端的脚本执行，所以当达到 lua-time-limit 值之后，其他客户端在执行正常的命令时，将会收到“Busy Redis is busy running a script”错误，并且提示使用`script kill`或者`shutdown nosave`命令来杀掉这个 busy 的脚本。下面做个简单的演示

## 写一个死循环的lua脚本并在redis客户端执行
    127.0.0.1:6379> eval 'while 1==1 do end' 0
    ## 重新起一个客户端去执行命令，返回了报错信息，此时Redis已经阻塞，无法处理正常的调用，这时可以选择继续等待。
    ## 但更多时候需要快速将脚本杀掉。使用shutdown save显然不太合适，所以选择script kill，当script kill执行之后，客户端调用会恢复
    127.0.0.1:6379> get test
    (error) BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.
    ## 另起一个客户端，停止脚本执行
    127.0.0.1:6379> script kill
    OK
    127.0.0.1:6379> get k1
    "11"
    复制代码

## 使用场景 ##

1.  分布式锁框架`Redisson`原理就是使用`Lua`脚本。
2.  活跃用户判断：判断一个游戏用户是否属于活跃用户，如果符合标准，则活跃用户人数+1。
3.  简单 DDOS 防护：限制 n 秒内同 IP 的访问次数。
4.  数据分析,实时平均值统计。
5.  其他很多具体的业务场景（我没有用过，逻辑判断的数据一般都没有存在 Redis）。

## Lua 与 Pipeline 对比 ##

1.  性能上两种模式都是差不多的，都是将命令一次性打包，从而减少往返时间。
2.  从原子上来说，`Pipeline`是非原子性的，`Lua`是原子性的。
3.  灵活性上，`Pipeline`只支持原生命令的打包，而像`Lua`的话可以支持复杂的业务逻辑，灵活性更强。
4.  `Pipeline`不支持集群模式，每次只能作用在一个 Redis 节点上。而`Lua`是可以支持集群。
5.  `Pipeline`与`Lua`都不支持事务。
6.  `Pipeline`一般都是有客户端实时打包命令，而`Lua`脚本可以存放于`Redis`中，提高复用率。

## 总结 ##

使用`Lua`脚本主要有一下好处：

1.  `Lua`脚本在`Redis`中是**原子执行**的，执行过程中间不会插入其他命令。上面再讲`eval`命令的那张图片就很好的解释了。
2.  `Lua`脚本可以帮助开发和运维人员创造出自己定制的命令，并可以将这些命令常驻在`Redis`内存中，实现复用的效果。
3.  `Lua`脚本可以将多条命令一次性打包，有效地减少网络开销。
4.  `Lua`脚本可以适配更加复杂的业务场景（**比如分布式锁**），可嵌入 JAVA，C\#等多种编程语言，支持不同操作系统跨平台交互。
5.  相对来说，`Lua`简单强大，资源占用率低，支持过程化和对象化的编程语言。 需要注意的是，`Lua`能带来很多优势。但是这也在某种程度上对于好哥哥们的要求更高了，使用`Lua`脚本的前提是要熟悉`Lua`的基本语法和使用。另外一方面的话，在执行`Lua`脚本时，`Redis`是阻塞的。所以一方面`Lua`和`Pipeline`一样，包含的命令都不要太多，另外在`Lua`执行的逻辑中也不要有太耗时的业务逻辑，可能会由于`Lua`脚本逻辑有问题，产生死循环从而导致整个`Redis`服务的不可用。所以`Lua`脚本虽然好用，但是使用不当破坏性也是难以想象的，好哥哥们用这之前还是要确保`Lua`的正确性。

[eval]: /images/20220508/6180ab05a920435780dd2528a8537f09.png
[evalsha]: /images/20220508/402873083be245029eb9e9062c62f036.png