Go語言中通過Lua腳本操作Redis的方法

前言

為了在我的一個(gè)基本庫中降低與Redis的通訊成本，我將一系列操作封裝到LUA腳本中，借助Redis提供的EVAL命令來簡化操作。

EVAL能夠提供的特性：

• 可以在LUA腳本中封裝若干操作，如果有多條Redis指令，封裝好之后只需向Redis一次性發(fā)送所有參數(shù)即可獲得結(jié)果
• Redis可以保證Lua腳本運(yùn)行期間不會(huì)有其他命令插入執(zhí)行，提供像數(shù)據(jù)庫事務(wù)一樣的原子性
• Redis會(huì)根據(jù)腳本的SHA值緩存腳本，已經(jīng)緩存過的腳本不需要再次傳輸Lua代碼，減少了通信成本，此外在自己代碼中改變Lua腳本，執(zhí)行時(shí)Redis必定也會(huì)使用最新的代碼。

導(dǎo)入常見的Go庫如 "github.com/go-redis/redis"，就可以實(shí)現(xiàn)以下代碼。

生成一段Lua腳本

// KEYS: key for record
// ARGV: fieldName, currentUnixTimestamp, recordTTL
// Update expire field of record key to current timestamp, and renew key expiration
var updateRecordExpireScript = redis.NewScript(`
redis.call("EXPIRE", KEYS[1], ARGV[3])
redis.call("HSET", KEYS[1], ARGV[1], ARGV[2])
return 1
`)

該變量創(chuàng)建時(shí)，Lua代碼不會(huì)被執(zhí)行，也不需要有已存的Redis連接。

Redis提供的Lua腳本支持，默認(rèn)有KEYS、ARGV兩個(gè)數(shù)組，KEYS代表腳本運(yùn)行時(shí)傳入的若干鍵值，ARGV代表傳入的若干參數(shù)。由于Lua代碼需要保持簡潔，難免難以讀懂，最好為這些參數(shù)寫一些注釋

注意：上面一段代碼使用``跨行，`所在的行雖然空白回車，也會(huì)被認(rèn)為是一行，報(bào)錯(cuò)時(shí)不要看錯(cuò)代碼行號。

運(yùn)行一段Lua腳本

 updateRecordExpireScript.Run(c.Client, []string{recordKey(key)}, 
         expireField,
         time.Now().UTC().UnixNano(), int64(c.opt.RecordTTL/time.Second)).Err()

運(yùn)行時(shí)，Run將會(huì)先通過EVALSHA嘗試通過緩存運(yùn)行腳本。如果沒有緩存，則使用EVAL運(yùn)行，這時(shí)Lua腳本才會(huì)被整個(gè)傳入Redis。

Lua腳本的限制

• Redis不提供引入額外的包，例如os等，只有redis這一個(gè)包可用。
• Lua腳本將會(huì)在一個(gè)函數(shù)中運(yùn)行，所有變量必須使用local聲明
• return返回多個(gè)值時(shí)，Redis將會(huì)只給你第一個(gè)

腳本中的類型限制

• 腳本返回nil時(shí)，Go中得到的是err = redis.Nil（與Get找不到值相同）
• 腳本返回false時(shí)，Go中得到的是nil，腳本返回true時(shí)，Go中得到的是int64類型的1
• 腳本返回{"ok": ...}時(shí)，Go中得到的是redis的status類型（true/false)
• 腳本返回{"err": ...}時(shí)，Go中得到的是err值，也可以通過return redis.error_reply("My Error")達(dá)成
• 腳本返回number類型時(shí)，Go中得到的是int64類型
• 傳入腳本的KEYS/ARGV中的值一律為string類型，要轉(zhuǎn)換為數(shù)字類型應(yīng)當(dāng)使用to_number

如果腳本運(yùn)行了很久會(huì)發(fā)生什么？

Lua腳本運(yùn)行期間，為了避免被其他操作污染數(shù)據(jù)，這期間將不能執(zhí)行其它命令，一直等到執(zhí)行完畢才可以繼續(xù)執(zhí)行其它請求。當(dāng)Lua腳本執(zhí)行時(shí)間超過了lua-time-limit時(shí)，其他請求將會(huì)收到Busy錯(cuò)誤，除非這些請求是SCRIPT KILL（殺掉腳本）或者SHUTDOWN NOSAVE（不保存結(jié)果直接關(guān)閉Redis）

更多內(nèi)容參考以下地址，我這里主要是根據(jù)使用Go的經(jīng)驗(yàn)提供一些總結(jié)。https://redis.io/commands/eval

一段更“復(fù)雜”的腳本，它要求在獲取一個(gè)key值時(shí)，如果該值訪問較多，就延長生存周期。此外還要比較更新時(shí)間，如果不需要更新，則直接返回取到的值，否則返回redis.Nil

// KEYS: rec:key, key
// ARGV: currentUnixTimestamp, hotHit, recordTTL, ttl
// When there's a hit,
var fetchRecordScript = redis.NewScript(local value = redis.call("GET", KEYS[2]) if(value == nil) then return nil end local hit = redis.call("HINCRBY", KEYS[1], "hit", 1) redis.call("EXPIRE", KEYS[1], ARGV[3]) local minHotHit = tonumber(ARGV[2]) local keyTTL = tonumber(ARGV[4]) if(hit > minHotHit)then keyTTL = keyTTL * 2 end redis.call("EXPIRE", KEYS[2], keyTTL) local expire = tonumber(redis.call("HGET", KEYS[1], "expire")) local unixTime = tonumber(ARGV[1]) if(expire == nil or expire  unixTime) then return nil else return value end)
// KEYS: key for record
// ARGV: fieldName, currentUnixTimestamp, recordTTL
// Update expire field of record key to current timestamp, and renew key expiration
var updateRecordExpireScript = redis.NewScript(redis.call("EXPIRE", KEYS[1], ARGV[3]) redis.call("HSET", KEYS[1], ARGV[1], ARGV[2]) return 1)

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。