StringRedisTemplate与RedisTemplate的区别，以及Redis的工具类封装

StringRedisTemplate与RedisTemplate区别点

• 两者的关系是StringRedisTemplate继承RedisTemplate。
• 两者的数据是不共通的；也就是说StringRedisTemplate只能管理StringRedisTemplate里面的数据，RedisTemplate只能管理RedisTemplate中的数据。
• RedisTemplate使用的是JdkSerializationRedisSerializer序列化类，存入数据会将数据先序列化成字节数组然后在存入Redis数据库。 StringRedisTemplate使用的是StringRedisSerializer序列化类
• 当redis数据库里面本来存的是字符串数据或者要存取的数据就是字符串类型数据的时候，那么使用StringRedisTemplate即可。但是如果你的数据是复杂的对象类型，而取出的时候又不想做任何的数据转换，直接从Redis里面取出一个对象，那么使用RedisTemplate是更好的选择。
• redisTemplate 中存取数据都是字节数组。当redis中存入的数据是可读形式而非字节数组时，使用redisTemplate取值的时候会无法获取导出数据，获得的值为null。可以使用 StringRedisTemplate 试试

RedisTemplate中定义了5种数据结构操作：

redisTemplate.opsForValue();　　//操作字符串
redisTemplate.opsForHash();　　 //操作hash
redisTemplate.opsForList();　　 //操作list
redisTemplate.opsForSet();　　  //操作set
redisTemplate.opsForZSet();　 　//操作有序set

StringRedisTemplate常用操作

// 向redis里存入数据和设置缓存时间  
stringRedisTemplate.opsForValue().set("test", "100", 60*10, TimeUnit.SECONDS);

// val做-1操作
stringRedisTemplate.boundValueOps("test").increment(-1); 

// 根据key获取缓存中的val
stringRedisTemplate.opsForValue().get("test") 

// val + 1
stringRedisTemplate.boundValueOps("test").increment(1); 

// 根据key获取过期时间
stringRedisTemplate.getExpire("test") 

// 根据key获取过期时间并换算成指定单位 
stringRedisTemplate.getExpire("test",TimeUnit.SECONDS); 

// 根据key删除缓存
stringRedisTemplate.delete("test"); 

// 检查key是否存在，返回boolean值
stringRedisTemplate.hasKey("546545");  

// 向指定key中存放set集合
stringRedisTemplate.opsForSet().add("red_123`在这里插入代码片`", "1", "2", "3"); 

// 设置过期时间
stringRedisTemplate.expire("red_123", 1000 , TimeUnit.MILLISECONDS); 

// 根据key查看集合中是否存在指定数据
stringRedisTemplate.opsForSet().isMember("red_123", "1"); 

// 根据key获取set集合
stringRedisTemplate.opsForSet().members("red_123"); 

基于StringRedisTemplate封装一个缓存工具类，满足下列需求:

• 方法1:将任意Java对象序列化为json并存储在string类型的key中，并且可以设置TTL过期时间
• 方法2:将任意Java对象序列化为json并存储在string类型的key中，并且可以设置逻辑过期时间，用于处理缓存击穿问题
• 方法3:根据指定的key查询缓存，并反序列化为指定类型，利用缓存空值的方式解决缓存穿透问题
• 方法4:根据指定的key查询缓存，并反序列化为指定类型，需要利用逻辑过期解决缓存击穿问题

以下封装涉及到了缓存穿透与缓存击穿的解决方案，如果对两者不熟悉，可以看看我的另一篇博客了解一下这些解决方案：数据库面试题——redis缓存穿透、缓存击穿与缓存雪崩

依赖：

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.7.17</version>
        </dependency>

还需要一个模型：

@Data
public class RedisData {
    private LocalDateTime expireTime;
    private Object data;
}

封装：

@Component
@Slf4j
public class RedisUtils {

    private final RedisTemplate<String, Object> redisTemplate;

    private final StringRedisTemplate stringRedisTemplate;

    // 防止缓存穿透而设置的空值的过期时间
    private final Long CACHE_NULL_TTL = 2L;

    // 防止缓存穿透而设置的空值的过期时间的单位
    private final TimeUnit CACHE_UNIT = TimeUnit.MINUTES;

    // 互斥锁
    private final String LOCK_APP_KEY = "lock:app:";

    private static final ExecutorService CACHE_REBUILD_EXECUTOR = Executors.newFixedThreadPool(10);

    public RedisUtils(RedisTemplate<String, Object> redisTemplate, StringRedisTemplate stringRedisTemplate) {
        this.redisTemplate = redisTemplate;
        this.stringRedisTemplate = stringRedisTemplate;
    }

    // =============================common============================

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

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

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

    /**
     * 判断key是否存在
     * @param key 键
     * @return true 存在 false不存在
     */
    public boolean hasKey(String key) {
        return Boolean.TRUE.equals(redisTemplate.hasKey(key));
    }

    /**
     * 删除缓存
     * @param key 可以传一个值 或多个
     */
    public boolean del(String... key) {
        if (key != null && key.length > 0) {
            if (key.length == 1) {
                redisTemplate.delete(key[0]);
            } else {
                redisTemplate.delete(Arrays.asList(key));
            }
            return true;
        }
        return false;
    }

    /**
     * 根据 key 前缀批量删除
     * @param prefix 前缀
     */
    public boolean DelByPrefix(String prefix) {
        Set<String> keys = redisTemplate.keys(prefix + "*");
        if(Objects.nonNull(keys)) {
            redisTemplate.delete(keys);
            return true;
        }
        return false;
    }

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

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

    /**
     * 普通缓存写入
     * @param key
     * @param value
     * @return
     */
    public boolean set(String key, Object value) {
        try {
            redisTemplate.opsForValue().set(key, value);
            return true;
        } catch (Exception e) {
            log.error("缓存写入错误！key：{}，value：{}，错误信息：{}", key, value, e.getMessage());
            return false;
        }
    }

    /**
     * 普通缓存写入并设置过期时间
     * @param key
     * @param value
     * @param time  时间(秒) 如果time小于等于0，则设置不过期
     * @return
     */
    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) {
            log.error("缓存写入错误！key：{}，value：{}，time：{}，错误信息：{}", key, value, time, e.getMessage());
            return false;
        }
    }

    /**
     * 递增，默认+1
     * @param key
     * @return
     */
    public Long incr(String key) {
        return redisTemplate.opsForValue().increment(key, 1);
    }

    /**
     * 递增，自定义递增步长
     * @param key   键
     * @param step 步长
     * @return
     */
    public Long incr(String key, long step) {
        return redisTemplate.opsForValue().increment(key, step);
    }

    /**
     * 递减，默认-1
     * @param key
     * @return
     */
    public Long decr(String key) {
        return redisTemplate.opsForValue().increment(key, -1);
    }

    /**
     * 递减，默认-1
     * @param key
     * @param step 步长
     * @return
     */
    public Long decr(String key, long step) {
        return redisTemplate.opsForValue().increment(key, -step);
    }

    // ================================Map=================================

    /**
     * HashGet
     * @param key
     * @param item
     * @return
     */
    public Object hget(String key, String item) {
        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 获取hashKey对应的所有键值
     * @param key 键
     * @return 对应的多个键值
     */
    public Map<Object, Object> hmget(String key) {
        return redisTemplate.opsForHash().entries(key);
    }

    /**
     * HashSet
     * @param key
     * @param map
     * @return
     */
    public boolean hmset(String key, Map<String, Object> map) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * HashSet 并设置过期时间
     * @param key
     * @param map
     * @param time 如果小于等于0，则不设置过期时间，单位为秒
     * @return
     */
    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) {
            log.error("HashSet写入错误！key：{}，map：{}，time：{}，错误信息：{}", key, map, time, e.getMessage());
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     * @param key
     * @param item
     * @param value
     * @return
     */
    public boolean hset(String key, String item, Object value) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            return true;
        } catch (Exception e) {
            log.error("hset写入错误！key：{}，item：{}，value：{}，错误信息：{}", key, item, value, e.getMessage());
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据并设置过期时间,如果不存在将创建
     * @param key
     * @param item
     * @param value
     * @param time  时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
     * @return
     */
    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) {
            log.error("hset写入错误！key：{}，item：{}，value：{}，time：{}，错误信息：{}", key, item, value, time, e.getMessage());
            return false;
        }
    }

    /**
     * 删除hash表中的值
     * @param key
     * @param item
     */
    public boolean hdel(String key, Object... item) {
        try {
            redisTemplate.opsForHash().delete(key, item);
            return true;
        } catch (Exception e) {
            log.error("hdel删除错误！key：{}，item：{}，错误信息：{}", key, item, e.getMessage());
            return false;
        }
    }

    /**
     * 判断hash表中是否有该项的值
     * @param key
     * @param item
     * @return
     */
    public boolean hHasKey(String key, String item) {
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     * @param key
     * @param item
     * @param step  步长
     * @return
     */
    public double hincr(String key, String item, double step) {
        return redisTemplate.opsForHash().increment(key, item, step);
    }

    /**
     * hash递减
     * @param key
     * @param item
     * @param step  步长
     * @return
     */
    public double hdecr(String key, String item, double step) {
        return redisTemplate.opsForHash().increment(key, item, -step);
    }

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

    /**
     * 根据key获取Set中的所有值
     * @param key
     * @return
     */
    public Set<Object> sGet(String key) {
        try {
            return redisTemplate.opsForSet().members(key);
        } catch (Exception e) {
            log.error("sGet获取错误！key：{}，错误信息：{}", key, e.getMessage());
            return null;
        }
    }

    /**
     * 查询指定set是否存在value
     * @param key
     * @param value
     * @return
     */
    public boolean sHasKey(String key, Object value) {
        try {
            return Boolean.TRUE.equals(redisTemplate.opsForSet().isMember(key, value));
        } catch (Exception e) {
            log.error("sHasKey查询错误！key：{}，value：{}，错误信息：{}", key, value, e.getMessage());
            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) {
            log.error("sSet写入错误！key：{}，values：{}，错误信息：{}", key, values, e.getMessage());
            return null;
        }
    }

    /**
     * 将set数据写入缓存并设置过期时间
     * @param key
     * @param time  小于等于0则不设置过期
     * @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) {
            log.error("sSet写入错误！key：{}，time：{}，values：{}，错误信息：{}", key, time, values, e.getMessage());
            return null;
        }
    }

    /**
     * 获取set缓存的长度
     * @param key
     * @return
     */
    public Long sGetSetSize(String key) {
        try {
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            log.error("sGetSetSize获取错误！key：{}，错误信息：{}", key, e.getMessage());
            return null;
        }
    }

    /**
     * 批量移除指定键值对
     * @param key
     * @param values
     * @return 移除成功个数
     */
    public Long setRemove(String key, Object... values) {
        try {
            return redisTemplate.opsForSet().remove(key, values);
        } catch (Exception e) {
            log.error("setRemove移除错误！key：{}，values：{}，错误信息：{}", key, values, e.getMessage());
            return null;
        }
    }

    // ===============================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) {
            log.error("lGet获取错误！key：{}，start：{}，end：{}，错误信息：{}", key, start, end, e.getMessage());
            return null;
        }
    }

    /**
     * 获取list缓存的长度
     * @param key 键
     * @return
     */
    public Long lGetListSize(String key) {
        try {
            return redisTemplate.opsForList().size(key);
        } catch (Exception e) {
            log.error("lGetListSize获取错误！key：{}，错误信息：{}", key, e.getMessage());
            return null;
        }
    }

    /**
     * 通过索引 获取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) {
            log.error("lGetIndex获取错误！key：{}，index：{}，错误信息：{}", key, index, e.getMessage());
            return null;
        }
    }

    /**
     * 将value写入list缓存
     * @param key   键
     * @param value 值
     * @return
     */
    public boolean lSet(String key, Object value) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            return true;
        } catch (Exception e) {
            log.error("lSet写入错误！key：{}，value：{}，错误信息：{}", key, value, e.getMessage());
            return false;
        }
    }

    /**
     * 将value写入list缓存并设置过期时间
     * @param key
     * @param value
     * @param time  小于等于0则不设置过期
     * @return
     */
    public boolean lSet(String key, Object value, long time) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            if (time > 0) expire(key, time);
            return true;
        } catch (Exception e) {
            log.error("lSet写入错误！key：{}，value：{}，time：{}，错误信息：{}", key, value, time, e.getMessage());
            return false;
        }
    }

    /**
     * 将list写入缓存
     * @param key
     * @param value
     * @return
     */
    public boolean lSet(String key, List<Object> value) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            return true;
        } catch (Exception e) {
            log.error("lSet写入错误！key：{}，value：{}，错误信息：{}", key, value, e.getMessage());
            return false;
        }
    }

    /**
     * 将list写入缓存并设置过期时间
     * @param key
     * @param value
     * @param time  小于等于0则不设置过期
     * @return
     */
    public boolean lSet(String key, List<Object> value, long time) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            if (time > 0) expire(key, time);
            return true;
        } catch (Exception e) {
            log.error("lSet写入错误！key：{}，value：{}，time：{}，错误信息：{}", key, value, time, e.getMessage());
            return false;
        }
    }

    /**
     * 根据索引修改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) {
            log.error("lUpdateIndex更新错误！key：{}，index：{}，value：{}，错误信息：{}", key, index, value, e.getMessage());
            return false;
        }
    }

    /**
     * 移除list中N个值为value的元素
     * @param key
     * @param count 移除数量
     * @param value
     * @return 移除成功的个数
     */
    public Long lRemove(String key, long count, Object value) {
        try {
            return redisTemplate.opsForList().remove(key, count, value);
        } catch (Exception e) {
            log.error("lRemove移除错误！key：{}，count：{}，value：{}，错误信息：{}", key, count, value, e.getMessage());
            return null;
        }
    }

    public void setString(String key, Object value, Long time, TimeUnit unit) {
        stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(value), time, unit);
    }

    /**
     * 逻辑过期
     * @param key
     * @param value
     * @param time  过期时间
     * @param unit  过期时间单位
     */
    public void setWithLogicalExpire(String key, Object value, Long time, TimeUnit unit) {
        RedisData redisData = new RedisData();
        redisData.setData(value);
        redisData.setExpireTime(LocalDateTime.now().plusSeconds(unit.toSeconds(time)));
        stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(redisData));
    }

    /**
     * 取数据（缓存空值防止缓存穿透）
     * @param keyPrefix key前缀
     * @param id  id
     * @param type  id类型
     * @param dbFallback  缓存不存在，则通过该函数新建缓存
     * @param time  写入缓存的过期时间
     * @param unit  写入缓存的过期时间单位
     * @param <R>
     * @param <ID>
     * @return
     */
    public <R,ID> R getWithPassThrough(
            String keyPrefix,
            ID id,
            Class<R> type,
            Function<ID, R> dbFallback,
            Long time,
            TimeUnit unit
    ){
        String key = keyPrefix + id;
        String json = stringRedisTemplate.opsForValue().get(key);
        if (StrUtil.isNotBlank(json)) {
            return JSONUtil.toBean(json, type);
        }
        if (json != null) {
            return null;
        }
        // id不存在，去数据库查询
        R r = dbFallback.apply(id);
        if (r == null) {
            // 数据不存在，则存空值，防止缓存穿透
            stringRedisTemplate.opsForValue().set(key, "", CACHE_NULL_TTL, CACHE_UNIT);
            return null;
        }
        // 数据存在，则写入缓存
        this.setString(key, r, time, unit);
        return r;
    }

    /**
     * 取数据（逻辑过期防止缓存击穿）
     * @param keyPrefix
     * @param id
     * @param type
     * @param dbFallback
     * @param time
     * @param unit
     * @param <R>
     * @param <ID>
     * @return
     */
    public <R, ID> R getWithLogicalExpire(
            String keyPrefix,
            ID id,
            Class<R> type,
            Function<ID, R> dbFallback,
            Long time,
            TimeUnit unit
    ) {
        String key = keyPrefix + id;
        String json = stringRedisTemplate.opsForValue().get(key);
        if (StrUtil.isBlank(json)) {
            return null;
        }
        // 命中，需要先把json反序列化为对象
        RedisData redisData = JSONUtil.toBean(json, RedisData.class);
        R r = JSONUtil.toBean((JSONObject) redisData.getData(), type);
        LocalDateTime expireTime = redisData.getExpireTime();
        if(expireTime.isAfter(LocalDateTime.now())) {
            // 未过期，直接返回信息
            return r;
        }
        // 缓存重建,获取互斥锁
        String lockKey = LOCK_APP_KEY + id;
        boolean isLock = tryLock(lockKey);
        if (isLock){
            // 成功获取锁，开启独立线程，实现缓存重建
            CACHE_REBUILD_EXECUTOR.submit(() -> {
                try {
                    R newR = dbFallback.apply(id);
                    this.setWithLogicalExpire(key, newR, time, unit);
                } catch (Exception e) {
                    throw new RuntimeException(e);
                }finally {
                    unlock(lockKey);
                }
            });
        }
        return r;
    }

    /**
     * 取数据（互斥锁防止缓存击穿）
     * @param keyPrefix
     * @param id
     * @param type
     * @param dbFallback
     * @param time
     * @param unit
     * @param <R>
     * @param <ID>
     * @return
     */
    public <R, ID> R getWithMutex(
            String keyPrefix,
            ID id,
            Class<R> type,
            Function<ID, R> dbFallback,
            Long time,
            TimeUnit unit
    ) {
        String key = keyPrefix + id;
        String shopJson = stringRedisTemplate.opsForValue().get(key);
        if (StrUtil.isNotBlank(shopJson)) {
            return JSONUtil.toBean(shopJson, type);
        }
        if (shopJson != null) {
            return null;
        }

        // 实现缓存重建，获取互斥锁
        String lockKey = LOCK_APP_KEY + id;
        R r = null;
        try {
            boolean isLock = tryLock(lockKey);
            if (!isLock) {
                // 获取锁失败，休眠并重试
                Thread.sleep(50);
                return getWithMutex(keyPrefix, id, type, dbFallback, time, unit);
            }
            // 获取锁成功，根据id查询数据库
            r = dbFallback.apply(id);
            if (r == null) {
                // 将空值写入redis
                stringRedisTemplate.opsForValue().set(key, "", CACHE_NULL_TTL, TimeUnit.MINUTES);
                return null;
            }
            // 存在则写入redis
            this.setString(key, r, time, unit);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }finally {
            unlock(lockKey);
        }
        return r;
    }

    private boolean tryLock(String key) {
        Boolean flag = stringRedisTemplate.opsForValue().setIfAbsent(key, "1", 10, TimeUnit.SECONDS);
        return BooleanUtil.isTrue(flag);
    }

    private void unlock(String key) {
        stringRedisTemplate.delete(key);
    }
}

如果有兴趣了解更多相关内容，欢迎来我的个人网站看看：瞳孔的个人空间