Redis Lua腳本完全入門

1. 前言

Redis是高性能的KV內存數據庫，除了做緩存中間件的基本作用外還有很多用途，比如胖哥以前分享的Redis GEO地理位置信息計算。Redis提供了豐富的命令來供我們使用以實現一些計算。Redis的單個命令都是原子性的，有時候我們希望能夠組合多個Redis命令，並讓這個組合也能夠原子性的執行，甚至可以重復使用，在軟件熱更新中也有一席之地。Redis開發者意識到這種場景還是很普遍的，就在2.6版本中引入了一個特性來解決這個問題，這就是Redis執行Lua腳本。

2. Lua

Lua也算一門古老的語言了，玩魔獸世界的玩家應該對它不陌生，WOW的插件就是用Lua腳本編寫的。在高並發的網絡游戲中Lua大放異彩被廣泛使用。

Lua廣泛作為其它語言的嵌入腳本，尤其是C/C++，語法簡單，小巧，源碼一共才200多K，這可能也是Redis官方選擇它的原因。

另一款明星軟件Nginx也支持Lua，利用Lua也可以實現很多有用的功能。

3. Lua並不難

Redis 官方指南也指出不要在Lua腳本中編寫過於復雜的邏輯。

為了實現一個功能就要學習一門語言，這看起來就讓人有打退堂鼓的感覺。其實Lua並不難學，而且作為本文的場景來說我們不需要去學習Lua的完全特性，要在Redis中輕量級使用Lua語言。這對掌握了Java這種重量級語言的你來說根本不算難事。這里胖哥只對Redis中的涉及到的基本語法說一說。

Lua 的簡單語法

Lua在Redis腳本中我個人建議只需要使用下面這幾種類型：

1. nil 空
2. boolean 布爾值
3. number 數字
4. string 字符串
5. table 表

聲明類型

聲明類型非常簡單，不用攜帶類型。

--- 全局變量 
name = 'felord.cn'
--- 局部變量
local age = 18

Redis腳本在實踐中不要使用全局變量，局部變量效率更高。

table 類型

前面四種非常好理解，第五種table需要簡單說一下，它既是數組又類似Java中的HashMap（字典），它是Lua中僅有的數據結構。

數組不分具體類型，演示如下

Lua 5.1.5  Copyright (C) 1994-2012 Lua.org, PUC-Rio
> arr_table = {'felord.cn','Felordcn',1}
> print(arr_table[1])
felord.cn
> print(arr_table[3])
1
> print(#arr_table)
3

作為字典：

Lua 5.1.5  Copyright (C) 1994-2012 Lua.org, PUC-Rio
> arr_table = {name = 'felord.cn', age = 18}
> print(arr_table['name'])
felord.cn
> print(arr_table.name)
felord.cn
> print(arr_table[1])
nil
> print(arr_table['age'])
18
> print(#arr_table)
0

混合模式：

Lua 5.1.5  Copyright (C) 1994-2012 Lua.org, PUC-Rio
> arr_table = {'felord.cn','Felordcn',1,age = 18,nil}
> print(arr_table[1])
felord.cn
> print(arr_table[4])
nil
> print(arr_table['age'])
18
> print(#arr_table)
3

❗ # 取table的長度不一定精准，慎用。同時在Redis腳本中避免使用混合模式的table，同時元素應該避免包含空值nil。在不確定元素的情況下應該使用循環來計算真實的長度。

判斷

判斷非常簡單，格式為：

local a = 10
if a < 10  then
	print('a小於10')
elseif a < 20 then
	print('a小於20，大於等於10')
else
	print('a大於等於20')
end

數組循環

local arr = {1,2,name='felord.cn'}

for i, v in ipairs(arr) do
    print('i = '..i)
    print('v = '.. v)
end

print('-------------------')

for i, v in pairs(arr) do
    print('p i = '..i)
    print('p v = '.. v)
end

打印結果：

i = 1
v = 1
i = 2
v = 2
-----------------------
p i = 1
p v = 1
p i = 2
p v = 2
p i = name
p v = felord.cn

返回值

像Python一樣，Lua也可以返回多個返回值。不過在Redis的Lua腳本中不建議使用此特性，如果有此需求請封裝為數組結構。在Spring Data Redis中支持腳本的返回值規則可以從這里分析：

public static ReturnType fromJavaType(@Nullable Class<?> javaType) {

   if (javaType == null) {
      return ReturnType.STATUS;
   }
   if (javaType.isAssignableFrom(List.class)) {
      return ReturnType.MULTI;
   }
   if (javaType.isAssignableFrom(Boolean.class)) {
      return ReturnType.BOOLEAN;
   }
   if (javaType.isAssignableFrom(Long.class)) {
      return ReturnType.INTEGER;
   }
   return ReturnType.VALUE;
}

胖哥在實踐中會使用 List、Boolean、Long三種，避免出現幺蛾子。

到此為止Redis Lua腳本所需要知識點就完了，其它的函數、協程等特性也不應該在Redis Lua腳本中出現，用到內置函數的話搜索查詢一下就行了。

在接觸一門新的技術時先要中規中矩的使用，如果你想玩花活就意味着更高的學習成本。

4. Redis中的Lua

接下來就是Redis Lua腳本的實際操作了。

EVAL命令

Redis中使用EVAL命令來直接執行指定的Lua腳本。

EVAL luascript numkeys key [key ...] arg [arg ...]

• EVAL 命令的關鍵字。
• luascript Lua 腳本。
• numkeys 指定的Lua腳本需要處理鍵的數量，其實就是 key數組的長度。
• key 傳遞給Lua腳本零到多個鍵，空格隔開，在Lua 腳本中通過 KEYS[INDEX]來獲取對應的值，其中1 <= INDEX <= numkeys。
• arg是傳遞給腳本的零到多個附加參數，空格隔開，在Lua腳本中通過ARGV[INDEX]來獲取對應的值，其中1 <= INDEX <= numkeys。

接下來我簡單來演示獲取鍵hello的值得簡單腳本：

127.0.0.1:6379> set hello world
OK
127.0.0.1:6379> get hello
"world"
127.0.0.1:6379> EVAL "return redis.call('GET',KEYS[1])" 1 hello
"world"
127.0.0.1:6379> EVAL "return redis.call('GET','hello')"
(error) ERR wrong number of arguments for 'eval' command
127.0.0.1:6379> EVAL "return redis.call('GET','hello')" 0
"world"

從上面的演示代碼中發現，KEYS[1]可以直接替換為hello,但是Redis官方文檔指出這種是不建議的，目的是在命令執行前會對命令進行分析，以確保Redis Cluster可以將命令轉發到適當的集群節點。

numkeys無論什么情況下都是必須的命令參數。

call函數和pcall函數

在上面的例子中我們通過redis.call()來執行了一個SET命令，其實我們也可以替換為redis.pcall()。它們唯一的區別就在於處理錯誤的方式，前者執行命令錯誤時會向調用者直接返回一個錯誤；而后者則會將錯誤包裝為一個我們上面講的table表格：

127.0.0.1:6379> EVAL "return redis.call('no_command')" 0
(error) ERR Error running script (call to f_1e6efd00ab50dd564a9f13e5775e27b966c2141e): @user_script:1: @user_script: 1: Unknown Redis command called from Lua script
127.0.0.1:6379> EVAL "return redis.pcall('no_command')" 0
(error) @user_script: 1: Unknown Redis command called from Lua script

這就像Java遇到一個異常，前者會直接拋出一個異常；后者會把異常處理成JSON返回。

值轉換

由於在Redis中存在Redis和Lua兩種不同的運行環境，在Redis和Lua互相傳遞數據時必然發生對應的轉換操作，這種轉換操作是我們在實踐中不能忽略的。例如如果Lua腳本向Redis返回小數，那么會損失小數精度；如果轉換為字符串則是安全的。

127.0.0.1:6379> EVAL "return 3.14" 0
(integer) 3
127.0.0.1:6379> EVAL "return tostring(3.14)" 0
"3.14"

根據胖哥經驗傳遞字符串、整數是安全的，其它需要你去仔細查看官方文檔並進行實際驗證。

原子執行

Lua腳本在Redis中是以原子方式執行的，在Redis服務器執行EVAL命令時，在命令執行完畢並向調用者返回結果之前，只會執行當前命令指定的Lua腳本包含的所有邏輯，其它客戶端發送的命令將被阻塞，直到EVAL命令執行完畢為止。因此LUA腳本不宜編寫一些過於復雜了邏輯，必須盡量保證Lua腳本的效率，否則會影響其它客戶端。

腳本管理

SCRIPT LOAD

加載腳本到緩存以達到重復使用，避免多次加載浪費帶寬，每一個腳本都會通過SHA校驗返回唯一字符串標識。需要配合EVALSHA命令來執行緩存后的腳本。

127.0.0.1:6379> SCRIPT LOAD "return 'hello'"
"1b936e3fe509bcbc9cd0664897bbe8fd0cac101b"
127.0.0.1:6379> EVALSHA 1b936e3fe509bcbc9cd0664897bbe8fd0cac101b 0
"hello"

SCRIPT FLUSH

既然有緩存就有清除緩存，但是遺憾的是並沒有根據SHA來刪除腳本緩存，而是清除所有的腳本緩存，所以在生產中一般不會再生產過程中使用該命令。

SCRIPT EXISTS

以SHA標識為參數檢查一個或者多個緩存是否存在。

127.0.0.1:6379> SCRIPT EXISTS 1b936e3fe509bcbc9cd0664897bbe8fd0cac101b  1b936e3fe509bcbc9cd0664897bbe8fd0cac1012
1) (integer) 1
2) (integer) 0

SCRIPT KILL

終止正在執行的腳本。但是為了數據的完整性此命令並不能保證一定能終止成功。如果當一個腳本執行了一部分寫的邏輯而需要被終止時，該命令是不湊效的。需要執行SHUTDOWN nosave在不對數據執行持久化的情況下終止服務器來完成終止腳本。

其它一些要點

了解了上面這些知識基本上可以滿足開發一些簡單的Lua腳本了。但是實際開發中還是有一些要點的。

• 務必對Lua腳本進行全面測試以保證其邏輯的健壯性，當Lua腳本遇到異常時，已經執行過的邏輯是不會回滾的。
• 盡量不使用Lua提供的具有隨機性的函數，參見相關官方文檔。
• 在Lua腳本中不要編寫function函數,整個腳本作為一個函數的函數體。
• 在腳本編寫中聲明的變量全部使用local關鍵字。
• 在集群中使用Lua腳本要確保邏輯中所有的key分到相同機器，也就是同一個插槽(slot)中，可采用Redis Hash Tag技術。
• 再次重申Lua腳本一定不要包含過於耗時、過於復雜的邏輯。

5. 總結

本文對Redis Lua腳本的場景以及Redis Lua腳本所需要的Lua編程語法進行了詳細的講解和演示，也對Redis Lua腳本在實際開發中需要注意的一些要點進行了分享。希望能夠幫助你掌握此技術。今天的分享就到這里，下次我將分享如何在實際Redis開發中使用Lua腳本，所以這一篇一定要進行掌握。多多關注：碼農小胖哥 獲取更多編程知識干貨。

關注公眾號：Felordcn 獲取更多資訊

個人博客：https://felord.cn