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

Redis 是一種很是流行的內存數據庫，經常使用於數據緩存與高頻數據存儲。大多數開發人員可能據說過redis能夠運行 Lua 腳本，可是可能不知道redis在什麼狀況下須要使用到Lua腳本。

1、閱讀本文前置條件

• 能夠遵循這個連接中的方法在操做系統上安裝 Redis
• 若是你對redis命令不熟悉，查看《Redis 命令引用》

2、爲何須要Lua腳本

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

• 不少應用的服務任務包含多步redis操做以及使用多個redis命令，這時你可使用Redis結合Lua腳本，會爲你的應用帶來更好的性能。
• 另外包含在一個Lua腳本里面的redis命令具有原子性，當你面對高併發場景下的redis數據庫操做時，能夠有效避免多線程操做產生髒數據。

3、學點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，因此獲得上面的輸出結果

4、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

5、一個修改 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"}

6、總結

我建議只有在你能證實它能帶來更好的性能時才使用Lua腳本。若是你只是想要保證redis操做原子性，那麼可使用transactions事務。不必定非要使用Lua腳本。

此外redis Lua腳本不該太長。由於當腳本運行時至關於爲被操做對象加鎖，其餘操做都在等待它完成。若是Lua腳本須要至關長的時間執行，則可能會致使瓶頸而不是提升性能。Lua腳本在達到超時後中止（默認狀況下爲 5 秒）。

歡迎關注個人博客，裏面有不少精品合集

本文轉載註明出處（必須帶鏈接，不能只轉文字）：字母哥博客 - zimug.com

以爲對您有幫助的話，幫我點贊、分享！您的支持是我不竭的創做動力！ 。另外，筆者最近一段時間輸出了以下的精品內容，期待您的關注。

• 《手摸手教你學Spring Boot2.0》
• 《Spring Security-JWT-OAuth2一本通》
• 《實戰先後端分離RBAC權限管理系統》
• 《實戰SpringCloud微服務從青銅到王者》
• 《VUE深刻淺出系列》