深入理解 Redis Lua 腳本調(diào)試技巧和最佳實(shí)踐
Redis Lua 腳本調(diào)試是一種強(qiáng)大的工具,可以幫助您快速發(fā)現(xiàn)和解決Lua腳本中的問題。它允許您在運(yùn)行腳本時(shí)逐步執(zhí)行腳本,并檢查每個(gè)步驟的結(jié)果。
兩種調(diào)試模式
從Redis 3.2開始,內(nèi)置了 Lua debugger(簡(jiǎn)稱LDB),使用Lua debugger可以很方便的對(duì)我們編寫的Lua腳本進(jìn)行調(diào)試
異步模式 --ldb
開啟 lua dubegger ,將會(huì)進(jìn)入debug命令行。這個(gè)模式下 redis 會(huì) fork 一個(gè)進(jìn)程進(jìn)入隔離環(huán)境,不會(huì)影響 redis 正常提供服務(wù),但調(diào)試期間,原始 redis 執(zhí)行命令、腳本的結(jié)果也不會(huì)體現(xiàn)到 fork 之后的隔離環(huán)境之中
同步模式 --ldb-sync-mode
同步模式,這個(gè)模式下,會(huì)阻塞 redis 上所有的命令、腳本,直到腳本退出,完全模擬了正式環(huán)境使用時(shí)候的情況,使用的時(shí)候務(wù)必注意這點(diǎn)。
參考案例
/data/lua # redis-cli -a 123456 --ldb --eval /data/lua/pong.lua
Warning: Using a password with '-a' or '-u' option on the command line interface may not be safe.
Lua debugging session started, please use:
quit -- End the session.
restart -- Restart the script in debug mode again.
help -- Show Lua script debugging commands.
* Stopped at 1, stop reason = step over
-> 1 local foo = redis.call('ping')
lua debugger>
- -a 123456 Redis 登錄密碼
- --ldb 異步模式
- --eval 運(yùn)行一個(gè)腳本
- help 可以查看更多幫助信息
Lua 腳本
案例1、執(zhí)行一條命令
pong.lua 腳本
local foo = redis.call('ping')
return foo
運(yùn)行截圖
圖片
案例2、攜帶參數(shù)的腳本執(zhí)行
demo1.lua
local src = KEYS[1]
local dst = KEYS[2]
local count = tonumber(ARGV[1])
return true
運(yùn)行截圖
圖片
打印所有的KEYS
lua debugger> print KEYS
<value> {"list_a"; "list_b"; "10"}
打印所有的ARGV
lua debugger> print ARGV
<value> {"10"}
案例3、腳本中執(zhí)行 Redis 命令
demo2.lua
local src = KEYS[1]
local dst = KEYS[2]
local count = tonumber(ARGV[1])
-- 移除 list_a 列表的最后一個(gè)元素,返回值為移除的元素,即:e
local item = redis.call('rpop', src)
-- 將 e 值插入到 list_b 列表表頭部
redis.call('lpush', dst, item)
-- 返回 list_b 列表長(zhǎng)度
return redis.call('llen', dst)
準(zhǔn)備數(shù)據(jù)
圖片
執(zhí)行結(jié)果
圖片
注意:KEYS 和 ARGV 使用 , 逗號(hào)分隔
- r 調(diào)試命令可以 執(zhí)行redis命令,在調(diào)試環(huán)境里
- redis.call("redis command") 函數(shù)執(zhí)行Redis 命令
- print 可以打印腳本中的變量
案例4、腳本中執(zhí)行 Redis 命令
demo3.lua
local src = KEYS[1]
local dst = KEYS[2]
local count = tonumber(ARGV[1])
while count > 0 do
local item = redis.call('rpop', src)
redis.debug("value of item: ",item);
if item ~= false then
redis.call('lpush', dst, item)
end
count = count - 1
end
return redis.call('llen', dst)
- redis.debug() 函數(shù)打印變量信息,配置 c 調(diào)試命令,可以一次性輸出所有值
- restart 修改lua腳本后,執(zhí)行該命令可以重新開始調(diào)試
- quit可以退出調(diào)試模式
圖片
如果移除代碼 count = count - 1 ,則會(huì)進(jìn)入系循環(huán)
案例5、多個(gè)命令執(zhí)行
demo4.lua
local src = KEYS[1]
local dst = KEYS[2]
local count = tonumber(ARGV[1])
while count > 0 do
local username = redis.call('get',src)
redis.debug('username : ',username)
local age = redis.call('get',dst)
redis.debug('age : ',age)
count = count - 1
end
- 使用 w(whole) 命令,顯示所有代碼,看看需要在哪一行打斷點(diǎn)
圖片
- 例如要在第7行打斷點(diǎn),則需要輸入 b 7
lua debugger> b 7
6 local username = redis.call('get',src)
#7 redis.debug('username : ',username)
8 local age = redis.call('get',dst)
- 查看所有斷點(diǎn),輸入命令:b
圖片
- 我們需要直接運(yùn)行到打斷點(diǎn)的地方,則需要輸入:c 命令,會(huì)直接跳轉(zhuǎn)到打第一個(gè)斷點(diǎn)的語句,這時(shí)候可以打印斷點(diǎn)之前的 變量,以下可以看出運(yùn)行結(jié)果:
圖片
- 命令 b 0 刪除所有斷點(diǎn)(這里刪除后,再第9行我們?cè)诖騻€(gè)斷點(diǎn)),再次輸入 b,發(fā)現(xiàn)已經(jīng)沒有斷點(diǎn)。并且斷點(diǎn)后面的值沒法打印,只能打斷點(diǎn)之前的變量
圖片
- 第 9 行打斷點(diǎn)(b 9 ),查看所有代碼,第9行已經(jīng)被打傷斷點(diǎn)了
圖片
- 再次跳轉(zhuǎn)(c 命令)到打斷點(diǎn)的地方。再次打印變量,發(fā)現(xiàn)已經(jīng)可以打印了
圖片
- print 打印所有變量
圖片
案例6、Redis lua 版本和函數(shù)
Redis Lua腳本是 5.1.5
-- Copyright (C) ShaoBo Wan (Tinywan)
local KEYS1 = KEYS[1]
local KEYS2 = KEYS[2]
local ARGV1 = ARGV[1]
local ARGV2 = ARGV[2]
local ARGV3 = ARGV[3]
local ARGV4 = ARGV[4]
local status, type = next(redis.call('TYPE', KEYS[1])) -- type=none status=ok
if status ~= nil and status == 'ok' then
if type == 'zset' then
-- list = {"10090"; "10089"; "10088"; "10087"; "10086"}
local list = redis.call('ZREVRANGEBYSCORE', KEYS[1], ARGV[1], ARGV[2], 'LIMIT', ARGV[3], ARGV[4])
-- 獲取數(shù)組table長(zhǎng)度:#list
local kk = #list
-- unpack它接受一個(gè)數(shù)組(table)作為參數(shù),并默認(rèn)從下標(biāo)1開始返回?cái)?shù)組的所有元素
local k1, k2, k3, k4 ,k5 = unpack(list)
redis.debug('k1 ', k1) -- 10090
redis.debug('k2 ', k2) -- 10089
redis.debug('k3 ', k3) -- 10088
redis.debug('k4 ', k4) -- 10087
redis.debug('k5 ', k5) -- 10087
if list ~= nil and #list > 0 then
-- ZREM key member [member ...]
redis.call('ZREM', KEYS[1], unpack(list)) -- unpack(list) 返回過期數(shù)組的所有元素
-- HMGET key field [field ...]
local result = redis.call('HMGET', KEYS[2], unpack(list)) -- ["username:Tinywan,age:24"]
-- HDEL key field [field ...]
redis.call('HDEL', KEYS[2], unpack(list)) -- 1
return result
end
end
end
return nil
- next() 函數(shù):第一個(gè)值返回函數(shù)是否執(zhí)行成功(ok),第二個(gè)值返回執(zhí)行結(jié)果(對(duì)應(yīng)的值)>
如果該key不存在,則返回none
如果該key存在,則返回該key數(shù)據(jù)結(jié)構(gòu)類型,如上返回 zset,表示有序集合。
- unpack() 函數(shù):unpack它接受一個(gè)數(shù)組(table)作為參數(shù),并默認(rèn)從下標(biāo)1開始返回?cái)?shù)組的所有元素
- 移除有序集中的一個(gè)或多個(gè)成員 ZREM key member [member ...]
- 獲取多個(gè)字段的hash值數(shù)組HMGET key field [field ...]
- 刪除hash值的key HDEL key field [field ...]
圖片
- b 27 ,b 28 打兩個(gè)端點(diǎn)
- c 命令直接到第一個(gè)端點(diǎn)(b 26)
- p 打印之前所有的變量
重要: 以上消費(fèi)者腳本會(huì)直接刪除有序集合key和所對(duì)應(yīng)的哈希值。所以為了消息的可靠性。通過以上腳本返回的值會(huì)存儲(chǔ)在一個(gè)stream流中,如果在stream消費(fèi)失敗(沒有進(jìn)行ACK機(jī)制),則會(huì)進(jìn)入待辦Pending隊(duì)列重復(fù)消費(fèi)(知道ACK機(jī)制或者刪除該消息隊(duì)列)