今天来了解下Redis的脚本,Redis是使用 Lua 解释器来执行脚本。Redis是从2.6.0版本开始使用内置的 Lua 解释器,执行脚本的常用命令为 EVAL。
接下来,就先说下Redis脚本相关的几个命令。
1、EVAL script numkeys key [key ...] arg [arg ...]:使用 Lua 解释器执行脚本。
- EVAL的第一个参数script,是一段 Lua 5.1 脚本程序。 这段Lua脚本不需要(也不应该)定义函数。它运行在 Redis 服务器中。
- EVAL的第二个参数numkeys,是参数的个数
- 参数key [key ...] ,表示在脚本中所用到的那些 Redis 键(key),这些键名参数可以在 Lua 中通过全局变量 KEYS 数组,用 1 为基址的形式访问( KEYS[1] , KEYS[2] ,以此类推)。
- 在命令的最后,那些不是键名参数的附加参数 arg [arg …] ,可以在 Lua 中通过全局变量 ARGV 数组访问,访问的形式和 KEYS 变量类似( ARGV[1] 、 ARGV[2] ,诸如此类)。
执行EVAL命令的实例如下:
127.0.0.1:6379> EVAL "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 2 key1 key2 first second
1) "key1"
2) "key2"
3) "first"
4) "second"
2、SCRIPT LOAD script:将一个脚本装入脚本缓存,但并不立即运行它。
- EVAL 命令也会将脚本添加到脚本缓存中,但是它会立即对输入的脚本进行求值。
- 如果给定的脚本已经在缓存里面了,那么不执行任何操作。
- 在脚本被加入到缓存之后,通过 EVALSHA 命令,可以使用脚本的 SHA1 校验和来调用这个脚本。
- 脚本可以在缓存中保留无限长的时间,直到执行 SCRIPT FLUSH 为止。
127.0.0.1:6379> SCRIPT LOAD "return 1"
"e0e1f9fabfc9d4800c877a703b823ac0578ff8db"
3、EVALSHA sha1 numkeys key [key ...] arg [arg ...]:根据给定的 sha1 校验码,执行缓存在服务器中的脚本。
EVAL
命令要求你在每次执行脚本的时候都发送一次脚本主体(script body)。Redis 有一个内部的缓存机制,因此它不会每次都重新编译脚本。为了减少带宽的消耗, Redis 实现了 EVALSHA 命令,它的作用和 EVAL
一样,都用于对脚本求值,但它接受的第一个参数不是脚本,而是脚本的 SHA1 校验和(sum)。
127.0.0.1:6379> SCRIPT LOAD "return 1"
"e0e1f9fabfc9d4800c877a703b823ac0578ff8db"
127.0.0.1:6379> EVALSHA "e0e1f9fabfc9d4800c877a703b823ac0578ff8db" 0
(integer) 1
4、SCRIPT FLUSH:清除所有 Lua 脚本缓存。
127.0.0.1:6379> SCRIPT FLUSH
OK
5、SCRIPT EXISTS script[script...]:检查脚本是否存在脚本缓存里面。
- 这个命令可以接受一个或者多个脚本SHA1信息,返回一个1或者0的列表,如果脚本存在或不存在。
- 还可以使用管道技术(pipelining operation)确保脚本加载(也可以使用
SCRIPT LOAD
), 管道技术可以单独使用EVALSHA
来代替EVAL
,从而节省带宽(bandwidth)。
127.0.0.1:6379> SCRIPT LOAD "return 'hello redis'"
"69dd69fc0ba1e25d8e2972008b6baee8eccf7da6"
127.0.0.1:6379> SCRIPT EXISTS "69dd69fc0ba1e25d8e2972008b6baee8eccf7da6"
1) (integer) 1
127.0.0.1:6379> SCRIPT FLUSH
OK
127.0.0.1:6379> SCRIPT EXISTS "69dd69fc0ba1e25d8e2972008b6baee8eccf7da6"
1) (integer) 0
6、SCRIPT KILL:杀死当前正在运行的 Lua 脚本,当且仅当这个脚本没有执行过任何写操作时,这个命令才生效。
- 这个命令主要用于终止运行时间过长的脚本,比如一个因为 BUG 而发生无限 loop 的脚本。
-
SCRIPT KILL
执行之后,当前正在运行的脚本会被杀死,执行这个脚本的客户端会从 EVAL 命令的阻塞当中退出,并收到一个错误作为返回值。 - 如果当前正在运行的脚本已经执行过写操作,那么即使执行
SCRIPT KILL
,也无法将它杀死,因为这是违反 Lua 脚本的原子性执行原则的。在这种情况下,唯一可行的办法是使用SHUTDOWN NOSAVE
命令,通过停止整个 Redis 进程来停止脚本的运行,并防止不完整(half-written)的信息被写入数据库中。
127.0.0.1:6379> SCRIPT KILL
OK
7、SCRIPT DEBUG YES|SYNC|NO:开启对脚本的调试。
-
YES
:打开非阻塞异步调试模式,调试Lua脚本(回退数据修改) -
SYNC
:打开阻塞同步调试模式,调试Lua脚本(保留数据修改稿) -
NO
:关闭脚本调试模式
127.0.0.1:6379> SCRIPT DEBUG YES
OK
本文主要介绍了Redis的脚本,不过个人觉得不是深入研究Redis的话,了解下就可以了。通过本文希望能对小伙伴们有所帮助,如果有写的不对的地方,还望指出改正。