Redis進階應用：Redis+Lua腳本實現複合操作

2019 年 10 月 3 日
筆記

一、引言

Redis是高性能的key-value資料庫，在很大程度克服了memcached這類key/value存儲的不足，在部分場景下，是對關係資料庫的良好補充。得益於超高性能和豐富的數據結構，Redis已成為當前架構設計中的首選key-value存儲系統。

雖然Redis官網上提供了200多個命令，但做程式設計時還是避免不了為了實現一小步業務邏輯而多次調用Redis的情況。

以compare and set場景為例。如果使用Redis原生命令，需要從Redis中獲取這個key，然後提取其中的值進行比對：如果相等就不做處理；如果不相等或者key不存在則將key設置成目標值。僅僅一個單點的compare and set操作就需要與Redis通訊兩次。

此外，這種分散操作無法利用Redis的原子特性，佔用多次網路IO。

今天我們就來探討一下如何優雅地應對上述場景。

二、Redis與Lua

在介紹Lua之前，我們需要先對這個語言有個初步了解。Lua 是一個小巧的腳本語言，幾乎可以運行在所有作業系統和平台上。我們一般不會用Lua處理特別複雜的事務，因此只需了解一些lua的基本語法即可。

Redis問世之後，其開發者也意識到了開篇提到的問題，因此Redis從2.6版本開始支援Lua腳本。新版本的Redis還支援Lua Script debug，感興趣的小夥伴可以去官網的Documentation中找到對應介紹和QuickStart。

有了Lua腳本之後，使用Redis程式時便能夠在以下方面實現顯著提升：

減少網路開銷：本來N次網路請求的操作，可以用一個請求完成。原先N次請求的邏輯放在Redis伺服器上完成，減少了網路往返時延；
原子操作：Redis會將整個腳本作為一個整體執行，中間不會被其他命令插入。這是一個重要特性，一定要拿小本本記好。至於為什麼是一個原子操作，我們以後再分析；
復用：客戶端發送的腳本會永久存儲在Redis中。這樣其他客戶端就可以復用這一腳本，而不需要使用程式碼完成同樣的邏輯。

所以現在流傳一句話：要想學好Redis，必會Lua Script。

三、通過Lua腳本實現compare and set

接下來我們就實現一個簡單的compare and set，並通過這個例子感受一下Lua腳本給Redis使用帶來的全新體驗。

首先看一下如何讓Redis執行Lua腳本。

3.1 Redis的EVAL

Redis 127.0.0.1:6379> EVAL script  numkeys key [key ...] arg [arg ...]

script：參數是一段 Lua 5.1 腳本程式。腳本不必(也不應該)定義為一個Lua函數。
numkeys：用於指定鍵名參數的個數。
key [key …]：從 EVAL 的第三個參數開始算起，表示在腳本中所用到的Redis鍵(key)。在Lua中，這些鍵名參數可以通過全局變數 KEYS 數組，用1為基址的形式訪問( KEYS[1] ，KEYS[2]，依次類推)。
arg [arg …]：附加參數，在Lua中通過全局變數ARGV數組訪問，訪問的形式和KEYS變數類似( ARGV[1] 、 ARGV[2] ，諸如此類)。

這裡借用一下官網的例子。

上述腳本直接返回了入參。

eval為Redis關鍵字；
第一個引號中的內容就是Lua腳本；
2為參數個數；
key1和key2是KEYS[1]、KEYS[2]的入參；
first和second是ARGV[1],ARGV[2]的入參。

大家可以簡單地將KEYS[1],KEYS[2], ARGV[1],ARGV[2]理解為佔位符。

3.2 執行腳本文件和快取腳本

如果只能在命令行中寫腳本執行，遇到複雜的腳本程式豈不是會抓狂？

下面我們來看一下，如何讓Redis執行Lua腳本文件，同時也驗證一下lua腳本的復用特性（以後我們再也不需要定期批量刪除某些符合特定規則的key了）。

Redis 127.0.0.1:6379> SCRIPT LOAD  script  Redis 127.0.0.1:6379> EVALSHA sha1  numkeys key [key ...] arg [arg ...]

Redis提供了一個SCRIPTLOAD命令，命令後面的script即為Lua腳本。命令將腳本script添加到腳本快取中，但並不立即執行這個腳本。執行命令後，Redis會返回一個SHA1串，第二個EVALSHA命令即可執行。

需要注意的是，腳本可以在快取中保留無限長的時間，直到執行完SCRIPT FLUSH。我們來看一下效果。

Redis還支援直接執行Lua腳本文件。首先編寫並存儲一個Lua腳本。

然後調用Redis-cli –eval命令

Redis-cli –eval命令語法基本與原eval語法相同。

3.3 使用Lua腳本實現compare and set

compareand set的實現邏輯是這樣的：首先獲取Redis中指定key的value，然後與給定值進行比較：如果相等，則將key設定為目標值並返回一個標識符；如果不相等，則不作任何操作並返回一個標識符。

if Redis.call('get', KEYS[1]) == ARGV[1]  then       Redis.call('set', KEYS[1], ARGV[2]);       return 1  else       return 0 end

下面我們來測試一下這個腳本。

首先向Redis的指定key compareAndSet:key寫入一個值value

在Redis中執行lua腳本

可以看到第一次執行返回1，說明修改成功了；再使用原參數執行時返回0，說明沒有做任何修改。我們再查詢一下compareAndSet:key這個key

可以看到compareAndSet:key這個key已經被修改為new_value了。

四、總結

我們通過lua腳本實現了一個簡單的compareAndSet操作。

下面我們通過這個例子來驗證一下開篇提到的特性。

減少網路開銷：不使用腳本的情況下，我們實現一個compareAndSet至少需要與Redis交互兩次，而現在只需要執行一次操作即可完成；
原子操作：得益於Redis的設計，Redis會將整個腳本作為一個整體執行，中間不會被其他命令插入。因此在編寫腳本的過程中無需擔心出現競態條件，無需使用事務，感興趣的可以百度或等待以後後續文章更新；
復用：可以將一系列操作封裝成一個Lua腳本，存儲在文件或Redis上，下次使用時直接調用即可。

讀到這裡，希望你已經對Redis+Lua有了一定的了解，並能使用腳本完成一些簡單的複合操作。後續還會繼續更新一些基於Lua腳本+java程式實現的分散式數據結構，如延遲隊列、可重入鎖等，感興趣的小夥伴可以持續關注。

作者：李崇

原文首發 UAVStack智慧運維

來源：宜信技術學院