在Redis的高级特性中,Lua脚本为复杂操作提供了原子性执行的能力。通过EVAL命令,我们可以在Redis服务器端直接运行Lua脚本,将多个命令封装为一个原子操作,大幅提升复杂业务场景的效率与可靠性。本章将系统解析EVAL命令的用法、Lua脚本与Redis的交互逻辑,以及脚本执行的核心特性。
一、EVAL命令基础:语法与参数解析
EVAL命令是执行Lua脚本的入口,其核心作用是在Redis服务器中运行指定的Lua代码,并返回执行结果。其基本语法如下:
EVAL script numkeys key [key ...] arg [arg ...]
关键参数说明:
- script:Lua 5.1脚本字符串,包含要执行的逻辑(无需定义为Lua函数)。
- numkeys:指定后续参数中“键名参数”的数量(非负整数),用于区分键和附加参数。
- key [key ...]:键名参数,在脚本中通过KEYS数组访问(KEYS[1]、KEYS[2],以1为基址)。
- arg [arg ...]:附加参数,在脚本中通过ARGV数组访问(ARGV[1]、ARGV[2])。
示例:传递键与参数
# 脚本返回键名参数和附加参数
EVAL "return {KEYS[1], KEYS[2], ARGV[1], ARGV[2]}" 2 user:1 post:100 "hello" "world"
# 结果:1) "user:1" 2) "post:100" 3) "hello" 4) "world"
为什么要严格区分键名参数和附加参数?
Redis需要分析脚本中操作的键,以确保集群模式下请求能路由到正确的节点。所有脚本中用到的键必须通过KEYS数组传递,否则脚本无法兼容集群环境(尽管单实例中可以“滥用”,但不推荐)。
二、Lua脚本与Redis命令的交互:call与pcall函数
在Lua脚本中,通过redis.call()或redis.pcall()函数执行Redis命令,二者的核心区别在于错误处理机制:
函数 | 错误处理方式 | 适用场景 |
redis.call() | 执行出错时抛出异常,终止脚本执行,并将错误返回给EVAL调用者 | 需要立即感知错误的场景 |
redis.pcall() | 执行出错时捕获异常,返回包含错误信息的Lua表({err="错误信息"}),脚本可继续执行 | 需要容错处理的复杂逻辑 |
示例:调用Redis命令
# 使用call设置键值对(正确用法:键通过KEYS传递)
EVAL "return redis.call('set', KEYS[1], ARGV[1])" 1 foo "bar"
# 结果:OK
# 使用pcall处理错误(如对字符串键执行列表操作)
EVAL "return redis.pcall('lpush', KEYS[1], 'a')" 1 foo
# 结果:{err="WRONGTYPE Operation against a key holding the wrong kind of value"}
三、数据类型转换:Lua与Redis的“翻译规则”
Lua脚本与Redis之间的数据传递需要经过类型转换,确保双方能正确解析对方的数据。转换规则是双向的,且保证“ round-trip ”一致性(Redis类型→Lua类型→Redis类型后与原始值相同)。
1. Redis类型→Lua类型转换
Redis返回类型 | 转换后的Lua类型 | 示例 |
整数回复(integer) | Lua数字(number) | 100 → 100 |
批量回复(bulk) | Lua字符串(string) | "hello" → "hello" |
多批量回复(multi bulk) | Lua表(array) | ["a", "b"] → {"a", "b"} |
状态回复(status) | 含ok字段的Lua表 | OK → {ok = "OK"} |
错误回复(error) | 含err字段的Lua表 | ERR wrong type → {err = "ERR wrong type"} |
空回复(nil bulk/multi bulk) | Lua布尔值false | nil → false |
2. Lua类型→Redis类型转换
Lua类型 | 转换后的Redis类型 | 示例 |
数字(number) | 整数回复(小数会被截断为整数) | 3.9 → 3 |
字符串(string) | 批量回复 | "foo" → "foo" |
表(array) | 多批量回复(遇到nil则截断) | {1, 2, nil, 3} → [1, 2] |
含ok字段的表 | 状态回复 | {ok = "done"} → done |
含err字段的表 | 错误回复 | {err = "fail"} → ERR fail |
布尔值false | 空批量回复 | false → (nil) |
布尔值true | 整数回复1 | true → 1 |
示例:复杂类型转换
# Lua表转换为Redis多批量回复
EVAL "return {1, 'hello', {3, 'world'}}" 0
# 结果:
# 1) (integer) 1
# 2) "hello"
# 3) 1) (integer) 3
# 2) "world"
四、脚本的原子性:不可打断的执行保障
Redis保证Lua脚本的原子性执行:在脚本运行期间,服务器不会执行其他任何命令(包括其他脚本或客户端命令)。这种特性与MULTI/EXEC事务类似,但粒度更细——整个脚本作为一个不可分割的单元执行,从其他客户端视角看,脚本的效果要么完全未发生,要么已全部完成。
原子性的价值:
- 避免并发修改导致的数据不一致(如库存扣减时的竞态条件)。
- 减少多命令执行时的网络往返(将“读-计算-写”逻辑封装在脚本中,一次调用完成)。
注意:原子性意味着慢脚本会阻塞整个Redis服务。因此,脚本应尽量简洁,避免包含复杂循环或耗时计算(默认超时时间为5秒,可通过lua-time-limit配置修改)。
五、EVALSHA:优化脚本传输的带宽消耗
EVAL命令每次执行都需要发送完整的脚本内容,若脚本较长或调用频繁,会浪费带宽。EVALSHA命令通过脚本的SHA1哈希值调用已缓存的脚本,解决了这一问题。
工作流程:
- 脚本首次执行时,Redis会计算其SHA1哈希并缓存(永久有效,除非执行SCRIPT FLUSH)。
- 后续调用可使用EVALSHA sha1 numkeys ...,直接通过哈希值执行脚本。
- 若哈希不存在(如脚本未缓存或已被清除),返回NOSCRIPT错误,需重新使用EVAL发送脚本。
示例:
# 首次执行脚本,获取哈希
EVAL "return redis.call('get', KEYS[1])" 1 foo
# 结果:"bar"(假设foo的值为bar)
# 计算脚本的SHA1(可通过客户端工具或SCRIPT LOAD获取)
SCRIPT LOAD "return redis.call('get', KEYS[1])"
# 结果:"a42059b356c875801a65a371279c992212c22a3"
# 使用EVALSHA调用
EVALSHA a42059b356c875801a65a371279c992212c22a3 1 foo
# 结果:"bar"
客户端最佳实践:
客户端可默认使用EVALSHA,若收到NOSCRIPT错误则回退到EVAL,兼顾效率与可靠性。
六、脚本缓存与管理:SCRIPT命令家族
Redis提供了一组SCRIPT命令,用于管理服务器端的脚本缓存:
命令语法 | 描述 | 示例 |
SCRIPT FLUSH | 清空所有缓存的脚本 | SCRIPT FLUSH → OK |
SCRIPT EXISTS sha1 [sha1...] | 检查指定哈希的脚本是否存在 | SCRIPT EXISTS a42059b3 → 1(存在) |
SCRIPT LOAD script | 预加载脚本到缓存(不执行) | SCRIPT LOAD "return 1" → 哈希值 |
SCRIPT KILL | 终止正在执行的只读脚本(未修改数据) | 用于终止超时的慢脚本 |
脚本缓存的持久性:
- 脚本缓存仅存在于内存中,服务器重启后会清空(需重新加载)。
- 除非执行SCRIPT FLUSH,否则缓存的脚本会永久保留(即使长期未使用)。
七、脚本复制:保证主从数据一致性
Redis需要确保主从节点的脚本执行结果一致,为此提供了两种复制方式(Redis 5+默认使用第二种):
1. 全脚本复制(旧模式)
- 主节点将完整脚本发送到从节点和AOF文件。
- 从节点通过执行相同的脚本保证数据一致。
- 要求:脚本必须是“纯函数”——相同输入下始终产生相同的写命令(不能依赖随机数、系统时间等非确定性因素)。
2. 命令复制(新模式,Redis 5+默认)
- 主节点执行脚本时,记录所有修改数据的命令(如set、lpush)。
- 脚本执行完毕后,将这些命令封装为MULTI/EXEC事务,发送到从节点和AOF。
- 优势:无需脚本是纯函数,支持使用随机数、时间等(如生成验证码的脚本)。
手动切换模式:
在脚本中调用redis.replicate_commands()可强制启用命令复制(Redis 3.2+支持)。
八、使用注意事项与最佳实践
- 键名必须通过KEYS传递
所有脚本中操作的键必须放在KEYS数组中,确保Redis集群能正确路由请求(否则脚本无法在集群模式下工作)。 - 避免全局变量
Lua脚本中禁止创建全局变量(会导致脚本执行失败),需用local声明局部变量:
-- 错误:创建全局变量a
a = 10
-- 正确:局部变量
local a = 10
- 处理超时脚本
若脚本执行超时(超过lua-time-limit),Redis会允许其他客户端执行SCRIPT KILL(仅对只读脚本有效)或SHUTDOWN NOSAVE(终止服务器,不保存数据)。 - 利用内置库扩展能力
Redis的Lua环境内置了多个实用库,可直接使用:
- cjson:JSON序列化/反序列化(如cjson.encode({foo="bar"}))。
- bitop:位运算(如bit.bor(1, 2)计算按位或)。
- redis.sha1hex:计算字符串的SHA1哈希。
九、总结:Lua脚本的适用场景
EVAL与Lua脚本为Redis提供了强大的复杂逻辑处理能力,尤其适合以下场景:
- 需原子性执行的多步操作(如库存扣减、分布式锁)。
- 减少网络往返的“读-计算-写”逻辑(如排行榜实时更新)。
- 自定义命令(通过脚本封装业务逻辑,简化客户端代码)。
合理使用Lua脚本,既能发挥Redis的高性能,又能保证复杂业务的可靠性,但需牢记:脚本的简洁性与执行效率是不可忽视的原则。