欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Redis如何使用lua脚本实例教程

程序员文章站 2022-11-21 15:17:01
前言 在redis的官网上洋洋洒洒的大概提供了200多个命令,貌似看起来很多,但是这些都是别人预先给你定义好的,但你却不能按照自己的意图进行定制, 所以是不是感觉自己还...

前言

在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个逼格 - 一线码农


2、redis执行lua脚本示例 - yanghuahui


3、eval - redis


4、phpredis 执行lua脚本的例子 - jingtan的专栏


5、lua-book

http://me.52fhy.com/lua-book/

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。