redis中l(wèi)ua腳本使用教程

更新時間：2021年10月28日 09:34:49 作者：huan1993

在使用redis的過程中，發(fā)現(xiàn)有些時候需要原子性去操作redis命令，而redis的lua腳本正好可以實(shí)現(xiàn)這一功能。這篇文章主要介紹了redis中l(wèi)ua腳本的簡單使用,需要的朋友可以參考下

一、背景

在使用redis的過程中，發(fā)現(xiàn)有些時候需要原子性去操作redis命令，而redis的lua腳本正好可以實(shí)現(xiàn)這一功能。比如：扣減庫存操作、限流操作等等。
redis的pipelining雖然也可以一次執(zhí)行一組命令，但是如果在這一組命令的執(zhí)行過程中，需要根據(jù)上一步執(zhí)行的結(jié)果做一些判斷，則無法實(shí)現(xiàn)。

二、使用lua腳本

Redis中使用的是 Lua 5.1 的腳本規(guī)范，同時我們編寫的腳本的時候，不需要定義 Lua 函數(shù)。同時也不能使用全局變量等等。

1、lua腳本的格式和注意事項(xiàng)

1、格式

EVAL script numkeys key [key ...] arg [arg ...]

127.0.0.1:6379> eval "return {KEYS[1],ARGV[1],ARGV[2]}" 1 key1 arg1 arg2
1) "key1"
2) "arg1"
3) "arg2"
127.0.0.1:6379>

2、注意事項(xiàng)

Lua腳本中的redis操作的key最好都是通過 KEYS來傳遞，而不要寫死。否則在Redis Cluster的情況下可能有問題.

1、好的寫法

127.0.0.1:6379> eval "return redis.call('set',KEYS[1],'zhangsan')" 1 username
OK
127.0.0.1:6379> get username
"zhangsan"

redis命令操作的key是通過KEYS獲取的。

2、差的寫法

127.0.0.1:6379> eval "return redis.call('set','username','zhangsan')" 0
OK
127.0.0.1:6379> get username
"zhangsan"

redis命令操作的key是直接寫死的。

2、將腳本加載到redis中

需求：此處定義一個lua腳本，將輸入的參數(shù)的值+1返回。

注意：

當(dāng)我們把 lua腳本加載到redis中，這個腳本并不會馬上執(zhí)行，而是會緩存起來，并且返回sha1校驗(yàn)和，后期我們可以通過 EVALSHA 來執(zhí)行這個腳本。

此處我們記住這個腳本加載后返回的hash值，在下一步執(zhí)行的時候需要用到。

127.0.0.1:6379> script load "return tonumber(KEYS[1])+1"
"ef424d378d47e7a8b725259cb717d90a4b12a0de"
127.0.0.1:6379>

3、執(zhí)行l(wèi)ua腳本

1、通過eval執(zhí)行

127.0.0.1:6379> eval "return tonumber(KEYS[1]) + 1" 1 100
(integer) 101
127.0.0.1:6379>

2、通過evalsha執(zhí)行

ef424d378d47e7a8b725259cb717d90a4b12a0de的值為上一步通過 script load加載腳本后獲取的。

127.0.0.1:6379> evalsha ef424d378d47e7a8b725259cb717d90a4b12a0de 1 100
(integer) 101
127.0.0.1:6379>

通過 evalsha 執(zhí)行的好處是可以節(jié)省帶寬。如果我們的lua腳本比較長，程序在執(zhí)行的時候?qū)ua腳本發(fā)送到redis服務(wù)器則可能耗費(fèi)的帶寬多，如果發(fā)送的是hash值的話，則耗費(fèi)的帶寬少。

4、判斷腳本是否在redis服務(wù)器緩存中

127.0.0.1:6379> script load "return tonumber(KEYS[1])+1"
"ef424d378d47e7a8b725259cb717d90a4b12a0de"
127.0.0.1:6379> script exists ef424d378d47e7a8b725259cb717d90a4b12a0de
1) (integer) 1
127.0.0.1:6379> script exists not-exists-sha1
1) (integer) 0
127.0.0.1:6379>

5、清空服務(wù)器上的腳本緩存

注意：
我們無法清除某一個腳本的緩存，只可以清楚所有的緩存，一般情況下沒有必要清楚，因?yàn)榧词褂写罅康哪_本也不會太占用服務(wù)器內(nèi)存。

127.0.0.1:6379> script load "return tonumber(KEYS[1])+1"
"ef424d378d47e7a8b725259cb717d90a4b12a0de"
127.0.0.1:6379> script exists ef424d378d47e7a8b725259cb717d90a4b12a0de
1) (integer) 1
127.0.0.1:6379> script flush
OK
127.0.0.1:6379> script exists ef424d378d47e7a8b725259cb717d90a4b12a0de
1) (integer) 0

6、殺死正在運(yùn)行的腳本

127.0.0.1:6379> script kill

注意：

該命令只可以殺死正在運(yùn)行的 只讀腳本。
對于修改了數(shù)據(jù)的腳本，無法使用此命令殺死，只能使用 shutdown nosave命令。
腳本執(zhí)行的默認(rèn)超時時間為 5分鐘，可以通過redis.conf配置文件的lua-time-limit配置項(xiàng)修改。
腳本即使到達(dá)了超時時間，也不會停止執(zhí)行，因?yàn)檫@違反了lua腳本的原子性。

三、lua和redis數(shù)據(jù)類型轉(zhuǎn)換

Lua的數(shù)據(jù)類型和Redis的數(shù)據(jù)類型存在一對一的轉(zhuǎn)換關(guān)系，如果將Redis類型轉(zhuǎn)換成Lua類型，然后在轉(zhuǎn)換成Redis類型，那么結(jié)果和初試值是一致的。

1、類型轉(zhuǎn)換

Redis to Luaconversion table.

Redis integer reply -> Lua number
Redis bulk reply -> Lua string
Redis multi bulk reply -> Lua table (may have other Redis data types nested)
Redis status reply -> Lua table with a single ok field containing the status
Redis error reply -> Lua table with a single err field containing the error
Redis Nil bulk reply and Nil multi bulk reply -> Lua false boolean type

Lua to Redisconversion table.

Lua number -> Redis integer reply (the number is converted into an integer)
Lua string -> Redis bulk reply
Lua table (array) -> Redis multi bulk reply (truncated to the first nil inside the Lua array if any)
Lua table with a single ok field -> Redis status reply
Lua table with a single err field -> Redis error reply
Lua boolean false -> Redis Nil bulk reply.

2、額外的轉(zhuǎn)換規(guī)則

Lua的布爾類型，Lua的True會轉(zhuǎn)換成Redis的1

3、3個重要規(guī)則

1. 數(shù)字類型

在Lua中，只有一個number類型，整數(shù)和浮點(diǎn)數(shù)之間沒有區(qū)別，如果我們在Lua中返回一個浮點(diǎn)數(shù)，實(shí)際返回的是一個整數(shù)，如果要返回浮點(diǎn)數(shù)，需要以字符串的方式返回。

127.0.0.1:6379> eval "return 3.98" 0
(integer) 3
127.0.0.1:6379> eval "return '3.98'" 0
"3.98"

2. lua數(shù)組存在nil

當(dāng) Redis 將 Lua 數(shù)組轉(zhuǎn)換為 Redis 協(xié)議時，如果遇到 nil，則轉(zhuǎn)換會停止。即 nil 后的值都不會返回。

127.0.0.1:6379> eval "return {1,2,'data',nil,'can not return value','vv'}" 0
1) (integer) 1
2) (integer) 2
3) "data"
127.0.0.1:6379>

3. Lua的Table類型包含建和值

出現(xiàn)這種情況返回的redis的是一個空數(shù)組

127.0.0.1:6379> eval "return {key1 ='value1',key2='value2'}" 0
(empty array)
127.0.0.1:6379>

四、lua腳本中輸出日志

這個一般調(diào)試我們的腳本的時候比較有用。

redis.log(loglevel,message)

loglevel的取值范圍：

redis.LOG_DEBUG
redis.LOG_VERBOSE
redis.LOG_NOTICE
redis.LOG_WARNING

舉例：

五、一個簡單限流的案例

1、需求

在 1s 之內(nèi)，方法最大的并發(fā)只能是 5。

1s 和 5 當(dāng)作參數(shù)傳遞。

2、實(shí)現(xiàn)步驟

1、編寫lua腳本

-- 輸出用戶傳遞進(jìn)來的參數(shù)
for i, v in pairs(KEYS) do
    redis.log(redis.LOG_NOTICE, "limit: key" .. i .. " = " .. v)
end
for i, v in pairs(ARGV) do
    redis.log(redis.LOG_NOTICE, "limit: argv" .. i .. " = " .. v)
end

-- 限流的key
local limitKey = tostring(KEYS[1])
-- 限流的次數(shù)
local limit = tonumber(ARGV[1])
-- 多長時間過期
local expireMs = tonumber(ARGV[2])

-- 當(dāng)前已經(jīng)執(zhí)行的次數(shù)
local current = tonumber(redis.call('get', limitKey) or '0')

-- 設(shè)置一個斷點(diǎn)
redis.breakpoint()

redis.log(redis.LOG_NOTICE, "limit key: " .. tostring(limitKey) .. " 在[" .. tostring(expireMs) .. "]ms內(nèi)已經(jīng)訪問了 " .. tostring(current) .. " 次,最多可以訪問: " .. limit .. " 次")

-- 限流了
if (current + 1 > limit) then
    return { true }
end

-- 未達(dá)到訪問限制
-- 訪問次數(shù)+1
redis.call("incrby", limitKey, "1")
if (current == 0) then
    -- 設(shè)置過期時間
    redis.call("pexpire", limitKey, expireMs)
end

return { false }

2、程序中執(zhí)行l(wèi)ua腳本

完整代碼: https://gitee.com/huan1993/spring-cloud-parent/tree/master/springboot/springboot-redis-lua

六、lua腳本的debug

當(dāng)我們編寫好了lua腳本后，如果在執(zhí)行的過程中發(fā)生了錯誤，那么我們?nèi)绾卧撊绾谓鉀Q呢？此處我們來了解下如何debug lua 腳本。

1、lua腳本中的幾個小命令

在腳本中打一個斷點(diǎn)

redis.breakpoint()

2、斷點(diǎn)調(diào)試

1、執(zhí)行命令

redis-cli --ldb --eval limit.lua invoked , 1 1000

limit.lua 需要debug的lua文件
invoked 為傳遞到 lua 腳本中 KEYS 的值
1 和 1000 為傳遞到 lua 腳本中 ARGV 的值

, 分割 出 KEYS 和 ARGV 的值

2、一些debug指令