redis从2.6版本开始内置支持Lua解释器,解释器提供了3个函数来处理redis的命令 redis.call() redis.pcall() 和 redis.log()
为什么使用redis执行Lua脚本
redis执行命令是单线程执行,6.x支持多线程,redis的多线程部分只是用来处理网络数据的读写和协议解析,执行命令仍然是单线程顺序执行。
redis保证脚本会以原子性的方式执行。这是一个很重要的因素。
因为reids的单线程执行特性,lua脚本可以作为一个单元被redis执行,这个执行的过程不会被其他客户端的其他命令打断,简单来说lua脚本对于redis来讲具有原子性。在实际开发过程中,往往借助lua脚本原子性的特点,实现无锁化的线程安全。
示例:
<?php
$luaScript = <<<LUA
-- 50行lua代码逻辑
local a = 3;
redis.call('set', 'name', 3)
return a
LUA;
// 上面的50行lua代码放到redis中,相当于一条原子命令执行,实现了无锁化保障高并发下线程(进程)数据安全
$result = (new predis())->eval($luaScript);
?>
命令及系统方法详解
- EVAL 命令
EVAL script numkeys key [key …] arg [arg …]
- script lua脚本内容 注意的是脚本不应该是Lua函数。
- numkeys 表示指定键名参数的个数(key的个数)。
- key [key ...] 表示脚本对应的key值列表 在脚本中可以使用KEYS[1] KEYS[2] KEYS[3]KEYS[n] n从1开始 。
- arg [arg ...] 命名行中传递的参数列表 在脚本中可以使用ARGV[1] ARGV[2] ARGV[3]ARGV[n] n从1开始。
传入的key,v值并不是k,v对应,而是所有的key放到了名为KEYS的table中,所有的v放入到了名为ARGV的table中,EVAL命令只对key的数量做了限制(numkeys)
示例
numkeys=2时,key1,key2为传入的两个key,first,second为传入的两个v
127.0.0.1:6>eval "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 2 key1 key2 first second
1) "key1"
2) "key2"
3) "first"
4) "second"
numkeys=1时,key1为传入的一个key,key2,first,second为传入的三个v
127.0.0.1:6>eval "return {KEYS[1],ARGV[1],ARGV[2],ARGV[3]}" 1 key1 key2 first second
1) "key1"
2) "key2"
3) "first"
4) "second"
获取KEYS、ARGV两个系统table的元素个数
127.0.0.1:6>eval "return {#KEYS,#ARGV}" 1 key1 key2 first second
1) "1"
2) "3"
redis-cli 运行lua 脚本
redis-cli -h host -p port -a password -n db --eval demo.lua k1,k2,a1,a2
连接远程redis 并运行当前文件夹下的test.lua脚本。其中,-n 后接的参数为选择的redis的第几个数据库。 后面"k1,k2,a1,a2"的在lua脚本中获取的方式是使用全局变量 KEYS 和 ARGV。
如果连接本地的redis运行脚本则可省略几个参数。
redis-cli -n db --eval demo.lua k1,k2,a1,a2
BucketT.lua
local key = KEYS[1]
local intervalPerTokens = tonumber(ARGV[1])
local curTime = tonumber(ARGV[2])
local initTokens = tonumber(ARGV[3])
return {key,intervalPerTokens,curTime,initTokens}
执行:
redis-cli.exe -n 13 --eval BucketT.lua k1,k2,a1,a2
- EVALSHA 命令
2.1 EVALSHA sha1 numkeys key [key …] arg [arg …]
此命令和EVAL的区别是EVAL每次都需要传入脚本的主体内容,对网络带宽不是很友好,而EVALSHA命令正好可以解决这个问题
- sha1 缓存中的sha值 这个值可以利用SCRIPT LOAD生成。
- numkeys 表示指定键名参数的个数。
- key [key ...] 表示脚本对应的key值列表 在脚本中可以使用KEYS[1] KEYS[2] KEYS[3]KEYS[n] n从1开始。
- arg [arg ...] 命名行中传递的参数列表 在脚本中可以使用ARGV[1] ARGV[2] ARGV[3]ARGV[n] n从1开始。
示例
// 首先利用SCRIPT LOAD把脚本的主体缓存在redis中,会返回一个sha的key
127.0.0.1:6>SCRIPT LOAD "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}"
"a42059b356c875f0717db19a51f6aaca9ae659ea"
// EVALSHA执行命令把sha带上,其他的和eval没有区别
127.0.0.1:6>EVALSHA a42059b356c875f0717db19a51f6aaca9ae659ea 2 id name 2 mytest
1) "id"
2) "name"
3) "2"
4) "mytest"
2.2 解释一下SCRIPT相关的命令
redis保证了所有运行过的脚本都能缓存起来,上面也提到过使用SCRIPT LOAD也能将脚本缓存并返回sha值,那么也能使用SCRIPT FLUSH清空脚本缓存
- SCRIPT LOAD 加载脚本到缓存中,返回sha值
- SCRIPT FLUSH 清除所有 Lua 脚本缓存
- SCRIPT EXISTS 判断sha值是否已经缓存好了,返回值为0和1,后者表示存在于缓存中,在程序开发中非常有用,比如 redis出现了什么异常情况后,脚本缓存被清空了,或者被人为执行了SCRIPT FLUSH命令,这个时候就可以优先尝试一下SCRIPT EXISTS命令如果返回0表示不存在,就需要先执行SCRIPT LOAD先把脚本加载到缓存中之后再执行
- SCRIPT KILL 杀死当前正在运行的Lua脚本,当且仅当这个脚本没有执行过任何写操作时,这个命令才生效,执行成功返回OK,其他情况返回错误信息
- redis.call(),redis.pcall()函数
区别就是处理错误异常的情况不同,其他的功能一样
- redis.call() 执行命令的过程中发生错误时,脚本会停止执行,并返回一个脚本错误
- redis.pcall() 执行命令的过程中发生错误时,脚本会继续执行,但是会记录错误信息返回一个带err域的Lua表(table)
- redis.log(loglevel, message) 函数
触发redis记录日志,日志级别有redis.LOG_DEBUG redis.LOG_VERBOSE redis.LOG_NOTICE redis.LOG_WARNING