Redis使用Lua腳本詳解

前言

本文將講解 RedisLua腳本的基本操作以及與 Java專案的集成使用，

Lua腳本

Lua是一個高效的輕量級腳本語言，在葡萄牙語中是“月亮”的意思，用標準C語言撰寫并以源代碼形式開放,其設計目的是為了嵌入應用程式中，從而為應用程式提供靈活的擴展和定制功能，

為什么要在程式中嵌入 Lua腳本？它解決了什么問題？

假設要開發一個 iPhone 的電子寵物游戲，設定玩家每次給寵物喂食，寵物饑餓值就會減 N 點，這個 N 如果設定為一個定值，以后需要更改的話，玩家就需要到 App Store 中升級游戲，隨著需求的變化和擴展，每次修改完都需要玩家進行應用升級，現在有一個更好的辦法——嵌入Lua腳本實作需求的更改，將業務邏輯寫到 Lua腳本中，在你的應用程式中添加一個 Lua 解釋器，每次需要執行 Lua腳本的邏輯時，通過解釋器呼叫這個 Lua腳本，下次再需要調整演算法時，只要從網上更新這個腳本就好了，連 游戲都不用重啟，總之越多的可變的邏輯放到腳本上，你的程式升級或擴展越容易，

其實 Redis 和電子寵物游戲遇到的問題相似，很多人希望在 Redis 中加入各種各樣的命令，這樣命令中有的確實很實用，但卻可以使用多個 Redis 已有的命令去實作，Redis中不可能包含所有開發者需要的命令，所以在 Redis 2.6版本中提供了 Lua腳本 功能讓開發者擴展 Redis

Redis中使用 Lua 的好處

• 減少網路開銷，在 Lua腳本 中可以把多個命令放在同一個腳本中運行
• 原子操作，Redis 會將整個腳本作為一個整體執行，中間不會被其他命令插入（撰寫腳本程序中無需擔心會出現競態條件）
• 復用性，客戶端發送的腳本會永遠存盤在 Redis中，意味著其他客戶端可以復用這一腳本

Redis + Lua

從 Redis2.6開始， Eval命令使用內置的Lua解釋器執行腳本 ，不需要單獨安裝 Lua

EVAL

語法

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 都會將腳本的 SHA1 摘要加入到腳本快取中，以便下次客戶端可以使用 EVALSHA 命令呼叫該腳本，

實體

127.0.0.1:6379> eval "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 2 username age jack 20
1) "username"
2) "age"
3) "jack"
4) "20"

SCRIPT LOAD

如果只是希望將腳本加入腳本快取而不執行則可以使用 SCRIPT LOAD 命令，回傳值是腳本的 SHA1 摘要，

127.0.0.1:6379> script load "return 1"
"e0e1f9fabfc9d4800c877a703b823ac0578ff8db"

SCRIPT EXISTS

如判斷腳本是否已經被快取，使用 SCRIPT EXISTS 命令查看

127.0.0.1:6379> script exists e0e1f9fabfc9d4800c877a703b823ac0578ff8db
1) (integer) 1

SCRIPT FLUSH

清空腳本快取

127.0.0.1:6379> script flush
OK

SCRIPT KILL

強制終止當前腳本的執行，可使用 SCRIPT KILL命令

SpringBoot 集成 Redis 呼叫 Lua腳本

1、resources 下定義 redis.lua

-- 呼叫 redis 中的 key 值
local current = redis.call('GET', KEYS[1])
-- 判斷key值是否與傳的key值相等
if current == ARGV[1]
  -- 若相等，將value置換為第二個arg
  then redis.call('SET', KEYS[1], ARGV[2])
  return true
end
return false

2、注入 DefaultRedisScript

@Configuration
public class RedisUtil {

    @Bean
    public DefaultRedisScript<Boolean> redisScript() {
        DefaultRedisScript<Boolean> objectDefaultRedisScript = new DefaultRedisScript<>();
        objectDefaultRedisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("lua/redis.lua")));
        objectDefaultRedisScript.setResultType(Boolean.class);
        return objectDefaultRedisScript;
    

3、呼叫 lua 腳本

@Test
public void testScript() {
    String key = "testredislua";
    // set testredislua feiyangyang
    template.opsForValue().set(key, "feiyangyang");
    String str = template.opsForValue().get(key);
    System.out.println(str);

    // 執行lua腳本，傳 key 和 兩個 args
    template.execute(redisScript, Collections.singletonList(key), "feiyangyang", "123");
    str = template.opsForValue().get(key);
    System.out.println(str);
}

4、列印結果

feiyangyang
123

Lua 的原子性與執行時間

Redis腳本的執行是原子的，即腳本執行期間 Redis不會執行其他命令，所有命令都必須等腳本執行完后才能執行，為防止某個腳本執行時間過長導致Redis無法提供服務，Redis 提供了 lua-time-limit引數限制腳本的最長運行時間，默認為 5s，當腳本執行時間超過這一限制后，Redis將開始接受其他命令但不會執行，而是會回傳 BUSY錯誤，

如現有兩個 redis-cli 實體 a 和 b ，在 a 中執行一個死回圈腳本，再在 b 中執行一條命令，這時實體 b 的命令不會馬上回傳結果，因為 Redis 已經被實體 a 發送的死回圈腳本阻塞了，無法執行其他命令，等腳本執行 5s 后實體 b 收到了 BUSY 錯誤，

雖然此時 Redis 可以接受任何命令，但實際會執行的只要兩個命令：SCRIPT KILL 和 SHUTDOWN NOSAVE ，在實體 b 中執行 SCRIPT KILL 命令可以終止當前腳本的運行，終止后實體 a 中就會回傳錯誤，

小結

由于 Redis 腳本非常高效，所以大部分情況下不用擔心腳本的性能，但同時由于腳本的強大功能，很多原本在程式中執行的邏輯都可以放到腳本中執行，這時就需要開發者根據具體應用權衡到底哪些任務適合交給腳本，通常來講不應該在腳本中進行大量耗時的計算，因為畢竟 Redis 是單執行緒執行腳本，而程式卻能夠多執行緒執行，