可能你已經聽說過Redis 中嵌入了腳本語言,但是你還沒有親自去嘗試吧? 這個入門教程會讓你學會在你的Redis 服務器上使用強大的lua語言。
Hello, Lua!
我們的第一個Redis Lua 腳本僅僅返回一個字符串,而不會去與redis 以任何有意義的方式交互。
|
1
|
local msg = "Hello, world!"
|
view source
print?
print?
|
1
|
local link_id = redis.call("INCR", KEY[1])
|
|
2
|
redis.call("HSET", KEYS[2], link_id, ARGV[1])
|
|
3
|
return link_id
|
我 們將用call()函數首次訪問Redis。call()的參數就是發給Redis的命令:首先INCR <key>, 然后HSET <key> <field> <value>。這兩個命令將依次執行——當這個腳本執行時,Redis不會做任何事,它將非常快地運行。
我們將會訪問兩個Lua表:KEYS和ARGV。表單是關聯性數組和結構化數據的Lua唯一機制。對於我們的意圖,你可以把它們看做是一個你所熟悉的任意語言對等的數組,但是提醒兩個很容易困擾到新手的兩個Lua定則:
- 表是基於1的,也就是說索引以數值1開始。所以在表中的第一個元素就是mytable[1],第二個就是mytable[2]等等。
- 表中不能有nil值。如果一個操作表中有[1, nil, 3, 4],那么結果將會是[1]——表將會在第一個nil截斷。
當調用這個腳本時,我們還需要傳遞KEYS和ARGV表的值:
|
1
|
redis-cli EVAL "$(cat incr-and-stor.lua)"2 links:counter links:urls
http://malcolmgladwellbookgenerator.com/
|
在EVAL語句中,2指出需要傳入的KEY的個數,后面跟着需要傳入的兩個KEY,最后傳入是ARGV的值。在Redis中執行Lua腳本時,Redis-cli會檢查傳入KEY的個數,除非傳入的完全是命令。
為了解釋得更清楚,下面列出替換KEY和ARGV后的腳本:
view source
print?
print?
|
1
|
local link_id = redis.call("INCR", "links:counter")
|
view source
print?
print?
|
1
|
if redis.call("EXISTS",KEYS[1]) == 1 then
|
|
2
|
return redis.call("INCR",KEYS[1])
|
|
3
|
else
|
|
4
|
return nil
|
|
5
|
end
|
腳本加載與注冊執行
腳本加載與注冊執行
何時使用Lua
數值轉換
注意,當Redis在運行Lua腳本的時候,其它的事情什么都干不了!腳本最好只是簡單的擴展Redis進行較小的原子操作和簡單的邏輯控制需要,Lua腳本中的bug可能引發整個Redis服務器鎖—最好保持腳本的簡短和易於調試。
雖然這些腳本一般都比較短小,但我們還是希望不要每次執行時都使用完整的Lua腳本,實際上可以在程序一步一步(譯注:application boots翻譯有難度)開發中注冊Lua腳本(或者在你部署時注冊),然后用注冊后生成的SHA-1標識來進行調用。
view source
print?
print?
|
1
|
redis-cli SCRIPT LOAD "return 'hello world'"
|
|
3
|
腳本加載與注冊執行
注意,當Redis在運行Lua腳本的時候,其它的事情什么都干不了!腳本最好只是簡單的擴展Redis進行較小的原子操作和簡單的邏輯控制需要,Lua腳本中的bug可能引發整個Redis服務器鎖—最好保持腳本的簡短和易於調試。
雖然這些腳本一般都比較短小,但我們還是希望不要每次執行時都使用完整的Lua腳本,實際上可以在程序一步一步(譯注:application boots翻譯有難度)開發中注冊Lua腳本(或者在你部署時注冊),然后用注冊后生成的SHA-1標識來進行調用。
view source
print?
print?
|
1
|
redis-cli SCRIPT LOAD "return 'hello world'"
|
|
3
|
何時使用Lua
Redis 支持WATCH/MULTI/EXEC這樣的塊,能進行一組操作,也能一起提交執行,看起來與Lua有重疊。應該如何進行選擇?MULT塊中所有操作獨 立,但在Lua中,后面的操作能依賴前面操作的執行結果。同時使用Lua腳本還能夠避免WATCH使用后競爭條件引起客戶端反應變慢的情況。
在RedisGreen(譯注:國外一家專門提供Redis主機的服務商),我們看到許多應用使用Lua的同時也使用MULTI/EXEC,但兩者但不是替代關系。許多成功的Lua腳本都很小,僅僅實現一個你的應用需要而Redis命令中沒有單一的功能。
訪問庫
Redis的Lua解釋器加載七個庫:base,
table,
string,
math,
debug,
cjson和
cmsgpack。前幾個都是標准庫,充許你使用任何語言進行基本的操作。后面兩個可以讓Redis支持JSON和MessagePack—這是非常有用的功能,同時我也很想知道為什么常常看不到這種用法。
Web應用程序常常使用JSON作為api返回數據,你也許也可以把一堆JSON數據存到Redis的key中。當想訪問某些JSON數據時,首先需要保存到一個hash中,使用Redis的JSON支持將非常方便:
view source
print?
print?
|
1
|
if redis.call("EXISTS", KEYS[1]) == 1 then
|
|
2
|
local payload = redis.call("GET", KEYS[1])
|
|
3
|
return cjson.decode(payload)[ARGV[1]]
|
|
4
|
else
|
|
5
|
return nil
|
|
6
|
end
|
在這里我們檢查看key是否存在,如不存在則快速返回nil。如存在則從Redis中獲取JSON值,用cjson.decode()進行解析,然后返回請求內容。
|
1
|
redis-cli set apple '{ "color": "red", "type": "fruit" }'
|
|
2
|
=> OK
|
|
3
|
加載這段腳本進你的Redis服務器,將JSON數據保存到Redis中,通常是hash。 雖然我們每次訪問時都必須解析,但只要你的對象很小,這個操作實際上是非常快的。
如果你的API只是在內部提供,通常需要考慮效率上的問題,MessagePack 是比采用JSON更好的選擇,它更小,更快,在Redis(更多場合也是如此),MessagePack是JSON更好的替代品。
view source
print?
print?
|
1
|
if redis.call("EXISTS", KEYS[1]) == 1 then
|
|
2
|
local payload = redis.call("GET", KEYS[1])
|
|
3
|
return cmsgpack.unpack(payload)[ARGV[1]]
|
|
4
|
else
|
|
5
|
return nil
|
|
6
|
end
|
數值轉換
Lua和Redis各有自己的一套類型,因此,理解Redis與Lua在邊界調用相互轉換引起值的改變是非常重要的。一個來自Lua中number返回到Redis客戶端時變成了integer—任何數字后面的小數點都被清除了:
view source
print?
print?
|
1
|
local indiana_pi = 3.2
|
|
2
|
return indiana_pi
|
在你運行這段腳本時,Redis將返回一個整數3,丟失了pi中有用的片段。看起來很簡單,但是一旦開始進行Redis與中間腳本交互時就需要更小心。例如:
|
1
|
local indiana_pi = 3.2
|
|
2
|
redis.call("SET", "pi", indiana_pi)
|
|
3
|
return redis.call("GET", "pi")
|
執行的結果是一個字符串:“3.2”,這是為什么呢?在Redis中沒有專有的數值類型,當我們第一次調用SET的時候,Redis就已經將它保存為字符串了,將Lua初始化時將其作為一個浮點數的類型信息給丟失了。所以當我們后面取出這個值時,它就變成了一個字符串。
在Redis中,除了INCR和DECR,其它的GET,SET操作所訪問的數據都作為字符串處理。INCR與DECR是專門對數值的操作,實際上返回是整數(integer)回復(維護和存儲遵守數字規則),但Redis內部保存類型實際上還是字符串值。
總結:
下面這些都是在Redis中使用Lua時常見的錯誤:
- 表是Lua中的表達式,與很多流行語言不同。KEYS中的第一個元素是KEYS[1],第二個是KEYS[2](譯注:不是0開始)
- nil是表的結束符,[1,2,nil,3]將自動變為[1,2],因此在表中不要使用nil。
- redis.call會觸發Lua中的異常,redis.pcall將自動捕獲所有能檢測到的錯誤並以表的形式返回錯誤內容。
- Lua數字都將被轉換為整數,發給Redis的小數點會丟失,返回前把它們轉換成字符串類型。
- 確保在Lua中使用的所有KEY都在KEY表中,否則在將來的Redis版中你的腳本都有不能被很好支持的危險。
- Lua腳本和其它Redis操作一樣,在腳本執行時,其它的一切都不能運行。考慮用腳本來護展Redis服務器能力,但要保持短小和有用。
下面有許多關於Lua和Redis很好的在線資源,本文只是我所用到的很少一部分:
Lua Reference Manual
Lua Tutorial Directory
EVAL Docs
evalsha.com — 偶爾會有垃圾郵件,但內容很好(譯注:里面有很多的Lua腳本,以EVALSHA方式提供,超棒,希望對你有用。)
