Redis新版工具类

方法命名更加简洁，调用更简单；
针对不同的操作对象，把方法封装在不同的内部类中；

• RKey 类用于操作 key；
• RString 类用于操作 string；
• RMap 类用于操作 map；
• RSet 类用于操作 set；
• RList 类用于操作 list；

package com.tuwer.util;

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.lang.NonNull;
import org.springframework.util.CollectionUtils;

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

/**
 * <p>Redis工具类</p>
 * --------------------------------------------------
 * 唯一构造器需要注入 redisTemplate；
 * 如果redis不可用，统一返回 null
 * --------------------------------------------------
 * 方法命名更加简洁，调用更简单；
 * 针对不同的操作对象，把方法封装在不同的内部类中；
 *
 * 1、RKey 类用于操作 key；使用：...rkey.del()
 * 2、RString 类用于操作 string；使用：...rstring.add()
 * 3、RMap 类用于操作 map；使用：...rmap.put()
 * 4、RSet 类用于操作 set；使用：...rset.size()
 * 5、RList 类用于操作 list；使用：...rlist.get()
 * --------------------------------------------------
 *
 * @author 土味儿
 * Date 2022/9/12
 * @version 1.0
 */
public class RedisUtil<V> {

    // ============================= 设置template ============================

    private RedisTemplate<String, V> redisTemplate;

    /**
     * 唯一构造器
     *
     * @param redisTemplate
     */
    public RedisUtil(RedisTemplate<String, V> redisTemplate) {
        this.redisTemplate = redisTemplate;

        this.rkey = new RKey();
        this.rstring = new RString();
        this.rmap = new RMap();
        this.rset = new RSet();
        this.rlist = new RList();
    }

    // ============================= key 相关 ============================

    public RKey rkey;

    public class RKey{
        /**
         * 指定缓存失效时间
         *
         * @param key  键
         * @param time 时间(秒)
         */
        public Boolean setExpire(@NonNull String key, @NonNull long time) {
            try {
                if (time < 0) {
                    return false;
                }
                return redisTemplate.expire(key, time, TimeUnit.SECONDS);
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }

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

        /**
         * 判断key是否存在
         *
         * @param key 键
         * @return true 存在 false不存在
         */
        public Boolean exist(@NonNull String key) {
            try {
                return redisTemplate.hasKey(key);
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }
        
        /**
         * 得到所有key
         *
         * @param pattern
         * @return
         */
        public Set<String> keys(String pattern) {
            return redisTemplate.keys(pattern);
        }

        // ------------- 删除key ---------------
        /**
         * 删除缓存（数组格式）
         *
         * @param key 可以传一个值 或多个
         * @return 被删数量
         */
        @SuppressWarnings("unchecked")
        public Long del(@NonNull String... key) {
            try {
                return redisTemplate.delete((Collection<String>) CollectionUtils.arrayToList(key));
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }

        /**
         * 删除缓存（List格式）
         *
         * @param keys list集合
         * @return 被删数量
         */
        public Long del(@NonNull List<String> keys) {
            try {
                return redisTemplate.delete(keys);
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }

        /**
         * 删除以 prefix 为前缀的所有缓存
         * 如：prefix = abc，则可以删除 abc，abc123，abc_ed，abc_234_ecd
         *
         * @param prefix
         * @return
         */
        public Long delByPrefix(String prefix) {
            try {
                return redisTemplate.delete(Objects.requireNonNull(redisTemplate.keys(prefix + "*")));
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }

        /**
         * 删除当前库中所有缓存
         */
        public Long delAll() {
            try {
                return redisTemplate.delete(Objects.requireNonNull(redisTemplate.keys("*")));
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }
    }

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

    public RString rstring;

    public class RString{
        /**
         * 普通缓存获取
         *
         * @param key 键
         * @return 值
         */
        public V get(@NonNull String key) {
            try {
                return redisTemplate.opsForValue().get(key);
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }
        
        /**
         * 获取特定前缀key的多个值
         * 2023-4-29 更新
         * @param keyPrefix key的前缀
         * @return
         */
        public List<V> getByPrefix(String keyPrefix){
            try {
                Set<String> keys = redisTemplate.keys(keyPrefix + "*");
                return redisTemplate.opsForValue().multiGet(keys);
            } catch (Exception e) {
                // redis不可用时
                return null;
            }
        }

        /**
         * 普通缓存放入
         *
         * @param key   键
         * @param value 值
         * @return true成功 false失败
         */
        public Boolean add(@NonNull String key, V value) {
            try {
                redisTemplate.opsForValue().set(key, value);
                return true;
            } catch (Exception e) {
                e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

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

        /**
         * 递增
         *
         * @param key   键
         * @param delta 要增加几(大于0)
         */
        public Long incr(@NonNull String key, long delta) {
            try {
                if (delta < 0) {
                    throw new RuntimeException("递增因子必须大于0");
                }
                return redisTemplate.opsForValue().increment(key, delta);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 递减
         *
         * @param key   键
         * @param delta 要减少几(小于0)
         */
        public Long decr(@NonNull String key, long delta) {
            try {
                if (delta < 0) {
                    throw new RuntimeException("递增因子必须大于0");
                }
                return redisTemplate.opsForValue().increment(key, -delta);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }
    }

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

    public RMap rmap;

    public class RMap{
        /**
         * HashGet
         *
         * @param key  键
         * @param item 项
         */
        public Object get(@NonNull String key, @NonNull String item) {
            try {
                return redisTemplate.opsForHash().get(key, item);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 获取hashKey对应的所有键值
         *
         * @param key 键
         * @return 对应的多个键值
         */
        public Map<Object, Object> getAll(@NonNull String key) {
            try {
                return redisTemplate.opsForHash().entries(key);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * HashSet
         *
         * @param key 键
         * @param map 对应多个键值
         */
        public Boolean add(@NonNull String key, @NonNull Map<String, Object> map) {
            try {
                redisTemplate.opsForHash().putAll(key, map);
                return true;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * HashSet 并设置时间
         *
         * @param key  键
         * @param map  对应多个键值
         * @param time 时间(秒)；整个HashSet的过期时间，并非是HashSet中元素的过期时间
         * @return true成功 false失败
         */
        public Boolean add(@NonNull String key, @NonNull Map<String, Object> map, long time) {
            try {
                redisTemplate.opsForHash().putAll(key, map);
                if (time > 0) {
                    rkey.setExpire(key, time);
                }
                return true;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

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

        /**
         * 向一张hash表中放入数据,如果不存在将创建
         *
         * @param key   键
         * @param item  项
         * @param value 值
         * @param time  时间(秒)；整个HashSet的过期时间，并非是HashSet中元素的过期时间
         * @return true 成功 false失败
         */
        public Boolean put(@NonNull String key, String item, Object value, long time) {
            try {
                redisTemplate.opsForHash().put(key, item, value);
                if (time > 0) {
                    rkey.setExpire(key, time);
                }
                return true;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 删除hash表中的值
         *
         * @param key  键
         * @param item 项 可以使多个 不能为null
         * @return 删除数量
         */
        public Long del(@NonNull String key, @NonNull Object... item) {
            try {
                return redisTemplate.opsForHash().delete(key, item);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 判断hash表中是否有该项的值
         *
         * @param key  键
         * @param item 项
         * @return true 存在 false不存在
         */
        public Boolean exist(@NonNull String key, String item) {
            try {
                return redisTemplate.opsForHash().hasKey(key, item);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * hash递增 如果不存在,就会创建一个 并把新增后的值返回
         *
         * @param key  键
         * @param item 项
         * @param by   要增加几(大于0)
         */
        public Double incr(@NonNull String key, String item, double by) {
            try {
                return redisTemplate.opsForHash().increment(key, item, by);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * hash递减
         *
         * @param key  键
         * @param item 项
         * @param by   要减少记(小于0)
         */
        public Double decr(@NonNull String key, String item, double by) {
            try {
                return redisTemplate.opsForHash().increment(key, item, -by);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }
    }

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

    public RSet rset;

    public class RSet{
        /**
         * 根据key获取Set中的所有值
         *
         * @param key 键
         */
        public Set<V> get(@NonNull String key) {
            try {
                return redisTemplate.opsForSet().members(key);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

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

        /**
         * 将数据放入set缓存
         *
         * @param key    键
         * @param values 值 可以是多个
         * @return 成功个数
         */
        public Long add(@NonNull String key, @NonNull V... values) {
            try {
                return redisTemplate.opsForSet().add(key, values);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 将set数据放入缓存
         *
         * @param key    键
         * @param time   时间(秒)；整个set集合的过期时间，并非是set中元素的过期时间
         * @param values 值 可以是多个
         * @return 成功个数
         */
        public Long add(@NonNull String key, long time, @NonNull V... values) {
            try {
                Long count = redisTemplate.opsForSet().add(key, values);
                if (time > 0) {
                    rkey.setExpire(key, time);
                }
                return count;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 将set数据放入缓存
         *
         * @param key
         * @param time   时间(秒)；整个set集合的过期时间，并非是set中元素的过期时间
         * @param values Set集合
         * @return
         */
        public Long add(@NonNull String key, long time, Set<V> values) {
            try {
                Long count = redisTemplate.opsForSet().add(key, (V[]) values.toArray());
                if (time > 0) {
                    rkey.setExpire(key, time);
                }
                return count;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 获取set缓存的长度
         *
         * @param key 键
         */
        public Long size(@NonNull String key) {
            try {
                return redisTemplate.opsForSet().size(key);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 移除值为value的
         *
         * @param key    键
         * @param values 值 可以是多个
         * @return 移除的个数
         */
        public Long remove(@NonNull String key, @NonNull Object... values) {
            try {
                return redisTemplate.opsForSet().remove(key, values);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }
    }

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

    public RList rlist;

    public class RList{
        /**
         * 获取list缓存的全部内容
         *
         * @param key 键
         */
        public List<V> get(@NonNull String key) {
            try {
                return redisTemplate.opsForList().range(key, 0, -1);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

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

        /**
         * 获取list缓存的长度
         *
         * @param key 键
         */
        public Long size(@NonNull String key) {
            try {
                return redisTemplate.opsForList().size(key);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

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

        /**
         * 通过对象获取index值
         *
         * @param key
         * @param value
         * @return
         */
        public Long getIndex(@NonNull String key, V value) {
            try {
                return redisTemplate.opsForList().indexOf(key, value);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 弹出list中的第一个值；并删除
         *
         * @param key 键
         */
        public V pop(@NonNull String key) {
            try {
                return redisTemplate.opsForList().leftPop(key);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 将list放入缓存
         *
         * @param key   键
         * @param value 值
         */
        public Long addValue(@NonNull String key, V value) {
            try {
                return redisTemplate.opsForList().rightPush(key, value);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 将list放入缓存
         *
         * @param key   键
         * @param value 值
         * @param time  时间(秒)；整个list列表的过期时间，并非是list中元素的过期时间
         */
        public Long addValue(@NonNull String key, V value, long time) {
            try {
                Long count = redisTemplate.opsForList().rightPush(key, value);
                if (time > 0) {
                    rkey.setExpire(key, time);
                }
                return count;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 将list放入缓存
         *
         * @param key   键
         * @param value 值
         * @return
         */
        public Long add(@NonNull String key, List<V> value) {
            try {
                return redisTemplate.opsForList().rightPushAll(key, value);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 将list放入缓存
         *
         * @param key   键
         * @param value 值
         * @param time  时间(秒)；整个list列表的过期时间，并非是list中元素的过期时间
         * @return
         */
        public Long add(@NonNull String key, List<V> value, long time) {
            try {
                Long count = redisTemplate.opsForList().rightPushAll(key, value);
                if (time > 0) {
                    rkey.setExpire(key, time);
                }
                return count;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 根据索引修改list中的某条数据
         * 用新值 newValue 替换 index 位置的元素
         * @param key   键
         * @param index 索引
         * @param newValue 值
         * @return
         */
        public Boolean update(@NonNull String key, Long index, V newValue) {
            if (Objects.isNull(index)) {
                return false;
            }
            try {
                redisTemplate.opsForList().set(key, index, newValue);
                return true;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 用 newValue 去替换 oldValue
         * ---------------------------
         * 原理：
         * 1、获取到 oldValue 的 index 值
         * 2、用 newValue 去替换 index 位置的值
         * ---------------------------
         * 注意：
         * 如果用 oldValue 去生成 newValue，注意㳀拷贝和深拷贝问题；
         * oldValue 要和 redis 中保存的一致才可以查出来；
         * <p>
         * 可以把该方法分解成两个方法：
         * Long lGetIndex(@NonNull String key,V value),
         * Boolean lUpdateIndex(@NonNull String key, long index, V value)
         * ---------------------------
         *
         * @param key
         * @param oldValue
         * @param newValue
         * @return
         */
        public Boolean replace(@NonNull String key, V oldValue, V newValue) {
            try {
                Long index = redisTemplate.opsForList().indexOf(key, oldValue);
                redisTemplate.opsForList().set(key, index, newValue);
                return true;
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }

        /**
         * 移除N个值为value的元素
         *
         * @param key   键
         * @param count 移除多少个
         * @param value 值
         * @return 移除的个数
         */
        public Long remove(@NonNull String key, long count, V value) {
            try {
                return redisTemplate.opsForList().remove(key, count, value);
            } catch (Exception e) {
                //e.printStackTrace();
                // redis不可用时
                return null;
            }
        }
    }
}

2023-4-29：

• 关于Set、List、Map中过期时间的说明：这三个内部类中所设置的过期时间都是key的，并非是集合内部元素的过期时间。其实redis中的过期时间，都是key的过期时间，并没有提供集合中元素的过期时间。
• String类中增加方法：getByPrefix() 可以查询以某个前缀开始的所有String类型key的值，返回List集合

• 使用示例

@Resource
RedisTemplate redisTemplate;

RedisUtil<MyClass> redisUtil = new RedisUtil(redisTemplate);

String key = ...

redisUtil.rkey.del(key);

MyClass myclass = redisUtil.rstring.get(key);

MyClass myclass = redisUtil.rlist.pop(key);