快速入門Redis呼叫Lua指令碼及使用場景介紹

字母哥部落格 發表於 2021-02-26
Redis

Redis 是一種非常流行的記憶體資料庫,常用於資料快取與高頻資料儲存。大多數開發人員可能聽說過redis可以執行 Lua 指令碼,但是可能不知道redis在什麼情況下需要使用到Lua指令碼。
快速入門Redis呼叫Lua指令碼及使用場景介紹

一、閱讀本文前置條件

二、為什麼需要Lua指令碼

簡而言之:Lua指令碼帶來效能的提升

  • 很多應用的服務任務包含多步redis操作以及使用多個redis命令,這時你可以使用Redis結合Lua指令碼,會為你的應用帶來更好的效能。
  • 另外包含在一個Lua指令碼里面的redis命令具備原子性,當你面對高併發場景下的redis資料庫操作時,可以有效避免多執行緒操作產生髒資料。

三、學點Lua語法

說了那麼多,Lua不會怎麼辦?不要慌!Lua其實很簡單,如果你曾經學習過任何一門程式語言,學習Lua都非常簡單。下面給大家舉幾個例子學習一下:

3.1.一個簡單的例子

Lua指令碼通過各種語言的redis客戶端都可以呼叫,我們就簡單一點使用redis-cli
看下面的redis命令列:

eval "redis.call('set', KEYS[1], ARGV[1])" 1 key:name value

EVAL命令列後面跟著的是Lua指令碼:"redis.call('set', KEYS[1], ARGV[1])",放到程式語言裡面就是一段字串,跟在Lua指令碼字串後面的三個引數依次是:

  1. redis Lua指令碼所需要的KEYS的數量 ,只有一個KEYS[1],所以緊跟指令碼之後的引數值是1
  2. Lua 指令碼需要的引數KEYS[1]的引數值,在我們的例子中值為key:name
  3. Lua 指令碼需要的引數ARGV[1]的引數值,在我們的例子中值為value

Lua指令碼中包括兩組引數:KEYS[]ARGV[],兩個陣列下標從1開始。一個值得去遵守的最佳實踐是:把redis操作所需的key通過KEYS進行引數傳遞,其他的Lua指令碼所需的引數通過ARGV進行傳遞。

上面的指令碼執行完成之後,我們使用下面的Lua指令碼來進行驗證,如果該指令碼的返回值是”value”,與我們之前設定的key:name的值相同,則表示我們的Lua指令碼被正確執行了。

eval "return redis.call('get', KEYS[1])" 1 key:name

3.2.仔細看下Lua指令碼里的內容

我們的第一個Lua指令碼只包含一條語句,呼叫redis.call

redis.call('set', KEYS[1], ARGV[1])

所以在Lua指令碼里面可以通過redis.call執行redis命令,call方法的第一個引數就是redis命令的名稱,因為我們呼叫的是redis 的set命令,所以需要傳遞key和value兩個引數。

我們第二個指令碼不只是執行了一個指令碼,因為執行get命令還返回了執行結果。注意指令碼中有一個return 關鍵字。

eval "return redis.call('get', KEYS[1])" 1 key:name

當然如果只是上面的這麼簡單的Lua指令碼,還不如直接使用命令列更方便。我們實際使用到的Lua指令碼會比上面的複雜,上面的Lua指令碼只是一個Hello World。

3.3. 複雜點的例子

我曾使用Lua指令碼從一個hash map裡面按照一定的順序獲取若干key對應的值。對應的順序在一個zset排序集合中進行儲存,資料設定及排序可以通過下面的完成。

# 設定hkeys為鍵Hash值
hmset hkeys key:1 value:1 key:2 value:2 key:3 value:3 key:4 value:4 key:5 value:5 key:6 value:6
# 建一個order為鍵的集合,並給出順序
zadd order 1 key:3 2 key:1 3 key:2

如果不知道hmset和zadd命令的作用,可以參考hmsetzadd

執行下面的Lua指令碼

eval "local order = redis.call('zrange', KEYS[1], 0, -1); return redis.call('hmget',KEYS[2],unpack(order));" 2 order hkeys

你將看到如下的輸出結果

“value:3”
“value:1”
“value:2”
  • 通過zrange取出order集合裡面的資料,即:[ key:3 , key:1 , key:2]
  • 然後通過unpack函式將[ key:3 , key:1 ,key:2] 轉成 key:3 key:1 key:2
  • 最後執行 hmget hkeys key:3 key:1 key:2,所以得到上面的輸出結果

四、Lua指令碼預載入

Redis可以對Lua指令碼進行預載入,可以通過script load命令把Lua指令碼預載入到redis裡面。

script load "return redis.call('get', KEYS[1])"

預載入完成之後,你會看到下面的一段輸出

“4e6d8fc8bb01276962cce5371fa795a7763657ae”

這是一個具有唯一性的hash字串,這個hash就代表著我們剛剛預載入的Lua指令碼,我們可以通過EVALSHA命令執行該指令碼。如:

evalsha 4e6d8fc8bb01276962cce5371fa795a7763657ae 1 key:name

執行的結果與下面的是一致的。

eval "return redis.call('get', KEYS[1])" 1 key:name

五、一個修改 JSON資料的例子?

有些開發人員有的時候可能會將JSON資料儲存在Redis裡面,我們先不說這樣做是不是一種好的方式,我們只來談一下如何通過Lua指令碼修改JSON資料。

正常情況下,你需要修改一個JSON Object,你需要把它從redis裡面查詢回來,解析它,修改key值,然後再將它序列化儲存到redis裡面。這樣做有幾個問題:

  1. 高併發場景下無法保證原子性,另一個執行緒可以在當前執行緒獲取和設定Object操作之間更改這個JSON資料。在這種情況下,將丟失更新。
  2. 效能問題。如果您經常進行這樣的更改並且JSON資料相當大,這可能會成為應用的效能瓶頸。因為你經常性的進行取資料,存資料。

通過在 Lua 中實現上面邏輯,因為redis的Lua指令碼是在服務端執行的,一方面可以保證操作的原子性,解決高併發丟失更新的問題,另一方面節省網路傳輸同時提升效能。

下面我們向redis裡面儲存一個測試JSON 字串:obj

set obj '{"a":"foo","b":"bar"}'

現在,讓我們執行我們的指令碼:

EVAL 'local obj = redis.call("get",KEYS[1]); local obj2 = string.gsub(obj,"(" .. ARGV[1] .. "\":)([^,}]+)", "%1" .. ARGV[2]);  return redis.call("set",KEYS[1],obj2);' 1 obj b bar2
  • local obj = redis.call("get",KEYS[1]); 其中KEYS[1]=obj,所以返回值obj= '{"a":"foo","b":"bar"}'

  • local obj2 = string.gsub(obj,"(" .. ARGV[1] .. "\":)([^,}]+)", "%1" .. ARGV[2]);..是Lua指令碼的字串連線符號;我們使用 RegEx 模式來匹配金鑰並替換其值,如果對錶達式不熟悉,自行補課;"%1"表示第一個被匹配的子串,"%1" .. ARGV[2] 等於 "b":"bar2",並使用gsub進行替換。

  • 最後將結果返回,obj的JSON物件的結果如下:

{"a":"foo","b":"bar2"}

六、總結

我建議只有在你能證明它能帶來更好的效能時才使用Lua指令碼。如果你只是想要保證redis操作原子性,那麼可以使用transactions事務。不一定非要使用Lua指令碼。

此外redis Lua指令碼不應太長。因為當指令碼執行時相當於為被操作物件加鎖,其他操作都在等待它完成。如果Lua指令碼需要相當長的時間執行,則可能會導致瓶頸而不是提高效能。Lua指令碼在達到超時後停止(預設情況下為 5 秒)。

歡迎關注我的部落格,裡面有很多精品合集

  • 本文轉載註明出處(必須帶連線,不能只轉文字):字母哥部落格

覺得對您有幫助的話,幫我點贊、分享!您的支援是我不竭的創作動力! 。另外,筆者最近一段時間輸出瞭如下的精品內容,期待您的關注。