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腳本中我個人建議只需要使用下面這幾種型別：

nil 空
boolean 布林值
number 數字
string 字串
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

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/179755.html

標籤：Java

上一篇：Flink on Yarn三部曲之一：準備作業

下一篇：Java NIO