玩转 lua in Redis

Posted 2022-09-25

一、引言

        Redis学了一段时间了，基本的东西都没问题了。从今天开始讲写一些redis和lua脚本的相关的东西，lua这个脚本是一个好东西，可以运行在任何平台上，也可以嵌入到大多数语言当中，来扩展其功能。lua脚本是用C语言写的，体积很小，运行速度很快，并且每次的执行都是作为一个原子事务来执行的，我们可以在其中做很多的事情。由于篇幅很多，一次无法概述全部，这个系列可能要通过多篇文章的形式来写，好了，今天我们进入正题吧。

二、Lua简介
    
        Lua 是一个小巧的脚本语言。是巴西里约热内卢天主教大学（Pontifical Catholic University of Rio de Janeiro）里的一个研究小组，由Roberto Ierusalimschy、Waldemar Celes 和 Luiz Henrique de Figueiredo所组成并于1993年开发。 其设计目的是为了嵌入应用程序中，从而为应用程序提供灵活的扩展和定制功能。Lua由标准C编写而成，几乎在所有操作系统和平台上都可以编译，运行。Lua并没有提供强大的库，这是由它的定位决定的。所以Lua不适合作为开发独立应用程序的语言。Lua 有一个同时进行的JIT项目，提供在特定平台上的即时编译功能。

       Lua脚本可以很容易的被C/C++ 代码调用，也可以反过来调用C/C++的函数，这使得Lua在应用程序中可以被广泛应用。不仅仅作为扩展脚本，也可以作为普通的配置文件，代替XML,ini等文件格式，并且更容易理解和维护。 Lua由标准C编写而成，代码简洁优美，几乎在所有操作系统和平台上都可以编译，运行。一个完整的Lua解释器不过200k，在目前所有脚本引擎中，Lua的速度是最快的。这一切都决定了Lua是作为嵌入式脚本的最佳选择。

三、使用Lua脚本的好处

       1、减少网络开销：可以将多个请求通过脚本的形式一次发送，减少网络时延和请求次数。

       2、原子性的操作：Redis会将整个脚本作为一个整体执行，中间不会被其他命令插入。因此在编写脚本的过程中无需担心会出现竞态条件，无需使用事务。

       3、代码复用：客户端发送的脚步会永久存在redis中，这样，其他客户端可以复用这一脚本来完成相同的逻辑。

       4、速度快：见 与其它语言的性能比较, 还有一个 JIT编译器可以显著地提高多数任务的性能; 对于那些仍然对性能不满意的人, 可以把关键部分使用C实现, 然后与其集成, 这样还可以享受其它方面的好处。

       5、可以移植：只要是有ANSI C 编译器的平台都可以编译，你可以看到它可以在几乎所有的平台上运行:从 Windows 到Linux，同样Mac平台也没问题, 再到移动平台、游戏主机，甚至浏览器也可以完美使用 (翻译成JavaScript).

       6、源码小巧：20000行C代码，可以编译进182K的可执行文件，加载快，运行快。

四、redis和lua整合详解

      1、调用Lua脚本的语法：
              $ redis-cli --eval（217, 217, 217); padding: 4px 8px; cursor: default; vertical-align: top;">

库名

说明

Base

提供一些基础函数

String

提供用于字符串操作的函数

Table

提供用于表操作的函数

Math

提供数学计算函数

Debug

提供用于调试的函数

       2、在脚本中调用redis命令
               在脚本中可以使用redis.call函数调用Redis命令

              redis.call(set, foo, bar)
              local value=redis.call(get, foo) --value的值为bar

              redis.call函数的返回值就是Redis命令的执行结果

              Redis命令的返回值有5种类型，redis.call函数会将这5种类型的回复转换成对应的Lua的数据类型，具体的对应规则如下（空结果比较特殊，其对应Lua的false）

               redis返回值类型和Lua数据类型转换规则

redis返回值类型	Lua数据类型
整数回复	数字类型
字符串回复	字符串类型
多行字符串回复	table类型(数组形式)
状态回复	table类型(只有一个ok字段存储状态信息)
错误回复	table类型(只有一个err字段存储错误信息)

                  redis还提供了redis.pcall函数，功能与redis.call相同，唯一的区别是当命令执行出错时，redis.pcall会记录错误并继续执行，而redis.call会直接返回错误，不会继续执行。在脚本中可以使用return语句将值返回给客户端，如果没有执行return语句则默认返回nil

                  Lua数据类型和redis返回值类型转换规则

Lua数据类型	redis返回值类型
数字类型	整数回复(Lua的数字类型会被自动转换成整数)
字符串类型	字符串回复
table类型(数组形式)	多行字符串回复
table类型(只有一个ok字段存储状态信息)	状态回复
table类型(只有一个err字段存储错误信息)	错误回复

        3、脚本相关命令
             EVAL语法： eval（设为0)

192.168.127.128:6379>eval（set,KEYS[1],ARGV[1])" 1 name liulei
       OK

       192.168.127.128:6379>get name
       "liulei"

       4、 EVALSHA命令
              在脚本比较长的情况下，如果每次调用脚本都需要将整个脚本传给Redis会占用较多的带宽。为了解决这个问题，Redis提供了EVALSHA命令，允许开发者通过脚本内容的SHA1摘要来执行脚本，该命令的用法和EVAL一样，只不过是将脚本内容替换成脚本内容的SHA1摘要。

             Redis在执行EVAL命令时会计算脚本的SHA1摘要并记录在脚本缓存中，执行EVALSHA命令时Redis会根据提供的摘要从脚本缓存中查找对应的脚本内容，如果找到了则执行脚本，否则会返回错误："NOSCRIPT No matching script. Please use EVAL."

             在程序中使用EVALSHA命令的一般流程如下。

                 1）、先计算脚本的SHA1摘要，并使用EVALSHA命令执行脚本。

                 2）、获得返回值，如果返回“NOSCRIPT”错误则使用EVAL命令重新执行脚本。

              虽然这一流程略显麻烦，但值得庆幸的是很多编程语言的Redis客户端都会代替开发者完成这一流程。执行EVAL命令时，先尝试执行EVALSHA命令，如果失败了才会执行EVAL命令。

               SCRIPTLOAD "lua-script"  将脚本加入缓存，但不执行， 返回：脚本的SHA1摘要

               SCRIPT EXISTS lua-script-sha1   判断脚本是否已被缓存

       5、 SCRIPT FLUSH（该命令不区分大小写）
               清空脚本缓存，redis将脚本的SHA1摘要加入到脚本缓存后会永久保留，不会删除，但可以手动使用SCRIPT FLUSH命令清除全部脚本缓存。

192.168.127.128:6379>script flush
       OK

       192.168.127.128:6379>SCRIPT FLUSH
       OK

       6、SCRIPT KILL（该命令不区分大小写）
              强制终止当前脚本的执行。 但是，如果当前执行的脚步对redis的数据进行了写操作，则SCRIPT KILL命令不会终止脚本的运行，以防止脚本只执行了一部分。脚本中的所有命令，要么都执行，要么都不执行。

192.168.127.128:6379>script kill
      (error)NOTBUSY No scripts in execution right now

      192.168.127.128:6379>SCRIPT KILL
      (error)NOTBUSY No scripts in execution right now
       //这是当前没有脚本在执行，所以提示该错误

       7、lua-time-limit 5000（redis.conf配置文件中）

              为了防止某个脚本执行时间过长导致Redis无法提供服务（比如陷入死循环），Redis提供了lua-time-limit参数限制脚本的最长运行时间，默认为5秒钟。当脚本运行时间超过这一限制后，Redis将开始接受其他命令但不会执行（以确保脚本的原子性，因为此时脚本并没有被终止），而是会返回“BUSY”错误。

​

作者：sunsky303