一、閱讀本文前置條件

可以遵循這個(gè)鏈接中的方法在操作系統(tǒng)上安裝 Redis

如果你對redis命令不熟悉，查看《Redis 命令引用》

二、為什么需要Lua腳本

簡而言之：Lua腳本帶來性能的提升。

很多應(yīng)用的服務(wù)任務(wù)包含多步redis操作以及使用多個(gè)redis命令，這時(shí)你可以使用Redis結(jié)合Lua腳本，會(huì)為你的應(yīng)用帶來更好的性能。

另外包含在一個(gè)Lua腳本里面的redis命令具備原子性，當(dāng)你面對高并發(fā)場景下的redis數(shù)據(jù)庫操作時(shí)，可以有效避免多線程操作產(chǎn)生臟數(shù)據(jù)。

三、學(xué)點(diǎn)Lua語法

說了那么多，Lua不會(huì)怎么辦？不要慌！Lua其實(shí)很簡單，如果你曾經(jīng)學(xué)習(xí)過任何一門編程語言，學(xué)習(xí)Lua都非常簡單。下面給大家舉幾個(gè)例子學(xué)習(xí)一下：

3.1.一個(gè)簡單的例子

Lua腳本通過各種語言的redis客戶端都可以調(diào)用，我們就簡單一點(diǎn)使用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腳本字符串后面的三個(gè)參數(shù)依次是：

• redis Lua腳本所需要的KEYS的數(shù)量 ，只有一個(gè)KEYS[1]，所以緊跟腳本之后的參數(shù)值是1
• Lua 腳本需要的參數(shù)KEYS[1]的參數(shù)值，在我們的例子中值為key:name
• Lua 腳本需要的參數(shù)ARGV[1]的參數(shù)值，在我們的例子中值為value

Lua腳本中包括兩組參數(shù)：KEYS[]和ARGV[]，兩個(gè)數(shù)組下標(biāo)從1開始。一個(gè)值得去遵守的最佳實(shí)踐是：把redis操作所需的key通過KEYS進(jìn)行參數(shù)傳遞，其他的Lua腳本所需的參數(shù)通過ARGV進(jìn)行傳遞。

上面的腳本執(zhí)行完成之后，我們使用下面的Lua腳本來進(jìn)行驗(yàn)證，如果該腳本的返回值是”value”，與我們之前設(shè)置的key:name的值相同，則表示我們的Lua腳本被正確執(zhí)行了。

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

3.2.仔細(xì)看下Lua腳本里的內(nèi)容

我們的第一個(gè)Lua腳本只包含一條語句，調(diào)用redis.call

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

所以在Lua腳本里面可以通過redis.call執(zhí)行redis命令，call方法的第一個(gè)參數(shù)就是redis命令的名稱，因?yàn)槲覀冋{(diào)用的是redis 的set命令，所以需要傳遞key和value兩個(gè)參數(shù)。

我們第二個(gè)腳本不只是執(zhí)行了一個(gè)腳本，因?yàn)閳?zhí)行g(shù)et命令還返回了執(zhí)行結(jié)果。注意腳本中有一個(gè)return 關(guān)鍵字。

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

當(dāng)然如果只是上面的這么簡單的Lua腳本，還不如直接使用命令行更方便。我們實(shí)際使用到的Lua腳本會(huì)比上面的復(fù)雜，上面的Lua腳本只是一個(gè)Hello World。

3.3. 復(fù)雜點(diǎn)的例子

我曾使用Lua腳本從一個(gè)hash map里面按照一定的順序獲取若干key對應(yīng)的值。對應(yīng)的順序在一個(gè)zset排序集合中進(jìn)行保存，數(shù)據(jù)設(shè)置及排序可以通過下面的完成。

# 設(shè)置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
# 建一個(gè)order為鍵的集合，并給出順序
zadd order 1 key:3 2 key:1 3 key:2

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

執(zhí)行下面的Lua腳本

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

你將看到如下的輸出結(jié)果

“value:3”
“value:1”
“value:2”

• 通過zrange取出order集合里面的數(shù)據(jù)，即：[ key:3 , key:1 , key:2]
• 然后通過unpack函數(shù)將[ key:3 , key:1 ,key:2] 轉(zhuǎn)成 key:3 key:1 key:2
• 最后執(zhí)行 hmget hkeys key:3 key:1 key:2，所以得到上面的輸出結(jié)果

四、Lua腳本預(yù)加載

Redis可以對Lua腳本進(jìn)行預(yù)加載，可以通過script load命令把Lua腳本預(yù)加載到redis里面。

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

預(yù)加載完成之后，你會(huì)看到下面的一段輸出

“4e6d8fc8bb01276962cce5371fa795a7763657ae”

這是一個(gè)具有唯一性的hash字符串，這個(gè)hash就代表著我們剛剛預(yù)加載的Lua腳本，我們可以通過EVALSHA命令執(zhí)行該腳本。如：

evalsha 4e6d8fc8bb01276962cce5371fa795a7763657ae 1 key:name

執(zhí)行的結(jié)果與下面的是一致的。

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

五、一個(gè)修改 JSON數(shù)據(jù)的例子?

有些開發(fā)人員有的時(shí)候可能會(huì)將JSON數(shù)據(jù)保存在Redis里面，我們先不說這樣做是不是一種好的方式，我們只來談一下如何通過Lua腳本修改JSON數(shù)據(jù)。

正常情況下，你需要修改一個(gè)JSON Object，你需要把它從redis里面查詢回來，解析它，修改key值，然后再將它序列化保存到redis里面。這樣做有幾個(gè)問題：

高并發(fā)場景下無法保證原子性，另一個(gè)線程可以在當(dāng)前線程獲取和設(shè)置Object操作之間更改這個(gè)JSON數(shù)據(jù)。在這種情況下，將丟失更新。

性能問題。如果您經(jīng)常進(jìn)行這樣的更改并且JSON數(shù)據(jù)相當(dāng)大，這可能會(huì)成為應(yīng)用的性能瓶頸。因?yàn)槟憬?jīng)常性的進(jìn)行取數(shù)據(jù)，存數(shù)據(jù)。

通過在 Lua 中實(shí)現(xiàn)上面邏輯，因?yàn)閞edis的Lua腳本是在服務(wù)端執(zhí)行的，一方面可以保證操作的原子性，解決高并發(fā)丟失更新的問題，另一方面節(jié)省網(wǎng)絡(luò)傳輸同時(shí)提升性能。

下面我們向redis里面保存一個(gè)測試JSON 字符串：obj

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

現(xiàn)在，讓我們運(yùn)行我們的腳本：

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 模式來匹配密鑰并替換其值，如果對表達(dá)式不熟悉，自行補(bǔ)課；"%1"表示第一個(gè)被匹配的子串，"%1" … ARGV[2] 等于 “b”:“bar2”,并使用gsub進(jìn)行替換。

最后將結(jié)果返回，obj的JSON對象的結(jié)果如下：

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

六、總結(jié)

我建議只有在你能證明它能帶來更好的性能時(shí)才使用Lua腳本。如果你只是想要保證redis操作原子性，那么可以使用transactions事務(wù)。不一定非要使用Lua腳本。

此外redis Lua腳本不應(yīng)太長。因?yàn)楫?dāng)腳本運(yùn)行時(shí)相當(dāng)于為被操作對象加鎖，其他操作都在等待它完成。如果Lua腳本需要相當(dāng)長的時(shí)間執(zhí)行，則可能會(huì)導(dǎo)致瓶頸而不是提高性能。Lua腳本在達(dá)到超時(shí)后停止（默認(rèn)情況下為 5 秒）。