前言

Redis自2.6.0版本開始內建Lua直譯器。

Lua，輕量級指令碼語言，號稱最快的指令碼語言。

兩者結合將爆發出巨大的威力。

簡介

Redis Lua指令碼可以呼叫原生的Redis命令，也可以包含自定義的控制流、邏輯運算、數學運算等，將複雜的業務邏輯封裝起來，形成一個原子事務。

這些特性使我們可以自由地擴充套件Redis，封裝“自定義命令”。

與MULTI+EXEC對比

使用MULTI+EXEC及相關組合命令，也可以將多個命令封裝成事務，但靈活性不如Lua指令碼。

除此之外，MULTI+EXEC需要多次向Redis server傳送事務命令，每次傳送都會有RTT(Round Trip Time)消耗，效能低於Lua指令碼。

Redis Lua Scripts Debugger (LDB)

Redis自3.2版本開始包含LDB，用於除錯Lua指令碼。

LDB支援設定斷點，逐行執行等。

一個簡單的例子

執行set命令，並設定新的ttl

編寫Lua指令碼，檔名為set_ttl.lua

local set_msg = false
-- 執行redis命令的返回結果被封裝成了table，形如{'ok':'OK'}
local key_type = redis.call('TYPE' , KEYS[1])['ok']
-- key的資料型別為string或key不存在時，繼續執行
if key_type == 'string' or key_type == 'none' then
    local ttl = tonumber(ARGV[2])
    set_msg = redis.call('SET', KEYS[1], ARGV[1], 'EX', ttl)['ok']
end
return set_msg  -- 正常情況下會返回"OK"

 

除錯Lua指令碼

命令如下

$ redis-cli --ldb --eval set_ttl.lua fruit , apple 100

其中，set_ttl.lua為指令碼名稱， 逗號前的引數放入變數KEYS，逗號後的引數放入變數ARGV，多個變數用空格隔開。

除錯輸出如下，預設情況下，LDB將執行指令碼第一行並停住。 輸入n並回車，執行下一行，重複直到指令碼執行結束。

從除錯輸出的最後部分可以看出

• 指令碼返回了"OK"。
• 除錯修改的資料集被回滾了，除錯並不會真的修改資料庫

$ redis-cli --ldb --eval set_ttl.lua fruit , apple 100
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 set_msg = false
lua debugger> n
* Stopped at 3, stop reason = step over
-> 3   local key_type = redis.call('TYPE' , KEYS[1])['ok']
lua debugger> n
<redis> TYPE fruit
<reply> "+none"
* Stopped at 5, stop reason = step over
-> 5   if key_type == 'string' or key_type == 'none' then
lua debugger> n
* Stopped at 6, stop reason = step over
-> 6       local ttl = tonumber(ARGV[2])
lua debugger> n
* Stopped at 7, stop reason = step over
-> 7       set_msg = redis.call('SET', KEYS[1], ARGV[1], 'EX', ttl)['ok']
lua debugger> n
<redis> SET fruit apple EX 100
<reply> "+OK"
* Stopped at 9, stop reason = step over
-> 9   return set_msg  -- 正常情況下會返回"OK"
lua debugger> n

"OK"

(Lua debugging session ended -- dataset changes rolled back)

 

一個複雜的例子

批量獲取並更新hash型別的key，做必要的型別檢查，獲取key的ttl，最終返回每個key的執行結果

編寫lua指令碼，檔名getset_hash.lua

local results = {}
for index , key in ipairs(KEYS) do
    local old_value = false
    local mset_msg = false
    local ttl = false
    local key_type = redis.call('TYPE' , key)['ok']
    if key_type == 'hash' then
        old_value = redis.call('HMGET' , key , ARGV[1], ARGV[2])
        ttl = redis.call('TTL', key)
    end
    if key_type == 'hash' or key_type == 'none' then
        mset_msg = redis.call('HMSET' , key , ARGV[1], ARGV[3], ARGV[2], ARGV[4])['ok']
    end
    results[index] = { key, old_value, ttl, mset_msg }
end
return results

除錯輸出

$ redis-cli --ldb --eval getset_hash.lua person1 person2 , name age Alice 22
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 results = {}
lua debugger> n
* Stopped at 2, stop reason = step over
-> 2   for index , key in ipairs(KEYS) do
lua debugger> n
* Stopped at 3, stop reason = step over
-> 3       local old_value = false
lua debugger> n
* Stopped at 4, stop reason = step over
-> 4       local mset_msg = false
lua debugger> n
* Stopped at 5, stop reason = step over
-> 5       local ttl = false
lua debugger> n
* Stopped at 6, stop reason = step over
-> 6       local key_type = redis.call('TYPE' , key)['ok']
lua debugger> n
<redis> TYPE person1
<reply> "+none"
* Stopped at 7, stop reason = step over
-> 7       if key_type == 'hash' then
lua debugger> n
* Stopped at 11, stop reason = step over
-> 11      if key_type == 'hash' or key_type == 'none' then
lua debugger> n
* Stopped at 12, stop reason = step over
-> 12          mset_msg = redis.call('HMSET' , key , ARGV[1], ARGV[3], ARGV[2], ARGV[4])['ok']
lua debugger> n
<redis> HMSET person1 name Alice age 22
<reply> "+OK"
* Stopped at 14, stop reason = step over
-> 14      results[index] = { key, old_value, ttl, mset_msg }

# 略去迴圈執行的輸出

-> 16  return results
lua debugger> n

1) 1) "person1"
   2) (nil)
   3) (nil)
   4) "OK"
2) 1) "person2"
   2) (nil)
   3) (nil)
   4) "OK"

(Lua debugging session ended -- dataset changes rolled back)

執行指令碼

命令

$ redis-cli --eval getset_hash.lua person1 person2 , name age Alice 22

檢視資料

$ redis-cli 
127.0.0.1:6379> keys *
1) "person2"
2) "person1"
127.0.0.1:6379> hgetall person1
1) "name"
2) "Alice"
3) "age"
4) "22"
127.0.0.1:6379> hgetall person2
1) "name"
2) "Alice"
3) "age"
4) "22"

參考連結