Redis中使用lua脚本
一、简介
Lua是一种轻量小巧的脚本语言,用标准C语言编写并以源代码形式开放,其设计目的是为了嵌入应用程序中,从而为应用程序提供灵活的扩展和定制功能。其设计目的是为了嵌入应用程序中,从而为应用程序提供灵活的扩展和定制功能。参考网站:https://www.runoob.com/lua/lua-tutorial.html
1.2、应用场景:
1、游戏开发
2、独立应用脚本
3、Web 应用脚本
4、扩展和数据库插件如:MySQL Proxy 和 MySQL WorkBench
5、安全系统,如入侵检测系统
1.3、在redis使用lua脚本的好处
1、减少网络开销。可以将多个请求通过脚本的形式一次发送,减少网络时延及开销。
2、原子性操作。Redis会将整个脚本作为一个整体执行,中间不会被其他请求插入。因此在脚本运行过程中无需担心会出现竞态条件,无需使用事务。
3、复用。客户端发送的脚本会永久存在redis中,这样其他客户端可以复用这一脚本,而不需要使用代码完成相同的逻辑。
二、常见命令
2.1、EVAL命令
命令格式:EVAL script numkeys key [key …] arg [arg …]
参数说明:
1、script:是 Lua5.1 脚本程序。此Lua脚本不需要也不应该定义函数,它运行在Redis服务器中。
2、numkeys:键名参数的个数。即:key [key …]中key的个数。如没有key,则为0。
3、key[]:键名参数,表示在脚本中所用到的那些Redis键(key),这些键名参数可以在Lua中通过全局变量KEYS数组。在Lua脚本中通过KEYS[1], KEYS[2]获取。
4、arg [arg …] :不是键名参数的附加参数,可以在Lua中通过全局变量ARGV数组访问。在Lua脚本中通过ARGV[1],ARGV[2]获取。
参考案例如下:
127.0.0.1:6379> EVAL "return redis.call('set',KEYS[1],ARGV[1])" 1 name xiaoli01
OK
127.0.0.1:6379> GET name
"xiaoli01"
127.0.0.1:6379> EVAL "return redis.call('set',KEYS[1],ARGV[1])" 1 name02 xiaoli02
OK
127.0.0.1:6379> get name02
"xiaoli02"
2.2、SCRIPT FLUSH 命令
命令格式:SCRIPT FLUSH
作用:清除Redis服务端所有 Lua 脚本缓存
案例如下:
127.0.0.1:6379> SCRIPT EXISTS 111111
1) (integer) 1
127.0.0.1:6379> SCRIPT FLUSH
OK
127.0.0.1:6379> SCRIPT EXISTS 111111
1) (integer) 0
2.3、SCRIPT KILL 命令
命令格式:SCRIPT FLUSH
作用:杀死当前正在运行的 Lua 脚本,当且仅当这个脚本没有执行过任何写操作时,这个命令才生效。
这个命令主要用于终止运行时间过长的脚本,比如一个因为 BUG 而发生无限 loop 的脚本,诸如此类。
2.4、SCRIPT EXISTS 命令
命令格式:SCRIPT EXISTS sha1 [sha1 …]
作用:给定一个或多个脚本的 SHA1 校验和,返回一个包含 0 和 1 的列表,
表示校验和所指定的脚本是否已经被保存在缓存当中
参考案例如下:
127.0.0.1:6379> SCRIPT EXISTS 111111
1) (integer) 1
127.0.0.1:6379> SCRIPT EXISTS 222222
1) (integer) 0
127.0.0.1:6379> SCRIPT EXISTS 111111 222222
1) (integer) 1
2) (integer) 0
三、具体业务使用案例
--unlock.lua脚本内容如下:
-- 比较线程标示与锁中的标示是否一致
if(redis.call('get', KEYS[1]) == ARGV[1]) then
-- 释放锁 del key
return redis.call('del', KEYS[1])
end
return 0
改进redis分布式锁
在java中调用:
//初始化Lua脚本文件
private static final DefaultRedisScript<Long> UNLOCK_SCRIPT;
static {
UNLOCK_SCRIPT = new DefaultRedisScript<>();
//lua脚本位置
UNLOCK_SCRIPT.setLocation(new ClassPathResource("luaFiles/unlock.lua"));
//返回值类型
UNLOCK_SCRIPT.setResultType(Long.class);
}
/**
* 功能描述:方法二:使用Lua脚本释放锁
* @MethodName: unlock
* @MethodParam: [lockKey, lockValue]
* @Return: void
* @Author: yyalin
* @CreateDate: 2023/8/13 16:09
*/
public void unlock(String lockKey,String lockValue){
// 调用lua脚本
redisTemplate.execute(
UNLOCK_SCRIPT,
Collections.singletonList(lockKey),
lockValue);
}
更多优秀文章,请关注个人微信公众号或搜索“程序猿小杨”查阅。