Lua 脚本详解

最新推荐文章于 2025-02-11 10:34:34 发布

飞滕人生TYF

最新推荐文章于 2025-02-11 10:34:34 发布

阅读量1.1k

点赞数 16

分类专栏： java 文章标签： lua 脚本

本文链接：https://blog.youkuaiyun.com/T_Y_F_/article/details/144239028

版权

java 专栏收录该内容

210 篇文章

订阅专栏

Lua 脚本详解

Lua 是一种轻量级、高效、嵌入式的脚本语言，被 Redis 集成用于执行原子性操作和复杂逻辑。通过 Redis 的 Lua 脚本，可以将多条 Redis 命令组合成一个脚本，确保这些命令在执行过程中不会被其他请求中断，从而保证了操作的原子性。

1. 为什么使用 Lua 脚本

原子性：
- Redis 中的 Lua 脚本是以单线程方式执行的，脚本内的命令要么全部执行成功，要么全部失败，保证操作的原子性。
性能高效：
- 避免了客户端与 Redis 之间的频繁通信，将多条 Redis 命令一次性发送到服务器执行，减少了网络延迟。
复杂逻辑处理：
- 可以在脚本中编写条件判断、循环等复杂逻辑，而这些逻辑无法通过单条 Redis 命令实现。
复用代码：
- 通过脚本可以封装常用的复杂操作，提高代码的可读性和复用性。

2. Lua 脚本的基本使用

Redis 提供了两个主要命令用于执行 Lua 脚本：

EVAL：直接执行 Lua 脚本。
EVALSHA：通过脚本的 SHA1 哈希值执行已缓存的脚本。

2.1 EVAL 命令

语法：

EVAL script numkeys key1 [key2 ...] arg1 [arg2 ...]

script：Lua 脚本内容。
numkeys：指定脚本中使用的 Redis 键的数量。
key1, key2...：脚本中涉及的 Redis 键。
arg1, arg2...：其他参数。

2.2 示例

示例 1：简单加法

使用 Lua 脚本实现两个数的加法。

EVAL "return ARGV[1] + ARGV[2]" 0 3 5

ARGV[1] 和 ARGV[2] 是脚本的参数，结果返回 8。

示例 2：操作 Redis 键值

向 Redis 中写入键值，并返回其长度。

EVAL "redis.call('SET', KEYS[1], ARGV[1]); return redis.call('STRLEN', KEYS[1])" 1 mykey myvalue

KEYS[1] 是 Redis 键名（mykey）。
ARGV[1] 是 Redis 键值（myvalue）。
执行结果返回 8（字符串长度）。

2.3 EVALSHA 命令

为了避免重复传输同一脚本，可以先将脚本的 SHA1 哈希值缓存起来，后续通过哈希值直接执行。

获取脚本的 SHA1 哈希值：
```
SCRIPT LOAD "return ARGV[1] + ARGV[2]"
```
返回值为脚本的哈希值，例如：b2a1c65d8a358db9f4311841cba735f474c1ee2e。

使用 EVALSHA 执行脚本：

EVALSHA b2a1c65d8a358db9f4311841cba735f474c1ee2e 0 3 5

返回值同样为 8。

3. Lua 脚本常用函数

在 Lua 脚本中，可以使用以下两种函数与 Redis 交互：

redis.call：
- 用于执行 Redis 命令，返回执行结果。
- 如果命令失败，会中断脚本执行。
redis.pcall：
- 与 redis.call 类似，但如果命令失败，会捕获错误，而不会中断脚本。

3.1 常用函数示例

获取键值

return redis.call("GET", KEYS[1])

设置键值

redis.call("SET", KEYS[1], ARGV[1])

检查键是否存在

if redis.call("EXISTS", KEYS[1]) == 1 then
    return "Key exists"
else
    return "Key does not exist"
end

删除键

redis.call("DEL", KEYS[1])

错误捕获

local res, err = redis.pcall("GET", KEYS[1])
if not res then
    return "Error: " .. err
end
return res

4. Lua 脚本中的变量

KEYS：
- 包含所有传入的 Redis 键。
- 索引从 1 开始，例如 KEYS[1] 表示第一个键。
ARGV：
- 包含所有传入的附加参数。
- 索引从 1 开始，例如 ARGV[1] 表示第一个参数。

变量使用示例

EVAL "return KEYS[1] .. ARGV[1]" 1 key1 value1

输出结果：key1value1。

5. Lua 脚本应用场景

5.1 分布式锁

获取锁：

if redis.call("SETNX", KEYS[1], ARGV[1]) == 1 then
    redis.call("EXPIRE", KEYS[1], ARGV[2])
    return 1
else
    return 0
end

释放锁：

if redis.call("GET", KEYS[1]) == ARGV[1] then
    return redis.call("DEL", KEYS[1])
else
    return 0
end

5.2 限流器

实现基于固定窗口的限流器：

local current = redis.call("GET", KEYS[1])
if current and tonumber(current) >= tonumber(ARGV[1]) then
    return 0
else
    redis.call("INCR", KEYS[1])
    redis.call("EXPIRE", KEYS[1], ARGV[2])
    return 1
end

5.3 缓存击穿保护

当缓存失效时，防止多个请求同时重建缓存：

if redis.call("EXISTS", KEYS[1]) == 0 then
    local is_locked = redis.call("SETNX", KEYS[2], 1)
    if is_locked == 1 then
        redis.call("EXPIRE", KEYS[2], ARGV[1])
        return 1  -- 表示成功获取重建锁
    else
        return 0  -- 表示其他线程正在重建
    end
else
    return -1  -- 缓存未失效
end