Redis如何使用lua脚本实例教程
前言
在redis的官网上洋洋洒洒的大概提供了200多个命令，貌似看起来很多，但是这些都是别人预先给你定义好的，但你却不能按照自己的意图进行定制，
所以是不是感觉自己还是有一种被束缚的感觉，有这个感觉就对了。。。
说来也巧，redis的大老板给了你解决这种问题的方法，那就是Lua脚本，而且redis的最新版本也支持Lua Script debug，这应该也是未来Redis的一
个发展趋势，要想学好Redis，必会Lua Script。。。
下面话不多说了，来一起看看详细的介绍吧
版本：自2.6.0起可用。
时间复杂度：取决于执行的脚本。
使用Lua脚本的好处：
- 减少网络开销。可以将多个请求通过脚本的形式一次发送，减少网络时延。
- 原子操作。redis会将整个脚本作为一个整体执行，中间不会被其他命令插入。因此在编写脚本的过程中无需担心会出现竞态条件，无需使用事务。
- 复用。客户端发送的脚步会永久存在redis中，这样，其他客户端可以复用这一脚本而不需要使用代码完成相同的逻辑。
如何使用
基本使用
命令格式：
EVAL script numkeys key [key ...] arg [arg ...]
说明：
- script是第一个参数，为Lua 5.1脚本。该脚本不需要定义Lua函数（也不应该）。
- 第二个参数numkeys指定后续参数有几个key。
- key [key ...]，是要操作的键，可以指定多个，在lua脚本中通过KEYS[1], KEYS[2]获取
- arg [arg ...]，参数，在lua脚本中通过ARGV[1], ARGV[2]获取。
简单实例：
127.0.0.1:6379> eval "return ARGV[1]" 0 100
"100"
127.0.0.1:6379> eval "return {ARGV[1],ARGV[2]}" 0 100 101
1) "100"
2) "101"
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"
127.0.0.1:6379> eval "redis.call('SET', KEYS[1], ARGV[1]);redis.call('EXPIRE', KEYS[1], ARGV[2]); return 1;" 1 test 10 60
(integer) 1
127.0.0.1:6379> ttl test
(integer) 59
127.0.0.1:6379> get test
"10"
注：
- {}在lua里是指数据类型table，类似数组。
- redis.call()可以调用redis命令。
命令行里使用
如果直接使用redis-cli命令，格式会有点不一样：
redis-cli --eval lua_file key1 key2 , arg1 arg2 arg3
注意的地方：
- eval 后面参数是lua脚本文件,.lua后缀
- 不用写numkeys，而是使用,隔开。注意,前后有空格。
示例：
incrbymul.lua
local num = redis.call('GET', KEYS[1]);
if not num then
return 0;
else
local res = num * ARGV[1];
redis.call('SET',KEYS[1], res);
return res;
end
命令行运行：
$ redis-cli --eval incrbymul.lua lua:incrbymul , 8 (integer) 0 $ redis-cli incr lua:incrbymul (integer) 1 $ redis-cli --eval incrbymul.lua lua:incrbymul , 8 (integer) 8 $ redis-cli --eval incrbymul.lua lua:incrbymul , 8 (integer) 64 $ redis-cli --eval incrbymul.lua lua:incrbymul , 2 (integer) 128
由于redis没有提供命令可以实现将一个数原子性的乘以N倍，这里我们就用Lua脚本实现了，运行过程中确保不会被其它客户端打断。
phpredis里使用
接着上面的例子：
incrbymul.php
<?php
$lua = <<<EOF
local num = redis.call('GET', KEYS[1]);
if not num then
return 0;
else
local res = num * ARGV[1];
redis.call('SET',KEYS[1], res);
return res;
end
EOF;
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);
$ret = $redis->eval($lua, array("lua:incrbymul", 2), 1);
echo $ret;
运行：
$ redis-cli set lua:incrbymul 0 OK $ redis-cli incr lua:incrbymul (integer) 1 $ php incrbymul.php 2 $ php incrbymul.php 4
eval原型：
Redis::eval(string script, [array keys, long num_keys])
eval函数的第3个参数为KEYS个数，phpredis依据此值将KEYS和ARGV做区分。
参考
1、在redis中使用lua脚本让你的灵活性提高5个逼格 - 一线码农
https://www.jb51.net/article/148830.htm
2、Redis执行Lua脚本示例 - yanghuahui
https://www.jb51.net/article/148833.htm
3、EVAL - Redis
https://redis.io/commands/eval
4、phpredis 执行LUA脚本的例子 - jingtan的专栏
https://www.jb51.net/article/148838.htm
5、lua-book
http://me.52fhy.com/lua-book/
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。
相关文章
这篇文章主要为大家介绍了redis缓存存储Session原理机制详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2021-11-11
在实际生产环境中为保证Redis的服务连续性和可靠性,需要设计一个高可用架构,本文就来介绍一下Redis高可用的三种实现方式,主要包括主从复制模式,Redis Sentinel模式和Redis Cluster模式,感兴趣的可以了解一下2023-12-12
本文主要介绍了Redis客户端连接机制的实现方案,包括事件驱动模型、非阻塞I/O处理、连接池应用及配置优化,具有一定的参考价值,感兴趣的可以了解一下2025-07-07
本文主要介绍了Redis服务端主动回收配置的使用小结,包括客户端主动回收、连接池配置、连接泄漏检测及服务端策略设置,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧2025-08-08
Redis报错UnrecognizedPropertyException: Unrecognized
在使用SpringBoot访问Redis时,报错提示识别不了属性headPart,经过排查,发现并非Serializable或getset方法问题,而是存在一个方法getHeadPart,但无headPart属性,解决方案是将getHeadPart改为makeHeadPart2024-10-10
这篇文章主要介绍了基于Redis+Lua脚本实现分布式限流组件封装,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-10-10
本文主要介绍了redis list类型命令的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-07-07
这篇文章主要介绍了Redis持久化深入详解，讲解的还是比较详细的，有感兴趣的同学可以学习下2021-03-03
Redis通过惰性删除策略和定期删除策略来管理过期键,惰性删除策略在键被访问时检查是否过期并删除,节省CPU开销但可能导致过期键滞留,定期删除策略定期扫描并删除过期键,保证数据库干净但可能影响性能,Redis默认同时使用两种策略2025-01-01
redis8.0新特性之布谷鸟过滤器(Cuckoo Filter)的使用
布谷鸟过滤器是一种概率数据结构,就像布隆过滤器一样,可以以非常快速且节省空间的方式检查元素是否存在于集合中,同时还支持删除操作,并在某些场景下表现优于布隆过滤器,感兴趣的可以了解一下2025-08-08
最新评论