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

Redis 是一種非常流行的記憶體資料庫，常用于資料緩存與高頻資料存儲。大多數開發人員可能聽說過redis可以運作 Lua 腳本，但是可能不知道redis在什麼情況下需要使用到Lua腳本。

一、閱讀本文前置條件

• 可以遵循這個連結中的方法在作業系統上安裝 Redis
• 如果你對redis指令不熟悉，檢視《Redis 指令引用》

二、為什麼需要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指令的作用，可以參考hmset 和 zadd

執行下面的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進行替換。

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

六、總結