Lua:给Redis用户的入门指导
可能你已經(jīng)聽說過Redis中嵌入了腳本語言，但是你還沒有親自去嘗試吧?
這個入門教程會讓你學會在你的Redis 服務(wù)器上使用強大的lua語言。
Hello, Lua!
我們的第一個Redis Lua 腳本僅僅返回一個字符串，而不會去與redis 以任何有意義的方式交互。
local msg = "Hello, world!"
return msg
這是非常簡單的，第一行代碼定義了一個本地變量msg存儲我們的信息，第二行代碼表示從redis服務(wù)端返回msg的值給客戶端。保存這個文件到hello.lua,像這樣去運行:
redis-cli EVAL "$(cat hello.lua)" 0
運行這段代碼會打印"Hello,World!", EVAL在第一個參數(shù)是我們的lua腳本，這我們用cat命令從文件中讀取我們的腳本內(nèi)容。第二個參數(shù)是這個腳本需要訪問的Redis的鍵的數(shù)字號。我們簡單的"Hello Script"不會訪問任何鍵，所以我們使用0
訪問鍵和參數(shù)
假設(shè)我們要建立一個URL簡寫服務(wù)器。我們就要去存儲每條進入的URL并返回一個唯一數(shù)值，以便以后通過這個數(shù)值訪問到該URL。
我們將利用Lua腳本立即從Redis中用INCRand獲取一個唯一標識ID，以這個標識ID作為URL存儲于一個哈希中的鍵值:
local link_id = redis.call("INCR", KEY[1])
redis.call("HSET", KEYS[2], link_id, ARGV[1])
return link_id
我們將用call()函數(shù)首次訪問Redis。call()的參數(shù)就是發(fā)給Redis的命令:首先INCR <key>,然后HSET <key> <field> <value>。這兩個命令將依次執(zhí)行----當這個腳本執(zhí)行時，Redis不會做任何事，它將非常快地運行。
我們將會訪問兩個Lua表:KEYS和ARGV。表單式關(guān)聯(lián)性數(shù)組和結(jié)構(gòu)化數(shù)據(jù)的Lua唯一機制。對于我們的意圖，你可以把它們看做是一個你所熟悉的任意語言對等的數(shù)組，但是提醒兩個很容易困擾到新手的兩個Lua定則:
- 表是基于1的，也就說索引以數(shù)值1開始。所以在表中的第一個元素就是mytable[1],第二個就是mytable[2]等等。
- 表中不能有nil值。如果一個操作表中有[1, nil, 3, 4],那么結(jié)果將會是[1] ----表將會在第一個nil截斷。
當調(diào)用這個腳本時，我們還需要傳遞KEYS和ARGV表的值:
redis-cli EVAL "$(cat incr-and-stor.lua)" 2 links:counter links:urls http://malcolmgladwellbookgenerator.com/
在EVAL語句中，2指出需要傳入的KEY的個數(shù)，后面跟著需要傳入的兩個KEY，最后傳入的是ARGV的值。在Redis中執(zhí)行Lua腳本時，Redis-cli會檢查傳入KEY的個數(shù)，除非傳入的完全是命令。
為了解釋得更清楚，下面列出替換KEY和ARGV后的腳本:
local link_id = redis.call("INCR", "links:counter")
redis.call("HSET", "links:urls", link_id, "http://malcolmgladwellbookgenerator.com")
return link_id
為Redis編寫Lua腳本時，每個KEY都是通過KEYS表指定。ARGV表用來傳遞參數(shù)，這個例子中ARGV用來傳入URL。
邏輯條件：increx與hincrex
上一個例子保存鏈接短網(wǎng)址，想要知道這個鏈接的點擊次數(shù)，在Redis中添加一個hash計數(shù)器。當帶有鏈接標記的用戶訪問時，我們檢查其是否存在，如存在則需要給計數(shù)器加1:
if redis.call("HEXISTS", KEYS[1], ARGV[1]) == 1 then
? ? return redis.call("HINCR", KEYS[1], ARGV[1])
else
? ? return nil
end
每次有人點擊短網(wǎng)址，我們運行這個腳本跟蹤這個鏈接被再次分享。我們用EVAL來調(diào)用腳本，傳入inlinks:visits(keys[1])和上一個腳本返回的鏈接標識(ARGV[1])。
這段腳本將檢查是否存在相同的hash，如果存在就為這個標準的Redis KEY加1.
if redis.call("EXISTS", KEYS[1]) == 1 then
? ? return redis.call("INCR", KEYS[1])
else
? ? return nil
end
腳本加載與注冊執(zhí)行
注意，當Redis在運行l(wèi)ua腳本的時候，其他的事情什么都干不了!腳本最好只是簡單的擴展Redis進行較小的原子操作和簡單的邏輯控制需要，Lua腳本中的bug可能引發(fā)整個Redis服務(wù)器鎖---最好保持腳本的簡短和易于調(diào)試。
雖然這些腳本一般都比較短小，但我們還是希望不要每次執(zhí)行時都使用完整的Lua腳本，實際上可以在程序一步一步(譯注:application boots翻譯有難度)開發(fā)中注冊Lua腳本(或者在你部署時注冊),然后用注冊后生成的SHA-1標識來進行調(diào)用。
redis-cli SCRIPT LOAD "return 'hello world'"
=>?"5332031c6b470dc5a0dd9b4bf2030dea6d65de91"
redis-cli EVALSHA 5332031c6b470dc5a0dd9b4bf2030dea6d65de91 0 => "hello world"顯示調(diào)用SCRIPT LOAD通常是不必要的，當一個程序執(zhí)行EVAL時就已隱式加載了。程序會先嘗試EAVALSHA，當腳本沒有找到時會調(diào)用EVAL。
對于Ruby開發(fā)者，可以看一下Shopify’s?Wolverine，其可以為Ruby應(yīng)用簡單的加載并存儲Lua腳本。對于PHP開發(fā)者，Predis?支持加載Lua腳本作為普通Redis命令進行調(diào)用（譯注：需要繼承Predis\Command\ScriptedCommand基類，并注冊命令）。如果你使用這些或者其它的工具來標準化與Lua的交互，請讓我知道，我很感興趣知道本文之外的內(nèi)容。
何時使用Lua
Redis支持WATCH/MULTI/EXEC這樣的塊，能進行一組操作，也能一起提交執(zhí)行，看起來與Lua有重疊。應(yīng)該如何進行選擇？MULT塊中所有操作獨立，但在Lua中，后面的操作能依賴前面操作的執(zhí)行結(jié)果。同時使用Lua腳本還能夠避免WATCH使用后競爭條件引起客戶端反應(yīng)變慢的情況。
在RedisGreen（譯注:國外一家專門提供Redis主機的服務(wù)商），我們看到許多應(yīng)用使用Lua的同時也使用MULTI/EXEC，但兩者但不是替代關(guān)系。許多成功的Lua腳本都很小，僅僅實現(xiàn)一個你的應(yīng)用需要而Redis命令中沒有單一的功能。
訪問庫
Redis的Lua解釋器加載七個庫:base, table, string, math, debug, cjson和cmsgpack。前幾個都是
標準庫，充許你使用任何語言進行基本的操作。后面兩個可以讓Redis支持JSON和MessagePack—這是非常有用的功能，同時我也很想知道為什么常常看不到這種用法。
Web應(yīng)用程序常常使用JSON作為api返回數(shù)據(jù)，你也許也可以把一堆JSON數(shù)據(jù)存到Redis的key中。當想訪問某些JSON數(shù)據(jù)時，首先需要保存到一個hash中，使用Redis的JSON支持將非常方便：
if redis.call("EXISTS", KEYS[1]) == 1 then
? ? local payload = redis.call("GET", KEYS[1])
? ? return cjson.decode(payload)[ARGV[1])
else
? ? return nil
end
在這里我們檢查看key是否存在，如不存在則快速返回nil。如存在則從Redis中獲取JSON值，用cjson.decode()進行解析，然后返回請求內(nèi)容。
redis-cli set apple '{ "color": "red", "type": "fruit" }'
=> OK
redis-cli eval "${cat json-get.lua)" 1 apple type
=> "fruit"
加載這段腳本進你的Redis服務(wù)器，將JSON數(shù)據(jù)保存到Redis中，通常是hash。?雖然我們每次訪問時都必須解析，但只要你的對象很小，這個操作實際上是非常快的。
如果你的API只是在內(nèi)部提供，通常需要考慮效率上的問題，MessagePack?是比采用JSON更好的選擇，它更小，更快，在Redis（更多場合也是如此），MessagePack是JSON更好的替代品。
if redis.call("EXISTS", KEYS[1]) == 1 then
? ? local payload = redis.call("GET", KEYS[1])
? ? return cmsgpack.unpack(payload)[ARGV[1])
else
? ? return nil
end
數(shù)值轉(zhuǎn)換
Lua和Redis各有自己的一套類型，因此，理解Redis與Lua在邊界調(diào)用相互轉(zhuǎn)換引起值的改變是非常重要的。一個來自Lua中number返回到Redis客戶端時變成了integer—任何數(shù)字后面的小數(shù)點都被清除了：
local indiana_pi = 3.2 return indiana_pi在你運行這段腳本時，Redis將返回一個整數(shù)3，丟失了pi中有用的片段。看起來很簡單，但是一旦開始進行Redis與中間腳本交互時就需要更小心。例如：
local indiana_pi = 3.2 redis.call("SET", "pi", indiana_pi) return redis.call("GET", "pi")執(zhí)行的結(jié)果是一個字符串：“3.2”，這是為什么呢？在Redis中沒有專有的數(shù)值類型，當我們第一次調(diào)用SET的時候，Redis就已經(jīng)將它保存為字符串了，將Lua初始化時將其作為一個浮點數(shù)的類型信息給丟失了。所以當我們后面取出這個值時，它就變成了一個字符串。
在Redis中，除了INCR和DECR，其它的GET，SET操作所訪問的數(shù)據(jù)都作為字符串處理。INCR與DECR是專門對數(shù)值的操作，實際上返回是整數(shù)（integer）回復（維護和存儲遵守數(shù)字規(guī)則），但Redis內(nèi)部保存類型實際上還是字符串值。
總結(jié)：
下面這些都是在Redis中使用Lua時常見的錯誤：
- 表是Lua中的表達式，與很多流行語言不同。KEYS中的第一個元素是KEYS[1]，第二個是KEYS[2]（譯注：不是0開始）
- nil是表的結(jié)束符，[1,2,nil,3]將自動變?yōu)閇1,2]，因此在表中不要使用nil。
- redis.call會觸發(fā)Lua中的異常，redis.pcall將自動捕獲所有能檢測到的錯誤并以表的形式返回錯誤內(nèi)容。
- Lua數(shù)字都將被轉(zhuǎn)換為整數(shù)，發(fā)給Redis的小數(shù)點會丟失，返回前把它們轉(zhuǎn)換成字符串類型。
- 確保在Lua中使用的所有KEY都在KEY表中，否則在將來的Redis版中你的腳本都有不能被很好支持的危險。
- Lua腳本和其它Redis操作一樣，在腳本執(zhí)行時，其它的一切都不能運行。考慮用腳本來護展Redis服務(wù)器能力，但要保持短小和有用。
補充讀物
下面有許多關(guān)于Lua和Redis很好的在線資源，本文只是我所用到的很少一部分：
- Lua Reference Manual
- Lua Tutorial Directory
- EVAL Docs
- evalsha.com?— 偶爾會有垃圾郵件，但內(nèi)容很好（譯注：里面有很多的Lua腳本，以EVALSHA方式提供，超棒，希望對你有用。）
總結(jié)
以上是生活随笔為你收集整理的Lua:给Redis用户的入门指导的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： libxml2中文支持
- 下一篇： Redis Monitor命令 - 实时