Redis的Lua脚本和函数

已于 2022-05-07 23:13:02 修改
阅读量1.6k 收藏 3
点赞数 2
分类专栏： DB Linux 文章标签： lua redis 数据库
于 2022-05-07 23:05:13 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/duke_ding2/article/details/124629604
版权
DB 同时被 2 个专栏收录
32 篇文章 0 订阅
订阅专栏
Linux
19 篇文章 0 订阅
订阅专栏

环境：

  • 操作系统： Ubuntu 20.04
  • Redis：7.0.0

我们知道Redis主要用途是数据存储，而可编程性（programmability）意味着用户可以在Redis服务器上运行自定义的脚本，实现自定义逻辑。用户脚本是在Redis的嵌入式沙箱脚本引擎中运行的，也就是Lua解释器。

使用脚本的优点如下：

  • 可编程性：实现自定义的逻辑；
  • 性能：脚本是一次性执行的，节省了与Redis服务器往返交互的开销，另外，对数据的读写都是在服务器端进行了，因此性能非常高效；
  • 原子性：脚本运行是原子的，避免了竞态条件（race condition）；

注意：脚本虽然在服务器端运行，但是被视为客户端程序的一部分。脚本在服务器端只是被缓存起来，一旦丢失（比如清除脚本，或者重启服务器），客户端需要把脚本重新传到服务器端。从Redis 7.0起，Redis提供了一种被称为“函数”的服务器端的编程方式。

  • Redis 6.2及以下，可用 eval 和 script 命令来运行和管理脚本；
  • Redis 7.0及以上，可用 fcall 和 function 命令来运行和管理脚本；

Lua脚本

eval / evalsha 命令

eval 命令的格式如下：

EVAL script numkeys [key [key ...]] [arg [arg ...]]
  • script：脚本内容
  • numkeys：参数中key的数量
  • key：Redis的key，在脚本中用 KEYS[n] 来引用，注意要大写， n 从1开始计数
  • arg：其它参数，在脚本中用 ARGV[n] 来引用，注意要大写， n 从1开始计数

比如，最简单的“hello world”脚本如下：

127.0.0.1:6379> eval "return 'hello world'" 0
"hello world"
127.0.0.1:6379>

本例中脚本内容为 return 'hello world' ，参数中key的数量为0。

再来看一个带参数的脚本：

127.0.0.1:6379> eval "return ARGV[1]" 0 "hello world"
"hello world"
127.0.0.1:6379>

注意：ARGV 必须用大写。

本例中，参数里key的数量为0，但是有一个其它参数，在脚本中用 ARGV[1] 来引用。

evalsha 命令的用法参见下面的 scirpt 部分。

redis.call() / redis.pcall() 方法

在Lua脚本中，可以通过 redis.call() （或者 redis.pcall() ）来运行Redis命令。

redis.call() 格式如下：

redis.call(command [,arg...])

例如：

127.0.0.1:6379> eval "return redis.call('set', 'mykey1', 'hello')" 0
OK
127.0.0.1:6379> eval "return redis.call('get', 'mykey1')" 0
"hello"
127.0.0.1:6379>

该例中key和value的值都是硬编码，若要改为传参的方式，如下：

127.0.0.1:6379> eval "return redis.call('set', KEYS[1], ARGV[1])" 1 mykey1 world
OK
127.0.0.1:6379> eval "return redis.call('get', KEYS[1])" 1 mykey1
"world"
127.0.0.1:6379>

注意： KEYS 和 ARGV 是大小写敏感的，必须用大写。

redis.pcall() 和 redis.call() 的功能基本相同，区别是提供了错误处理能力。

比如：

127.0.0.1:6379> eval "return redis.call('get', 'mykey1')" 0
"world"
127.0.0.1:6379>

如果不小心把 get 命令拼错了：

127.0.0.1:6379> eval "return redis.call('gett', 'mykey1')" 0
(error) ERR Unknown Redis command called from script script: 8426105f7bad9a131b19c9b8c374df63bc9015ef, on @user_script:1.
127.0.0.1:6379>

可见，返回了一个Redis系统错误消息。

如果换成 redis.pcall() ，就能做错误处理，比如：

127.0.0.1:6379> eval "local reply = redis.pcall('gett', 'mykey1'); if reply['err'] ~= nil then reply['err'] = 'Something is wrong' end; return reply" 0
(error) Something is wrong
127.0.0.1:6379>

这样，就可以返回自定义的消息。

redis.call() 则不能处理错误：

127.0.0.1:6379> eval "local reply = redis.call('gett', 'mykey1'); if reply['err'] ~= nil then reply['err'] = 'Something is wrong' end; return reply" 0
(error) ERR Unknown Redis command called from script script: a8ca7042298e6fa8155fcdb0e35cc99566489e91, on @user_script:1.
127.0.0.1:6379>

可见，仍然返回了Redis的系统错误消息。

script 命令

script load 命令把脚本缓存在服务器，并返回其SHA1摘要，以后就可以通过 evalsha 命令来运行脚本。

127.0.0.1:6379> script load "return 'hello ' .. ARGV[1]"
"3a0817935cd31956a48cbc3f113ca7aabf07171d"
127.0.0.1:6379>

接下来就可以通过

127.0.0.1:6379> evalsha 3a0817935cd31956a48cbc3f113ca7aabf07171d 0 world
"hello world"
127.0.0.1:6379>

注意：脚本只是被缓存到服务器端，一旦服务器重启，或者运行了 script flush 命令，脚本缓存就没了。

127.0.0.1:6379> script flush
OK
127.0.0.1:6379>

再次运行 evalsha 命令：

127.0.0.1:6379> evalsha 3a0817935cd31956a48cbc3f113ca7aabf07171d 0 world
(error) NOSCRIPT No matching script. Please use EVAL.
127.0.0.1:6379>

可见，缓存的脚本已经没了。

可以用 script exists 命令查看脚本缓存是否存在：

127.0.0.1:6379> script exists 3a0817935cd31956a48cbc3f113ca7aabf07171d
1) (integer) 0
127.0.0.1:6379>

Redis函数

尽管 script load 命令可以把脚本缓存到服务器端，但这是不可靠的，缓存的脚本随时都可能会被丢掉（比如服务器重启，或者 script flush 命令）。这就意味着客户端需要做维护脚本缓存的工作，并带来了一系列麻烦，比如：

  • 所有客户端都需要保存一份脚本，增加了脚本维护和升级的麻烦；
  • SHA1摘要是一串无意义的序列值；
  • 多个脚本之间无法交互；

Redis 7.0引入了“函数”的概念。函数是脚本的进化版。

函数提供了和脚本相同的核心功能，但是脚本是“附加”的，而函数是Redis的组成部分。Redis会通过持久化和复制来保证其可用性。而且客户端要使用函数，只依赖于API，而不是嵌入式的脚本逻辑。

Function并没有限定其实现语言。运行引擎理论上可以使用任何语言，不过显然Lua是首选。

function load 命令

用来创建函数。例如，下面的“hello world”函数：

127.0.0.1:6379> function load "#!lua name=mylib\nredis.register_function('myfunc1', function() return 'hello world' end)"
"mylib"
127.0.0.1:6379>

fcall 命令

用来调用函数：

127.0.0.1:6379> fcall myfunc1 0
"hello world"
127.0.0.1:6379>

function list 命令

用来显示函数信息：

127.0.0.1:6379> function list libraryname mylib
1) 1) "library_name"
   2) "mylib"
   3) "engine"
   4) "LUA"
   5) "functions"
   6) 1) 1) "name"
         2) "myfunc1"
         3) "description"
         4) (nil)
         5) "flags"
         6) (empty array)
127.0.0.1:6379>

function delete 命令

用来删除函数：

127.0.0.1:6379> function delete mylib
OK
127.0.0.1:6379>

创建函数的其它方式

也可以通过以下方式来创建函数。

创建 test4.lua 文件，内容如下：

#!lua name=mylib

local function my_hset(keys, args)
  local hash = keys[1]
  local time = redis.call('TIME')[1]
  return redis.call('HSET', hash, '_last_modified_', time, unpack(args))
end

local function my_hgetall(keys, args)
  redis.setresp(3)
  local hash = keys[1]
  local res = redis.call('HGETALL', hash)
  res['map']['_last_modified_'] = nil
  return res
end

local function my_hlastmodified(keys, args)
  local hash = keys[1]
  return redis.call('HGET', keys[1], '_last_modified_')
end

redis.register_function('my_hset', my_hset)
redis.register_function('my_hgetall', my_hgetall)
redis.register_function('my_hlastmodified', my_hlastmodified)

注：

  • 在 my_hset 函数中，通过 redis.call('TIME')[1] 获取系统时间；
  • 在 my_hgetall 函数中，通过 redis.setresp(3) 将 redis.call 设置为返回 RESP3 应答。与默认的 RESP2 不同， RESP3 提供了dictionary应答，允许函数删除其中的某个字段（在Lua中是设置为nil），在本例中是删除了 _last_modified_ 字段；

运行下列命令来创建函数：

➜  ~ cat temp/test4.lua | redis-cli -x FUNCTION LOAD REPLACE 
"mylib"

调用 my_hset 函数：

127.0.0.1:6379> fcall my_hset 1 myhash myfield "some value" another_field "another value"
(integer) 3
127.0.0.1:6379>

通过Redis命令查看：

127.0.0.1:6379> hgetall myhash
1) "_last_modified_"
2) "1651933164"
3) "myfield"
4) "some value"
5) "another_field"
6) "another value"
127.0.0.1:6379>

可见，确实创建了 myhash 。

调用 my_hgetall 函数：

127.0.0.1:6379> fcall my_hgetall 1 myhash
1) "another_field"
2) "another value"
3) "myfield"
4) "some value"
127.0.0.1:6379>

可见，返回了 _last_modified_ 之外的其它信息。

调用 my_hlastmodified 函数：

127.0.0.1:6379> fcall my_hlastmodified 1 myhash
"1651933164"
127.0.0.1:6379>

可见，返回了 my_hlastmodified 信息。

最终 function list 如下：

127.0.0.1:6379> function list
1) 1) "library_name"
   2) "mylib"
   3) "engine"
   4) "LUA"
   5) "functions"
   6) 1) 1) "name"
         2) "my_hlastmodified"
         3) "description"
         4) (nil)
         5) "flags"
         6) (empty array)
      2) 1) "name"
         2) "my_hgetall"
         3) "description"
         4) (nil)
         5) "flags"
         6) (empty array)
      3) 1) "name"
         2) "my_hset"
         3) "description"
         4) (nil)
         5) "flags"
         6) (empty array)
127.0.0.1:6379>

参考

  • https://redis.io/docs/manual/programmability/
蓝黑2020
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
phpredis执行LUA脚本示例代码
09-09
在PHP中，phpredis是一个流行的Redis扩展库，用于与Redis服务器进行交互。LUA脚本在Redis中的使用是为了实现...为了进一步学习，可以参考提供的链接或其他官方文档，加深对phpredis和LUA脚本在Redis中的应用的理解。
快速入门Redis调用Lua脚本及使用场景介绍
字母哥博客
02-26 3927
Redis 是一种非常流行的内存数据库，常用于数据缓存与高频数据存储。大多数开发人员可能听说过redis可以运行 Lua 脚本，但是可能不知道redis在什么情况下需要使用到Lua脚本。 一、阅读本文前置条件 可以遵循这个链接中的方法在操作系统上安装 Redis 如果你对redis命令不熟悉，查看《Redis 命令引用》 二、为什么需要Lua脚本 简而言之：Lua脚本带来性能的提升。 很多应用的服务任务包含多步redis操作以及使用多个redis命令，这时你可以使用Redis结合Lua脚本，会为你的
【Redis】redis基础知识
进击的Coder，Fighting！
08-22 226
Redis Redis 是一个开源的，内存中的数据结构存储系统，它可以用作数据库、缓存和消息中间件。 完全基于内存，绝大部分请求是纯粹的内存操作，非常快速。数据存在内存中，类似于HashMap，HashMap的优势就是查找和操作的时间复杂度都是O(1)； 数据结构简单，对数据操作也简单，Redis中的数据结构是专门进行设计的； 采用单线程，避免了不必要的上下文切换和竞争条件，也不存在多进程或...
Lua脚本如何调用Redis指令
u014265398的博客
02-23 3140
一. Lua脚本调用Redis指令 当我们在redis中允许Lua脚本,有一个内置变量，并且具备两个参数： ## 标题
redis 基本命令
firefly
12-07 2561
基本命令 # 客户端连接服务器 redis-cli -h <address> -p <port> -a <password> # 列出服务器信息 INFO # 查看服务是否允许 PING key # 判断键的存在; 返回存在的键的数量 EXISTS <key1> <key2> # 删除键 DEL <key1> <ke............
redis脚本命令执行（redis.call）
落白
07-26 1万+
1、redis-cli命令行中执行： # 调用redis命令设置缓存 # 不传参数 eval "return redis.call('set', 'name1', 'Tom')" 0 # 传入1个值参数 eval "return redis.call('set', 'name2', ARGV[1])" 0 "Tom" # 传入1个键名参数和1个值参数 eval "return redis.call('set', KEYS[1], ARGV[1])" 1 "name3" "Tom" 2、linux命
redis 精髓
真是呆子啊的博客
12-13 1284
一、初探 1、简介 Redis是一个由ANSI C语言编写，性能优秀、支持网络、可持久化的内存数据库，并提供多种语言的API，线程安全，常用于做缓存和分布式锁，支持事务、持久化、主从复制、发布订阅、LUA脚本、LRU驱动事件、流水线、多种集群方案。 Redis跟memcached的只支持k-v类型不同，redis常用的类型主要是 String、List、Hash、Set、ZSet 这5种，并...
随手记录4:spring上下文ApplicationContext 两种获取方式和使用获取普通对象和FactoryBean的不同；
weixin_43812522的博客
09-03 504
随手记录4:spring上下文ApplicationContext 获取和使用;简介关于ApplicationContext 获取关于ApplicationContext 使用1.UserService .java2.FactoryBeanConfig .java结论 简介 项目中基本上好多对象都是交给spring管理的; 但是有些静态的工具类中想获取该对象又不能通过 @Autowired直接注入; 或者有些方法里面需要使用到spring托管的对象; 可以通过ApplicationContext 直接获
实战篇Redis(2)
wuzj1314的博客
12-05 602
分布式锁：满足分布式系统或集群模式下多进程可见并且互斥的锁。分布式锁的核心思想就是让大家都使用同一把锁，只要大家使用的是同一把锁，那么我们就能锁住线程，不让线程进行，让程序串行执行，这就是分布式锁的核心思路 那么分布式锁他应该满足一些什么样的条件呢？可见性：多个线程都能看到相同的结果，注意：这个地方说的可见性并不是并发编程中指的内存可见性，只是说多个进程之间都能感知到变化的意思互斥：互斥是分布式锁的最基本的条件，使得程序串行执行高可用：程序不易崩溃，时时刻刻都保证较高的可用性高性能：由于加锁本身就让性能降低
Redis执行Lua脚本的好处与示例代码
09-09
例如，如果需要执行一系列连续的Redis命令，如设置、获取和计算，这些命令可以通过一个Lua脚本一次性发送到服务器，减少了网络延迟和多次请求的开销。 2. **原子操作**： Redis将整个Lua脚本视为一个原子操作，这...
简介Lua脚本与Redis数据库的结合使用
09-10
`KEYS`和`ARGV`分别是Lua脚本中用于接收Redis键和参数的表。在调用时，需要提供键的数量和具体的键值，例如： ```bash redis-cli EVAL "$(cat incr-and-stor.lua)" 2 links:counter links:urls ...
Go语言中通过Lua脚本操作Redis的方法
09-09
`KEYS`和`ARGV`是Redis在执行Lua脚本时提供的两个预定义数组，`KEYS`存储了传递给脚本的键，而`ARGV`则包含了其他参数。 在运行Lua脚本时，我们可以调用`Run`方法，如下所示： ```go updateRecordExpireScript.Run...
SpringBoot通过redisTemplate调用lua脚本并打印调试信息到redis log(方法步骤详解)
08-25
3. 在lua脚本中，有两个全局的变量是用来接收Redis应用端传递的键值和其它参数的，分别为KEYS、ARGV。 4. 在应用端，传递给KEYS时是一个数组列表，在lua脚本中通过索引方式获取数组内的值。 5. 在应用端，传递给ARGV...
架构师-Redis(二)
liulong1010的专栏
01-29 1166
Lua脚本 发布与订阅 Key过期策略 事务 持久化 RDB AOF 事件 文件事件 事件事件
Redis脚本全解
程序员Forlan的博客
03-23 1724
本文主要介绍我们为什么使用redis脚本，如何正确去使用，怎么保证原子性，具体的应用场景
Redis中使用Lua脚本（一）
泡飞的博客
08-09 4365
Redis中使用Lua脚本（一）一、简介二、Redis中Lua的常用命令2.1 EVAL命令2.2 SCRIPT LOAD命令 和 EVALSHA命令2.3 SCRIPT EXISTS 命令2.4 SCRIPT FLUSH 命令2.5 SCRIPT KILL 命令三、Redis执行Lua脚本文件3.1 编写Lua脚本文件3.2 执行Lua脚本文件四、实例：使用Lua控制IP访问频率五、总结参考资...
PHP-redis中文文档
草样涂荼
05-18 774
phpredis是php的一个扩展，效率是相当高有链表排序功能，对创建内存级的模块业务关系 很有用;以下是redis官方提供的命令使用技巧: 下载地址如下： https://github.com/owlient/phpredis（支持redis 2.0.4）Redis::__construct构造函数 $redis = new Redis();connect, open 链接redis服务
redis.call() 和 redis.pcall()
热门推荐
坚持住啊
07-15 1万+
下面是来自官方文档的解释： 原文http://www.redis.cn/commands/eval.html redis.call() 和 redis.pcall() 的唯一区别在于它们对错误处理的不同。 当 redis.call() 在执行命令的过程中发生错误时，脚本会停止执行，并返回一个脚本错误，错误的输出信息会说明错误造成的原因： > del foo (integer) 1 > lpush foo a (integer) 1 > eval "return redis.ca.
3D魔方lua核心脚本制作
最新发布
qq_15117535的博客
07-31 455
self.ep = {0,1,2,3,4,5,6,7,8,9,10,11}-- # 楞块位置。self.er = {0,0,0,0,0,0,0,0,0,0,0,0}-- # 楞块方向。self.mr = {0,0,0,0,0,0}--# 中心块方向。self.cp = {0,1,2,3,4,5,6,7}--# 角块位置。self.cr = {0,0,0,0,0,0,0,0}--# 角块方向。self.mp = {0,1,2,3,4,5}--# 中心块位置。--route(self,"F") --旋转。
redis lua脚本 缺点
09-13
Redis Lua脚本的一些缺点包括： 1. 学习成本高：Lua是一种功能强大但相对较复杂的编程语言，使用Lua编写Redis脚本需要掌握一定的Lua语法和Redis命令。 2. 难以调试：Redis Lua脚本在执行过程中无法直接打印日志或调试，因此在调试脚本时比较困难。 3. 缺乏IDE支持：与其他主流编程语言相比，Lua的IDE支持相对较少，缺乏一些常用的开发工具和调试器。 4. 无法进行代码复用：Redis Lua脚本不能像其他编程语言那样进行函数封装和模块化，难以实现代码的复用性。 5. 性能问题：由于Redis Lua脚本在执行过程中需要将代码发送给Redis服务器执行，这会增加网络传输开销。同时，Lua脚本在执行时是单线程的，无法充分利用多核处理器。 这些缺点并不意味着Redis Lua脚本没有优势，它仍然是一种非常强大和灵活的工具，可以用于执行复杂的逻辑操作和批量处理。但在使用时需要权衡其优缺点，并结合具体场景进行选择和优化。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值