Redis 与缓存 / 系统课时
编写第一个 Lua 脚本
编写第一个 Lua 脚本
本课完成第一个可执行的 Redis Lua 脚本,重点掌握 EVAL 的参数划分、KEYS 与 ARGV 的用法,以及如何从脚本返回 Redis 命令结果,为下一课的多步原子操作打好基础。
学习目标
- 理解
EVAL的脚本、键数量和参数顺序 - 在 Lua 中通过
redis.call执行 Redis 命令 - 正确传入业务键并读取脚本返回值
理解 EVAL 参数
EVAL 的格式为 EVAL script numkeys key [key ...] arg [arg ...]。numkeys 指定后续有多少个参数属于业务键,这部分进入 KEYS;剩余参数进入 ARGV。两个数组都从下标 1 开始。
业务键应通过 KEYS 显式传入,不要把运行时键名直接写死在脚本中。这样既能复用脚本,也便于 Redis Cluster 判断脚本访问的槽位。
编写并执行脚本
下面的脚本把 ARGV[1] 转为数字,再调用 INCRBY 修改 KEYS[1]。这个场景本身直接使用 INCRBY 更简单,这里用它演示完整的 Lua 调用结构。
redis-cli DEL stats:page-views
redis-cli EVAL "local delta=tonumber(ARGV[1]); if not delta then return redis.error_reply('INVALID_DELTA') end; return redis.call('INCRBY',KEYS[1],delta)" 1 stats:page-views 3
redis-cli GET stats:page-views预期输出:
(integer) <DELETED_KEY_COUNT>
(integer) 3
"3"<DELETED_KEY_COUNT> 取决于执行前键是否存在。命令中的 1 表示只有一个键,因此 stats:page-views 对应 KEYS[1],数字 3 对应 ARGV[1]。脚本最后返回 INCRBY 的整数结果。
错误与返回值
tonumber 转换失败时,脚本返回 INVALID_DELTA 错误,不会执行写入。redis.call 遇到 Redis 命令错误会终止脚本;需要把错误当作普通返回值处理时,可使用 redis.pcall,再由脚本自行判断结果。
Lua 返回的数字、字符串、数组、空值和错误会被 Redis 协议转换为客户端可识别的结果。不同客户端库可能映射为不同语言类型,应用应按驱动文档读取。
关键边界
Lua 脚本执行期间会占用 Redis 主线程,应避免大循环、海量键扫描和复杂计算。脚本不能访问网络或本地文件;在集群环境中,一次脚本访问的多个键必须位于同一哈希槽。
本例只用于学习语法,没有必要用 Lua 替代单条 INCRBY。Lua 的真正价值,是把读取、条件判断和多条修改合并为一次不可插入的服务器端操作。