SpringBoot+Redis执行lua脚本的方法步骤

 更新时间:2019年11月06日 14:47:16   作者:不送花的程序猿  
这篇文章主要介绍了SpringBoot+Redis执行lua脚本的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

1、背景

有时候,我们需要一次性操作多个 Redis 命令,但是 这样的多个操作不具备原子性,而且 Redis 的事务也不够强大,不支持事务的回滚,还无法实现命令之间的逻辑关系计算。所以,一般在开发中,我们会利用 lua 脚本来实现 Redis 的事务。

2、lua 脚本

Redis 中使用 lua 脚本,我们需要注意的是,从 Redis 2.6.0后才支持 lua 脚本的执行。

使用 lua 脚本的好处:

  • 原子操作:lua脚本是作为一个整体执行的,所以中间不会被其他命令插入。
  • 减少网络开销:可以将多个请求通过脚本的形式一次发送,减少网络时延。
  • 复用性:lua脚本可以常驻在redis内存中,所以在使用的时候,可以直接拿来复用,也减少了代码量。

3、Redis 中执行 lua 脚本

1、命令格式:

EVAL script numkeys key [key ...] arg [arg ...]

说明:

  • script是第一个参数,为Lua 5.1脚本(字符串)。
  • 第二个参数numkeys指定后续参数有几个key。
  • key [key ...],被操作的key,可以多个,在lua脚本中通过KEYS[1], KEYS[2]获取
  • arg [arg ...],参数,可以多个,在lua脚本中通过ARGV[1], ARGV[2]获取。

2、如果直接使用 redis-cli命令:

redis-cli --eval lua_file key1 key2 , arg1 arg2 arg3

说明:

  • eval 命令后不再是 lua 脚本的字符串形式,而是一个 lua 脚本文件。后缀为.lua
  • 不再需要numkeys参数,而是用 , 隔开多个key和多个arg

4、使用 RedisTemplate 执行 lua 脚本

例子:删除 Redis 分布式锁

引入依赖:此依赖为我们整合了 Redis ,并且提供了非常好用的 RedisTemplate。

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

方式一:lua 脚本文件

1、新建 lua 脚本文件:

if redis.call("get",KEYS[1]) == ARGV[1] then
  return redis.call("del",KEYS[1])
else
  return 0
end

说明:先获取指定key的值,然后和传入的arg比较是否相等,相等值删除key,否则直接返回0。

2、代码测试:

/**
 * @author Howinfun
 * @desc lua 测试
 * @date 2019/11/5
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("test")
@SpringBootTest(classes = ThirdPartyServerApplication.class)
public class RedisTest {

  @Autowired
  private StringRedisTemplate redisTemplate;
  @Test
  public void contextLoads() {
    String lockKey = "123";
    String UUID = cn.hutool.core.lang.UUID.fastUUID().toString();
    boolean success = redisTemplate.opsForValue().setIfAbsent(lockKey,UUID,3, TimeUnit.MINUTES);
    if (!success){
      System.out.println("锁已存在");
    }
    // 执行 lua 脚本
    DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>();
    // 指定 lua 脚本
    redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("redis/DelKey.lua")));
    // 指定返回类型
    redisScript.setResultType(Long.class);
    // 参数一:redisScript,参数二:key列表,参数三:arg(可多个)
    Long result = redisTemplate.execute(redisScript, Collections.singletonList(lockKey),UUID);
    System.out.println(result);
  }
}

方式二:直接编写 lua 脚本(字符串)

1、代码测试:

/**
 * @author Howinfun
 * @desc lua 脚本测试
 * @date 2019/11/5
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("test")
@SpringBootTest(classes = ThirdPartyServerApplication.class)
public class RedisTest {

  /** 释放锁lua脚本 */
  private static final String RELEASE_LOCK_LUA_SCRIPT = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";

  @Autowired
  private StringRedisTemplate redisTemplate;
  @Test
  public void contextLoads() {
    String lockKey = "123";
    String UUID = cn.hutool.core.lang.UUID.fastUUID().toString();
    boolean success = redisTemplate.opsForValue().setIfAbsent(lockKey,UUID,3, TimeUnit.MINUTES);
    if (!success){
      System.out.println("锁已存在");
    }
    // 指定 lua 脚本,并且指定返回值类型
    DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>(RELEASE_LOCK_LUA_SCRIPT,Long.class);
    // 参数一:redisScript,参数二:key列表,参数三:arg(可多个)
    Long result = redisTemplate.execute(redisScript, Collections.singletonList(lockKey),UUID);
    System.out.println(result);
  }
}

注意:可能会有同学发现,为什么返回值不用 Integer 接收而是用 Long。这里是因为 spring-boot-starter-data-redis 提供的返回类型里面不支持 Integer。

大家可以看看源码:

/**
 * Represents a data type returned from Redis, currently used to denote the expected return type of Redis scripting
 * commands
 *
 * @author Jennifer Hickey
 * @author Christoph Strobl
 */
public enum ReturnType {

  /**
   * Returned as Boolean
   */
  BOOLEAN,

  /**
   * Returned as {@link Long}
   */
  INTEGER,

  /**
   * Returned as {@link List<Object>}
   */
  MULTI,

  /**
   * Returned as {@literal byte[]}
   */
  STATUS,

  /**
   * Returned as {@literal byte[]}
   */
  VALUE;

  /**
   * @param javaType can be {@literal null} which translates to {@link ReturnType#STATUS}.
   * @return never {@literal null}.
   */
  public static ReturnType fromJavaType(@Nullable Class<?> javaType) {

    if (javaType == null) {
      return ReturnType.STATUS;
    }
    if (javaType.isAssignableFrom(List.class)) {
      return ReturnType.MULTI;
    }
    if (javaType.isAssignableFrom(Boolean.class)) {
      return ReturnType.BOOLEAN;
    }
    if (javaType.isAssignableFrom(Long.class)) {
      return ReturnType.INTEGER;
    }
    return ReturnType.VALUE;
  }
}

所以当我们使用 Integer 作为返回值的时候,是报以下错误:

org.springframework.data.redis.RedisSystemException: Redis exception; nested exception is io.lettuce.core.RedisException: java.lang.IllegalStateException

    at org.springframework.data.redis.connection.lettuce.LettuceExceptionConverter.convert(LettuceExceptionConverter.java:74)
    at org.springframework.data.redis.connection.lettuce.LettuceExceptionConverter.convert(LettuceExceptionConverter.java:41)

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Eclipse Debug模式的开启与关闭问题简析

    Eclipse Debug模式的开启与关闭问题简析

    这篇文章主要介绍了Eclipse Debug模式的开启与关闭问题简析,同时向大家介绍了一个简单的debug模式启动不起来的解决方法,希望对大家有所帮助。
    2017-10-10
  • Springboot如何设置静态资源缓存一年

    Springboot如何设置静态资源缓存一年

    这篇文章主要介绍了Springboot如何设置静态资源缓存一年,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • Java 程序员掌握 Spring Boot非常有必要

    Java 程序员掌握 Spring Boot非常有必要

    本文带领大家一起来了解下 Spring Boot 到底是什么?包括springboot的诞生,springboot特征具有哪些优势,如何让开发变得更简单,带着这些问题一起通过本文学习下吧
    2021-06-06
  • 解决Callable的对象中,用@Autowired注入别的对象失败问题

    解决Callable的对象中,用@Autowired注入别的对象失败问题

    这篇文章主要介绍了解决Callable的对象中,用@Autowired注入别的对象失败问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • springboot集成@DS注解实现数据源切换的方法示例

    springboot集成@DS注解实现数据源切换的方法示例

    本文主要介绍了springboot集成@DS注解实现数据源切换的方法示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • java接口使用默认方法的讲解

    java接口使用默认方法的讲解

    在本篇文章里小编给大家整理了一篇关于java接口使用默认方法的讲解内容,有需要的朋友们可以学习下。
    2021-04-04
  • springboot 使用zookeeper实现分布式队列的基本步骤

    springboot 使用zookeeper实现分布式队列的基本步骤

    这篇文章主要介绍了springboot 使用zookeeper实现分布式队列,通过ZooKeeper的协调和同步机制,多个应用程序可以共享一个队列,并按照先进先出的顺序处理队列中的消息,需要的朋友可以参考下
    2023-08-08
  • SpringBoot Controller中的常用注解

    SpringBoot Controller中的常用注解

    这篇文章主要介绍了SpringBoot Controller中的常用注解,文章围绕主题展开详细的内容介绍,具有有一定的参考价值,需要的小伙伴可以参考一下
    2022-09-09
  • Java方法调用解析静态分派动态分派执行过程

    Java方法调用解析静态分派动态分派执行过程

    这篇文章主要为大家介绍了Java方法调用解析静态分派动态分派执行过程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • RSA加密的方式和解密方式实现方法(推荐)

    RSA加密的方式和解密方式实现方法(推荐)

    下面小编就为大家带来一篇RSA加密的方式和解密方式实现方法(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06

最新评论