springboot 2.x集成redis+lua脚本

一、springboot集成redis

1、引Pom

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

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

2、配置，我用的是cluster（当然集群不支持事物-我后面一些多命令会用Lua）

spring.redis.timeout = 10000ms
spring.redis.database = 0
spring.redis.password = jc_redis_xyz
spring.redis.cluster.nodes = ip1:7000,ip1:7001,ip2:7000,ip2:7001,ip3:7000,ip3:7001
spring.redis.cluster.max-redirects = 2
spring.redis.lettuce.pool.max-active = 1000
spring.redis.lettuce.pool.max-idle = 10
spring.redis.lettuce.pool.min-idle = 3
spring.redis.lettuce.pool.max-wait = 6000ms

本地或测试环境是单机的话，直接换成这个，你配置成哪种，springboot集成的redis自动装配会帮你切换使用哪种连接。所以只改配置就行了，用法不变：

spring.redis.host=127.0.0.1
#Redis服务器连接端口
spring.redis.port=6379
#Redis服务器连接密码（默认为空）
spring.redis.password=
#连接池最大连接数（使用负值表示没有限制）
spring.redis.pool.max-active=8
#连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.pool.max-wait=-1
#连接池中的最大空闲连接
spring.redis.pool.max-idle=8
#连接池中的最小空闲连接
spring.redis.pool.min-idle=0
#连接超时时间（毫秒）
spring.redis.timeout=30000

3、redis数据类型序列化，这里我重命名了一下redisTemplateMy ，你也可以保持原名redisTemplate

@Configuration
@AutoConfigureAfter(RedisAutoConfiguration.class)
public class RedisConfig {

    //redisConnectionFactory配置信息由yml控制

    @Bean
    @ConditionalOnMissingBean
    public RedisTemplate<String, Object> redisTemplateMy (LettuceConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
        //配置序列化器
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

}

4 、搞一个工具类,大多数简单操作的都比较适用

package com.epay.cu.upcc.ccc.provider.controller.test.redis.util;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ZSetOperations.TypedTuple;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

import java.util.*;
import java.util.concurrent.TimeUnit;

/**
 *RedisUtil类
 *
 *@author
 *@date 2021/12/16 
 */
@Component
public class RedisUtil {

  @Autowired
  private RedisTemplate<String, Object> redisTemplate;

  /**
   * 判断key是否存在
   *
   * @param key 键
   * @return true 存在 false不存在
   */
  public boolean hasKey(String key) {
    try {
      return redisTemplate.hasKey(key);
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 删除缓存
   *
   * @param key 可以传一个值 或多个
   */
  @SuppressWarnings("unchecked")
  public void del(String... key) {
    if (key != null && key.length > 0) {
      if (key.length == 1) {
        redisTemplate.delete(key[0]);
      } else {
        redisTemplate.delete(CollectionUtils.arrayToList(key));
      }
    }
  }
  // ================================Map=================================

  /**
   * HashGet
   *
   * @param key  键 不能为null
   * @param item 项 不能为null
   * @return 值
   */
  public Object hget(String key, String item) {
    return redisTemplate.opsForHash().get(key, item);
  }

  /**
   * HashSet 并设置时间
   *
   * @param key  键
   * @param map  对应多个键值
   * @param time 时间(秒)
   * @return true成功 false失败
   */
  public boolean hmset(String key, Map<String, Object> map, long time) {
    try {
      redisTemplate.opsForHash().putAll(key, map);
      if (time > 0) {
        expire(key, time);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }
  /**
   * 获取hashKey对应的所有键值
   *
   * @param key 键
   * @return 对应的多个键值
   */
  public Map<Object, Object> hmget(String key) {
    return redisTemplate.opsForHash().entries(key);
  }

  /**
   * HashSet
   *
   * @param key 键
   * @param map 对应多个键值
   * @return true 成功 false 失败
   */
  public boolean hmset(String key, Map<String, Object> map) {
    try {
      redisTemplate.opsForHash().putAll(key, map);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 向一张hash表中放入数据,如果不存在将创建
   *
   * @param key   键
   * @param item  项
   * @param value 值
   * @return true 成功 false失败
   */
  public boolean hset(String key, String item, Object value) {
    try {
      redisTemplate.opsForHash().put(key, item, value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 向一张hash表中放入数据,如果不存在将创建
   *
   * @param key   键
   * @param item  项
   * @param value 值
   * @param time  时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
   * @return true 成功 false失败
   */
  public boolean hset(String key, String item, Object value, long time) {
    try {
      redisTemplate.opsForHash().put(key, item, value);
      if (time > 0) {
        expire(key, time);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 删除hash表中的值
   *
   * @param key  键 不能为null
   * @param item 项 可以使多个 不能为null
   */
  public void hdel(String key, Object... item) {
    redisTemplate.opsForHash().delete(key, item);
  }

  /**
   * 判断hash表中是否有该项的值
   *
   * @param key  键 不能为null
   * @param item 项 不能为null
   * @return true 存在 false不存在
   */
  public boolean hHasKey(String key, String item) {
    return redisTemplate.opsForHash().hasKey(key, item);
  }

  // ============================set=============================

  /**
   * 根据key获取Set中的所有值
   *
   * @param key 键
   * @return
   */
  public Set<Object> sGet(String key) {
    try {
      return redisTemplate.opsForSet().members(key);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 根据value从一个set中查询,是否存在
   *
   * @param key   键
   * @param value 值
   * @return true 存在 false不存在
   */
  public boolean sHasKey(String key, Object value) {
    try {
      return redisTemplate.opsForSet().isMember(key, value);
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 将数据放入set缓存
   *
   * @param key    键
   * @param values 值 可以是多个
   * @return 成功个数
   */
  public long sSet(String key, Object... values) {
    try {
      return redisTemplate.opsForSet().add(key, values);
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 将set数据放入缓存
   *
   * @param key    键
   * @param time   时间(秒)
   * @param values 值 可以是多个
   * @return 成功个数
   */
  public long sSetAndTime(String key, long time, Object... values) {
    try {
      Long count = redisTemplate.opsForSet().add(key, values);
      if (time > 0) {
        expire(key, time);
      }
      return count;
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 获取set缓存的长度
   *
   * @param key 键
   * @return
   */
  public long sGetSetSize(String key) {
    try {
      return redisTemplate.opsForSet().size(key);
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 移除值为value的
   *
   * @param key    键
   * @param values 值 可以是多个
   * @return 移除的个数
   */
  public long setRemove(String key, Object... values) {
    try {
      Long count = redisTemplate.opsForSet().remove(key, values);
      return count;
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }


  /**
   * set 骚操作  交集
   * @param key1
   * @param key2
   * @return
   */
  public Set<Object> intersect(String key1, String key2) {
    try {
      return redisTemplate.opsForSet().intersect(key1, key2);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  //=================================zSet=============================

  /**
   * 添加一个
   *
   * @param key   zset 集合名
   * @param value 存放的值
   * @param score zet 中分数 默认升序排列
   * @return
   */
  public boolean sZset(String key, Object value, double score) {
    try {
      return redisTemplate.opsForZSet().add(key, value, score);
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 向zset集合中批量添加数据
   * @param key
   * @param tuples
   * @return
   */
  public Long sZsetList(String key, Set<TypedTuple<Object>> tuples) {
    try {
      return redisTemplate.opsForZSet().add(key, tuples);
    } catch (Exception e) {
      e.printStackTrace();
      return 0L;
    }
  }


  /**
   * 删除元素 zrem 可同时删除多个值
   *
   * @param key   zset 集合名
   * @param value 要删除的value值 可变参数
   */
  public Long zRemove(String key, Object... value) {
    try {
      return redisTemplate.opsForZSet().remove(key, value);
    } catch (Exception e) {
      e.printStackTrace();
      return 0L;
    }
  }

  /**
   * score的增加or减少 zincrby 正数为增 负数为减
   *
   * @param key
   * @param value
   * @param score
   */
  public Double zIncrScore(String key, String value, double score) {
    try {
      return redisTemplate.opsForZSet().incrementScore(key, value, score);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 查询value对应的score   zscore
   *
   * @param key
   * @param value
   * @return
   */
  public Double zScore(String key, String value) {
    try {
      return redisTemplate.opsForZSet().score(key, value);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }


  /**
   * 判断value在zset中的排名  zrank 返回的是位于为zet集合中索引值
   *
   * @param key
   * @param value
   * @return
   */
  public Long zRank(String key, String value) {
    try {
      return redisTemplate.opsForZSet().rank(key, value);
    } catch (Exception e) {
      e.printStackTrace();
      return -1L;
    }
  }
  /**
   * 查询集合中指定顺序的值， 0 -1 表示获取全部的集合内容  zrange
   *
   * 返回有序的集合，score小的在前面  （正序）
   *
   * @param key
   * @param start 开始
   * @param end 结束
   * @return value的set集合
   */
  public Set<Object> zRange(String key, int start, int end) {
    return redisTemplate.opsForZSet().range(key, start, end);
  }

  /**
   * 查询集合中指定顺序的值  zrevrange  0 -1 表示获取全部的集合内容
   *
   * 返回有序的集合中，score大的在前面  （倒序）
   *
   * @param key
   * @param start
   * @param end
   * @return
   */
  public Set<Object> reverseRange(String key, int start, int end) {
    return redisTemplate.opsForZSet().reverseRange(key, start, end);
  }


  /**
   * 查询集合中指定顺序的值和score，0, -1 表示获取全部的集合内容
   *
   * @param key
   * @param start
   * @param end
   * @return
   */
  public Set<TypedTuple<Object>> rangeWithScore(String key, int start, int end) {
    return redisTemplate.opsForZSet().rangeWithScores(key, start, end);
  }


  /**
   * 根据score的值，来获取满足条件的集合  zrangebyscore
   *
   * @param key
   * @param min
   * @param max
   * @return
   */
  public Set<Object> rangeByScore(String key, double min, double max) {
    return redisTemplate.opsForZSet().rangeByScore(key, min, max);
  }

  /**
   * 根据score的值，来获取满足条件的集合  取出结果后根据索引 以及count 拿到元素集合
   * @param key zset键
   * @param min score 最小值  （条件）
   * @param max score 最大值  （条件）
   * @param offset  从score 拿到集合后 从offset 索引处取值
   * @param count 总共取多少个元素
   * @return 返回新的集合
   */
  public Set<Object> rangeByScore(String key, double min, double max,Long offset,Long count) {
    return redisTemplate.opsForZSet().rangeByScore(key, min, max,offset,count);
  }

  /**
   * 返回集合的长度
   *
   * @param key
   * @return
   */
  public Long zSize(String key) {
    return redisTemplate.opsForZSet().zCard(key);
  }


  // ===============================list=================================

  /**
   * 获取list缓存的内容
   *
   * @param key   键
   * @param start 开始
   * @param end   结束 0 到 -1代表所有值
   * @return
   */
  public List<Object> lGet(String key, long start, long end) {
    try {
      return redisTemplate.opsForList().range(key, start, end);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 获取list缓存的长度
   *
   * @param key 键
   * @return
   */
  public long lGetListSize(String key) {
    try {
      return redisTemplate.opsForList().size(key);
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 通过索引 获取list中的值
   *
   * @param key   键
   * @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
   * @return
   */
  public Object lGetIndex(String key, long index) {
    try {
      return redisTemplate.opsForList().index(key, index);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 将list放入缓存
   *
   * @param key   键
   * @param value 值
   * @return
   */
  public boolean listRightPush(String key, Object value) {
    try {
      redisTemplate.opsForList().rightPush(key, value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 将list放入缓存
   *
   * @param key   键
   * @param value 值
   * @return
   */
  public boolean listRightPushAll(String key, List<Object> value) {
    try {
      redisTemplate.opsForList().rightPushAll(key, value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  //


  /**
   * 将list从左pop
   *
   * @param key   键
   * @return
   */
  public Object listLeftPop(String key) {
    try {
      return redisTemplate.opsForList().leftPop(key);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 将list从左pop
   *
   * @param key   键
   * @param time  时间(秒)
   * @return
   */
  public Object listLeftPop(String key, long time) {
    try {
      return redisTemplate.opsForList().leftPop(key,time, TimeUnit.SECONDS);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }


  /**
   * 根据索引修改list中的某条数据
   *
   * @param key   键
   * @param index 索引
   * @param value 值
   * @return
   */
  public boolean lUpdateIndex(String key, long index, Object value) {
    try {
      redisTemplate.opsForList().set(key, index, value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 移除N个值为value
   *
   * @param key   键
   * @param count 移除多少个
   * @param value 值
   * @return 移除的个数
   */
  public long lRemove(String key, long count, Object value) {
    try {
      Long remove = redisTemplate.opsForList().remove(key, count, value);
      return remove;
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }


  /**
   * 获取一个redis分布锁
   *
   * @param lockKey        锁住的key
   * @param lockExpireMils 锁住的时长。如果超时未解锁，视为加锁线程死亡，其他线程可夺取锁
   * @return
   */
  public boolean lock(String lockKey, long lockExpireMils) {
    return (Boolean) redisTemplate.execute((RedisCallback) connection -> {
      long nowTime = System.currentTimeMillis();
      Boolean acquire = connection.setNX(lockKey.getBytes(), String.valueOf(nowTime + lockExpireMils + 1).getBytes());
      if (acquire) {
        return Boolean.TRUE;
      } else {
        byte[] value = connection.get(lockKey.getBytes());
        if (Objects.nonNull(value) && value.length > 0) {
          long oldTime = Long.parseLong(new String(value));
          if (oldTime < nowTime) {
            //connection.getSet：返回这个key的旧值并设置新值。
            byte[] oldValue = connection.getSet(lockKey.getBytes(), String.valueOf(nowTime + lockExpireMils + 1).getBytes());
            //当key不存时会返回空，表示key不存在或者已在管道中使用
            return oldValue == null ? false : Long.parseLong(new String(oldValue)) < nowTime;
          }
        }
      }
      return Boolean.FALSE;
    });
  }

  /**
   * 指定缓存失效时间
   *
   * @param key  键
   * @param time 时间(秒)
   * @return
   */
  public boolean expire(String key, long time) {
    try {
      if (time > 0) {
        redisTemplate.expire(key, time, TimeUnit.SECONDS);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 根据key 获取过期时间
   *
   * @param key 键 不能为null
   * @return 时间(秒) 返回0代表为永久有效
   */
  public long getExpire(String key) {
    return redisTemplate.getExpire(key, TimeUnit.SECONDS);
  }


  // ============================String=============================

  /**
   * 普通缓存获取
   *
   * @param key 键
   * @return 值
   */
  public Object get(String key) {
    return key == null ? null : redisTemplate.opsForValue().get(key);
  }

  /**
   * 普通缓存放入
   *
   * @param key   键
   * @param value 值
   * @return true成功 false失败
   */
  public boolean set(String key, Object value) {
    try {
      redisTemplate.opsForValue().set(key, value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 普通缓存放入并设置时间
   *
   * @param key   键
   * @param value 值
   * @param time  时间(秒) time要大于0 如果time小于等于0 将设置无限期 单位为秒
   * @return true成功 false 失败
   */
  public boolean set(String key, Object value, long time) {
    try {
      if (time > 0) {
        redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
      } else {
        set(key, value);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 递增
   *
   * @param key   键
   * @param delta 要增加几(大于0)
   * @return
   */
  public long incr(String key, long delta) {
    if (delta < 0) {
      throw new RuntimeException("递增因子必须大于0");
    }
    return redisTemplate.opsForValue().increment(key, delta);
  }

  /**
   * 递减
   *
   * @param key   键
   * @param delta 要减少几(小于0)
   * @return
   */
  public long decr(String key, long delta) {
    if (delta < 0) {
      throw new RuntimeException("递减因子必须大于0");
    }
    return redisTemplate.opsForValue().increment(key, -delta);
  }
}

二、原子操作-lua脚本

1、lua一些常见语法

这个就不详解了，比较简单。

2、集成lua用法

主要是通过下面这个方法来执行脚本（当然还有几个兄弟方法也可以用）。

<T> T org.springframework.data.redis.core.RedisTemplate#execute(RedisScript<T>, java.util.List<K>, java.lang.Object...)

代码示例:这里实现一个redis的list队列结构的多个元素一起pop的原子操作（redis目前版本还没有批量pop的命令）

  @Test
    public void testLuaList() {
        //key
        String key="keyList";
        //每次取两个
        int sizeEach=2;
        //先往List放7个值
        List<Object> l = Arrays.asList("1", "2", "3", "4", "5", "6", "7");
        redisUtil.listRightPushAll(key, l);

        // ---lua 脚本---
        DefaultRedisScript<List> redisScript = new DefaultRedisScript();
        // 1)指定 lua 脚本
        redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("redis/ListPopN.lua")));
        // 2)指定返回类型,官方只支持4种：Long,Boolean,List,deserialized value
        redisScript.setResultType(List.class);
        try {
            getLuaList();
            List<String> keys = Arrays.asList(key);
            // 3)执行lua脚本---参数一：redisScript，参数二：key列表，参数三：arg（可多个,里面..形成数组）
            List<String> result1 = (List<String>) redisTemplateMy.execute(redisScript, keys, sizeEach - 1);
            logger.info("{}[执行结果], keys={},result1={}", TAG, keys, JSON.toJSONString(result1));
            while (!result1.isEmpty() && result1.size() == sizeEach) {
                getLuaList();
                result1 = (List<String>) redisTemplateMy.execute(redisScript, keys, sizeEach - 1);
                logger.info("{}[本次pop获取到的结果], keys={},result1={}", TAG, keys, JSON.toJSONString(result1));
            }
            getLuaList();
            return;
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public void getLuaList() {
        //查一下最新的List值
        List<Object> list = redisUtil.lGet("keyList", 0, -1);
        logger.info("{}[查一下最新的List值],list={}", TAG, JSON.toJSONString(list));
    }

对应的脚本，我是放在配置里，你可以放代码里

内容如下

local sizeIndex=ARGV[1]+1
local rlist = redis.call('lrange', KEYS[1],0,ARGV[1])
if #rlist == sizeIndex then
    redis.call('ltrim', KEYS[1],#rlist,-1)
    return  rlist
else
    return rlist;
end

测试demo

    @Test
    public void testLuaList() {
        //key
        String key="keyList";
        //每次取两个
        int sizeEach=2;
        //先往List放7个值
        List<Object> l = Arrays.asList("1", "2", "3", "4", "5", "6", "7");
        redisUtil.listRightPushAll(key, l);

        // ---lua 脚本---
        DefaultRedisScript<List> redisScript = new DefaultRedisScript();
        // 1)指定 lua 脚本
        redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("redis/ListPopN.lua")));
        // 2)指定返回类型,官方只支持4种：Long,Boolean,List,deserialized value
        redisScript.setResultType(List.class);
        try {
            getLuaList();
            List<String> keys = Arrays.asList(key);
            // 3)执行lua脚本---参数一：redisScript，参数二：key列表，参数三：arg（可多个,里面..形成数组）
            List<String> result1 = (List<String>) redisTemplateMy.execute(redisScript, keys, sizeEach - 1);
            logger.info("{}[执行结果], keys={},result1={}", TAG, keys, JSON.toJSONString(result1));
            while (!result1.isEmpty() && result1.size() == sizeEach) {
                getLuaList();
                result1 = (List<String>) redisTemplateMy.execute(redisScript, keys, sizeEach - 1);
                logger.info("{}[本次pop获取到的结果], keys={},result1={}", TAG, keys, JSON.toJSONString(result1));
            }
            getLuaList();
            return;
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public void getLuaList() {
        //查一下最新的List值
        List<Object> list = redisUtil.lGet("keyList", 0, -1);
        logger.info("{}[查一下最新的List值],list={}", TAG, JSON.toJSONString(list));
    }

3、注意项

<T> T org.springframework.data.redis.core.RedisTemplate#execute(RedisScript<T>, java.util.List<K>, java.lang.Object...)

这个返回T是个泛型，入参时就得指定好，而且只支持4种类型，看以下spring-boot-starter-data-redis源码

不同版本的，差不多都是这意思

别乱用，不然会转换报错