快速入門Redis調用Lua腳本及使用場景介紹

Redis 是一種非常流行的內存數據庫,常用於數據緩存與高頻數據存儲。大多數開發人員可能聽說過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 秒)。

歡迎關注我的博客,裏面有很多精品合集

本文轉載註明出處(必須帶連接,不能只轉文字):字母哥博客 - zimug.com

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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章