(转) Lua: 给 Redis 用户的入门指导

[align=left]可能你已经听说过Redis 中嵌入了脚本语言，但是你还没有亲自去尝试吧？ 这个入门教程会让你学会在你的Redis 服务器上使用强大的lua语言。[/align]
Hello, Lua!

[align=left]我们的第一个Redis Lua 脚本仅仅返回一个字符串，而不会去与redis 以任何有意义的方式交互。[/align]

[align=left]1[/align]

[align=left]local msg = "Hello, world!"[/align]

view source

print?

[align=left]1[/align]

[align=left]local link_id = redis.call("INCR", KEY[1])[/align]

[align=left]2[/align]

[align=left]redis.call("HSET", KEYS[2], link_id, ARGV[1])[/align]

[align=left]3[/align]

[align=left]return link_id[/align]

我
们将用call()函数首次访问Redis。call()的参数就是发给Redis的命令：首先INCR <key>, 然后HSET
<key> <field>
<value>。这两个命令将依次执行——当这个脚本执行时，Redis不会做任何事，它将非常快地运行。
[align=left]我们将会访问两个Lua表：KEYS和ARGV。表单是关联性数组和结构化数据的Lua唯一机制。对于我们的意图，你可以把它们看做是一个你所熟悉的任意语言对等的数组，但是提醒两个很容易困扰到新手的两个Lua定则：[/align]

表是基于1的，也就是说索引以数值1开始。所以在表中的第一个元素就是mytable[1]，第二个就是mytable[2]等等。

表中不能有nil值。如果一个操作表中有[1, nil, 3, 4]，那么结果将会是[1]——表将会在第一个nil截断。

[align=left]当调用这个脚本时，我们还需要传递KEYS和ARGV表的值：[/align]

[align=left]1[/align]

[align=left]redis-cli EVAL "$(cat incr-and-stor.lua)"2 links:counter links:urls http://malcolmgladwellbookgenerator.com/[/align]

[align=left]在EVAL语句中，2指出需要传入的KEY的个数，后面跟着需要传入的两个KEY，最后传入是ARGV的值。在Redis中执行Lua脚本时，Redis-cli会检查传入KEY的个数，除非传入的完全是命令。[/align]
[align=left]为了解释得更清楚，下面列出替换KEY和ARGV后的脚本：[/align]

view source

print?

[align=left]1[/align]

[align=left]local link_id = redis.call("INCR", "links:counter")[/align]

view source

print?

[align=left]1[/align]

[align=left]if redis.call("EXISTS",KEYS[1]) == 1 then[/align]

[align=left]2[/align]

[align=left]return redis.call("INCR",KEYS[1])[/align]

[align=left]3[/align]

[align=left]else[/align]

[align=left]4[/align]

[align=left]return nil[/align]

[align=left]5[/align]

[align=left]end[/align]

[align=left] [/align]
脚本加载与注册执行
[align=left]注意，当Redis在运行Lua脚本的时候，其它的事情什么都干不了！脚本最好只是简单的扩展Redis进行较小的原子操作和简单的逻辑控制需要，Lua脚本中的bug可能引发整个Redis服务器锁—最好保持脚本的简短和易于调试。[/align]
[align=left]虽然这些脚本一般都比较短小，但我们还是希望不要每次执行时都使用完整的Lua脚本，实际上可以在程序一步一步（译注：application boots翻译有难度）开发中注册Lua脚本（或者在你部署时注册），然后用注册后生成的SHA-1标识来进行调用。[/align]

view source

print?

[align=left]1[/align]

[align=left]redis-cli SCRIPT LOAD "return 'hello world'"[/align]

[align=left] [/align]

[align=left]3[/align]

[align=left] [/align]

脚本加载与注册执行
[align=left]注意，当Redis在运行Lua脚本的时候，其它的事情什么都干不了！脚本最好只是简单的扩展Redis进行较小的原子操作和简单的逻辑控制需要，Lua脚本中的bug可能引发整个Redis服务器锁—最好保持脚本的简短和易于调试。[/align]
[align=left]虽然这些脚本一般都比较短小，但我们还是希望不要每次执行时都使用完整的Lua脚本，实际上可以在程序一步一步（译注：application boots翻译有难度）开发中注册Lua脚本（或者在你部署时注册），然后用注册后生成的SHA-1标识来进行调用。[/align]

view source

print?

[align=left]1[/align]

[align=left]redis-cli SCRIPT LOAD "return 'hello world'"[/align]

[align=left] [/align]

[align=left]3[/align]

[align=left] [/align]

何时使用Lua
Redis
支持WATCH/MULTI/EXEC这样的块，能进行一组操作，也能一起提交执行，看起来与Lua有重叠。应该如何进行选择？MULT块中所有操作独
立，但在Lua中，后面的操作能依赖前面操作的执行结果。同时使用Lua脚本还能够避免WATCH使用后竞争条件引起客户端反应变慢的情况。
在RedisGreen（译注:国外一家专门提供Redis主机的服务商），我们看到许多应用使用Lua的同时也使用MULTI/EXEC，但两者但不是替代关系。许多成功的Lua脚本都很小，仅仅实现一个你的应用需要而Redis命令中没有单一的功能。

访问库


[align=left]Redis的Lua解释器加载七个库:base，table，string， math， debug，cjson和cmsgpack。前几个都是标准库，充许你使用任何语言进行基本的操作。后面两个可以让Redis支持JSON和MessagePack—这是非常有用的功能，同时我也很想知道为什么常常看不到这种用法。[/align]
[align=left]Web应用程序常常使用JSON作为api返回数据，你也许也可以把一堆JSON数据存到Redis的key中。当想访问某些JSON数据时，首先需要保存到一个hash中，使用Redis的JSON支持将非常方便：[/align]

view source

print?

[align=left]1[/align]

[align=left]if redis.call("EXISTS", KEYS[1]) == 1 then[/align]

[align=left]2[/align]

[align=left]local payload = redis.call("GET", KEYS[1])[/align]

[align=left]3[/align]

[align=left]return cjson.decode(payload)[ARGV[1]][/align]

[align=left]4[/align]

[align=left]else[/align]

[align=left]5[/align]

[align=left]return nil[/align]

[align=left]6[/align]

[align=left]end[/align]

[align=left]在这里我们检查看key是否存在，如不存在则快速返回nil。如存在则从Redis中获取JSON值，用cjson.decode()进行解析，然后返回请求内容。[/align]

[align=left]1[/align]

[align=left]redis-cli set apple '{ "color": "red", "type": "fruit" }'[/align]

[align=left]2[/align]

[align=left]=> OK[/align]

[align=left]3[/align]

[align=left] [/align]

[align=left]加载这段脚本进你的Redis服务器，将JSON数据保存到Redis中，通常是hash。 虽然我们每次访问时都必须解析，但只要你的对象很小，这个操作实际上是非常快的。[/align]
[align=left]如果你的API只是在内部提供，通常需要考虑效率上的问题，MessagePack 是比采用JSON更好的选择，它更小，更快，在Redis（更多场合也是如此），MessagePack是JSON更好的替代品。[/align]

view source

print?

[align=LEFT]1[/align]

[align=LEFT]if redis.call("EXISTS", KEYS[1]) == 1 then[/align]

[align=LEFT]2[/align]

[align=LEFT]local payload = redis.call("GET", KEYS[1])[/align]

[align=LEFT]3[/align]

[align=LEFT]return cmsgpack.unpack(payload)[ARGV[1]][/align]

[align=LEFT]4[/align]

[align=LEFT]else[/align]

[align=LEFT]5[/align]

[align=LEFT]return nil[/align]

[align=LEFT]6[/align]

[align=LEFT]end[/align]

数值转换
[align=left]Lua和Redis各有自己的一套类型，因此，理解Redis与Lua在边界调用相互转换引起值的改变是非常重要的。一个来自Lua中number返回到Redis客户端时变成了integer—任何数字后面的小数点都被清除了：[/align]

view source

print?

[align=LEFT]1[/align]

[align=LEFT]local indiana_pi = 3.2[/align]

[align=LEFT]2[/align]

[align=LEFT]return indiana_pi[/align]

[align=left]在你运行这段脚本时，Redis将返回一个整数3，丢失了pi中有用的片段。看起来很简单，但是一旦开始进行Redis与中间脚本交互时就需要更小心。例如：[/align]

[align=LEFT]1[/align]

[align=LEFT]local indiana_pi = 3.2[/align]

[align=LEFT]2[/align]

[align=LEFT]redis.call("SET", "pi", indiana_pi)[/align]

[align=LEFT]3[/align]

[align=LEFT]return redis.call("GET", "pi")[/align]

[align=left]执行的结果是一个字符串：“3.2”，这是为什么呢？在Redis中没有专有的数值类型，当我们第一次调用SET的时候，Redis就已经将它保存为字符串了，将Lua初始化时将其作为一个浮点数的类型信息给丢失了。所以当我们后面取出这个值时，它就变成了一个字符串。[/align]
在Redis中，除了INCR和DECR，其它的GET，SET操作所访问的数据都作为字符串处理。INCR与DECR是专门对数值的操作，实际上返回是整数（integer）回复（维护和存储遵守数字规则），但Redis内部保存类型实际上还是字符串值。

总结：
[align=left]下面这些都是在Redis中使用Lua时常见的错误：[/align]

表是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服务器能力，但要保持短小和有用。

补充读物补充读物
[align=left]下面有许多关于Lua和Redis很好的在线资源，本文只是我所用到的很少一部分：[/align]

Lua Reference ManualLua Tutorial DirectoryEVAL Docsevalsha.com — 偶尔会有垃圾邮件，但内容很好（译注：里面有很多的Lua脚本，以EVALSHA方式提供，超棒，希望对你有用。）