redisUtils工具类

package com.snowflake.web.utils;

import com.snowflake.common.constant.CommonConst;
import com.snowflake.common.utils.JsonUtils;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.*;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

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

/**
 * 缓存工具类（支持默认过期时间 1 小时）
 */
@Slf4j
@Component
@Getter
public class RedisUtils implements com.snowflake.common.utils.RedisUtils {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    /** 默认过期时间：1小时（秒） */
    private static final long DEFAULT_EXPIRE = 3600L;

    // ====================== 基础方法 ======================

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

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

    /**
     * 判断key是否存在
     *
     * @param key 键
     * @return true:存在 fase:不存在
     */
    public boolean hasKey(String key) {
        try {
            return redisTemplate.hasKey(key);
        } catch (Exception e) {
            log.error("redis error", e);
            return false;
        }
    }

    /**
     * 如果key不存在,则设置val
     *
     * @param key 键
     * @param val 值
     * @return 是否成功
     */
    public boolean setIfAbsent(String key, Object val) {
        return redisTemplate.opsForValue().setIfAbsent(key, val);
    }


    /**
     * 获取所有键
     *
     * @param pattern 通配符
     * @return set集合
     */
    public Set<String> keys(String pattern) {
        return redisTemplate.keys(pattern);
    }

    /**
     * 删除缓存
     *
     * @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((Collection<String>) CollectionUtils.arrayToList(key));
            }
        }
    }

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

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

    /**
     * 获取并转成对象
     */
    public <T> T get(String key, Class<T> clazz) {
        Object obj = redisTemplate.opsForValue().get(key);
        if (obj == null) {
            return null;
        }
        // 如果本身就是目标类型，直接返回
        if (clazz.isInstance(obj)) {
            return clazz.cast(obj);
        }
        // 否则用 Jackson 转换
        return JsonUtils.parse(JsonUtils.toJsonString(obj), clazz);
    }

    public String getString(String key) {
        if (key != null) {
            Object o = redisTemplate.opsForValue().get(key);
            if(o!= null) return (String)o;
        }
        return null;
    }

    /**
     * 普通缓存放入
     *
     * @param key   键
     * @param value 值
     * @return true:成功 false:失败
     */
    public boolean set(String key, Object value) {
        return set(key, value, DEFAULT_EXPIRE);
    }

    /**
     * 普通缓存放入（自定义过期时间）
     * time <= 0 表示永久有效
     */
    public boolean set(String key, Object 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) {
            log.error("redis error", e);
            return false;
        }
    }

    /**
     * 递增
     *
     * @param key   键
     * @param delta 递增因子（大于0）
     * @return
     */
    public long incr(String key, long delta) {
        if (delta < 0) throw new RuntimeException("递增因子必须大于0");
        Long result = redisTemplate.opsForValue().increment(key, delta);
        // 自动设置默认过期时间
        expire(key, DEFAULT_EXPIRE);
        return result != null ? result : 0;
    }

    /**
     * 递增
     *
     * @param key   键
     * @param delta 递增因子（大于0）
     * @return
     */
    public double incr(String key, double delta) {
        if (delta < 0) throw new RuntimeException("递增因子必须大于0");
        Double result = redisTemplate.opsForValue().increment(key, delta);
        expire(key, DEFAULT_EXPIRE);
        return result != null ? result : 0;
    }

    /**
     * 递减
     *
     * @param key   键
     * @param delta 递减因子（大于0）
     * @return
     */
    public long decr(String key, long delta) {
        if (delta < 0) throw new RuntimeException("递减因子必须大于0");
        Long result = redisTemplate.opsForValue().increment(key, -delta);
        expire(key, DEFAULT_EXPIRE);
        return result != null ? result : 0;
    }

    // ================================Hash=================================

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

    public Boolean hPutIfAbsent(String key, String roundId, Map map) {
        return redisTemplate.opsForHash().putIfAbsent(key, roundId, map);
    }

    /**
     * 如果键对应的值存在则直接返回,否则创建
     *
     * @param key             键
     * @param defaultSupplier supplier
     * @param <K>             键
     * @param <V>             值
     * @return 如果键对应的值存在则直接返回, 否则创建
     */
    @SuppressWarnings("unchecked")
    public <K, V> Map<K, V> getOrInit(String key, Supplier<Map<K, V>> defaultSupplier) {
        boolean created = this.setIfAbsent(key, defaultSupplier.get());
        return (Map<K, V>) this.get(key);
    }


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

    /**
     * HashSet（默认 1 小时过期）
     */
    public boolean hmset(String key, Map<Object, Object> map) {
        return hmset(key, map, DEFAULT_EXPIRE);
    }

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

    /**
     * 向一张hash表中放入数据,如果不存在将创建。 hset（默认 1 小时过期）
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value) {
        return hset(key, item, value, DEFAULT_EXPIRE);
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建。 hset（自定义过期时间）
     *
     * @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) {
            log.error("redis error", e);
            return false;
        }
    }

//    /**
//     * 删除hash表中的值
//     *
//     * @param key  键 不能为null
//     */
//    public void hdel(String key) {
//        redisTemplate.opsForHash().delete(key);
//    }

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

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

    /**
     * 获取hash表中字段数量
     *
     * @param key 键 不能为null
     * @return hash表中字段数量
     */
    public Long hLen(String key) {
        return redisTemplate.opsForHash().size(key);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     *
     * @param key  键
     * @param item 项
     * @param by   要增加几(大于0)
     * @return
     */
    public double hincr(String key, String item, double by) {
        Double result = redisTemplate.opsForHash().increment(key, item, by);
        expire(key, DEFAULT_EXPIRE);
        return result != null ? result : 0;
    }

    /**
     * hash递减
     *
     * @param key  键
     * @param item 项
     * @param by   要减少记(小于0)
     * @return
     */
    public double hdecr(String key, String item, double by) {
        Double result = redisTemplate.opsForHash().increment(key, item, -by);
        expire(key, DEFAULT_EXPIRE);
        return result != null ? result : 0;
    }

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

    /**
     * 扫描 匹配模式的所有元素
     *
     * @param pattern 匹配模式，如 "user:*"
     * @param count   每次扫描的数量，建议设置为 100~1000
     * @return 匹配的所有元素
     */
    public Set<String> scanSetValues(String pattern, int count) {
        Set<String> result = new HashSet<>();
        ScanOptions options = ScanOptions.scanOptions()
                .match(pattern).count(count).build();
        Cursor<String> cursor = redisTemplate.scan(options);
        try {
            while (cursor.hasNext()) {
                result.add(cursor.next());
            }
        } catch (Exception e) {
            log.error("scanSetValues error", e);
        } finally {
            try {
                cursor.close();
            } catch (Exception e) {
                log.error("cursor close error", e);
            }
        }
        return result;
    }


    /**
     * 根据key获取Set中的所有值
     *
     * @param key 键
     * @return
     */
    public Set<Object> sGet(String key) {
        try {
            return redisTemplate.opsForSet().members(key);
        } catch (Exception e) {
            log.error("redis error", e);
            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) {
            log.error("redis error", e);
            return false;
        }
    }

    /**
     * 放入 set（默认 1 小时过期）
     */
    public long sSet(String key, Object... values) {
        return sSetAndTime(key, DEFAULT_EXPIRE, values);
    }

    /**
     * 放入 set（自定义过期时间）
     */
    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 != null ? count : 0;
        } catch (Exception e) {
            log.error("redis error", e);
            return 0;
        }
    }

    /**
     *  向set中添加元素后并返回set大小,并设置过期时间
     *
     * @param key 键
     * @param time 过期时间
     * @param val 要添加的元素
     * @return 添加元素后最新的set集合大小
     */
    public long sAddToSetAndGetSize(String key,long time,Object val) {
        try {
            redisTemplate.opsForSet().add(key, val);
            if (time > 0){
                expire(key, time);
            }
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            log.error("redis error", e);
            return 0;
        }
    }

    /**
     * 获取set缓存的长度
     *
     * @param key 键
     * @return
     */
    public long sGetSetSize(String key) {
        try {
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            log.error("redis error", e);
            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 != null ? count : 0;
        } catch (Exception e) {
            log.error("redis error", e);
            return 0;
        }
    }

    /**
     * 获取两个 set 集合的交集
     *
     * @param key1 set集合key1
     * @param key2 set集合key2
     * @return set 集合的交集
     */
    public Set<Object> sInter(String key1, String key2) {
        return redisTemplate.opsForSet().intersect(key1, key2);
    }

    /**
     * 判断是否 set 集合元素
     *
     * @param key   set集合key
     * @param value 元素
     * @return true：是 false：不是
     */
    public boolean sIsMember(String key, Object value) {
        Boolean member = redisTemplate.opsForSet().isMember(key, value);
        return member != null && member;
    }

    /**
     * 移除并返回集合中的一个随机元素
     *
     * @param key set 集合key
     * @return 随机元素
     */
    public Object sPop(String key) {
        return redisTemplate.opsForSet().pop(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) {
            log.error("redis error", e);
            return null;
        }
    }

    /**
     * 剪裁列表
     *
     * @param key   Redis 列表的键
     * @param start 开始索引（从0开始）
     * @param end   结束索引（包含）
     */
    public void lTrim(String key, long start, long end) {
        redisTemplate.opsForList().trim(key, start, end);
    }

    /**
     * 获取list缓存的长度
     *
     * @param key 键
     * @return
     */
    public long lGetListSize(String key) {
        try {
            return redisTemplate.opsForList().size(key);
        } catch (Exception e) {
            log.error("redis error", e);
            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) {
            log.error("redis error", e);
            return null;
        }
    }

    /**
     * 放入 list（默认 1 小时过期）
     */
    public boolean lSet(String key, Object value) {
        return lSet(key, value, DEFAULT_EXPIRE);
    }

    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("redis error", e);
            return false;
        }
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public boolean lSet(String key, List<Object> value) {
        return lSet(key, value, DEFAULT_EXPIRE);
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     * @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("redis error", e);
            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("redis error", e);
            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 != null ? remove : 0;
        } catch (Exception e) {
            log.error("redis error", e);
            return 0;
        }
    }

    // ===============================zset=================================


    /**
     * 删除指定元素
     * @param key
     * @param value
     * @return
     */
    public Long zRemove(String key, Object value){
        try {
            return redisTemplate.opsForZSet().remove(key, value);
        } catch (Exception e) {
            log.error("redis error", e);
            return 0L;
        }
    }

    /**
     * 查询zset的长度
     * @param key
     * @return
     */
    public Long zGetSize(String key){
        try {
            return redisTemplate.opsForZSet().size(key);
        } catch (Exception e) {
            log.error("redis error", e);
            return 0L;
        }
    }

    /**
     * zadd（默认 1 小时过期）
     */
    public boolean zadd(String key, Object value, double score) {
        try {
            boolean result = redisTemplate.opsForZSet().add(key, value, score);
            expire(key, DEFAULT_EXPIRE);
            return result;
        } catch (Exception e) {
            log.error("redis error", e);
            return false;
        }
    }

    /**
     * 获取 zset 指定区间的元素
     *
     * @param key   键
     * @param start 起始
     * @param end   结束
     * @return Set集合
     */
    public Set zrange(String key, long start, long end) {
        try {
            return redisTemplate.opsForZSet().range(key, start, end);
        } catch (Exception e) {
            log.error("redis error", e);
            return Collections.emptySet();
        }
    }

    /**
     * 倒序获取 zset 指定区间的元素
     *
     * @param key   键
     * @param start 起始
     * @param end   结束
     * @return Set集合
     */
    public Set zrevrange(String key, long start, long end) {
        try {
            return redisTemplate.opsForZSet().reverseRange(key, start, end);
        } catch (Exception e) {
            log.error("redis error", e);
            return Collections.emptySet();
        }
    }

    /**
     * 根据设置的score获取zset区间值
     *
     * @param key 键
     * @param min 最小值（score）
     * @param max 最大值（score）
     * @return set集合
     */
    public Set zrangeByscore(String key, double min, double max) {
        try {
            return redisTemplate.opsForZSet().rangeByScore(key, min, max);
        } catch (Exception e) {
            log.error("redis error", e);
            return Collections.emptySet();
        }
    }

    // ===============================transaction=================================

    //消息队列

    /**
     * 存放消息到队列中
     *
     * @param key   键
     * @param value 值
     * @return 是否成功
     */
    public boolean lPushMsg(String key, Object value) {
        try {
            redisTemplate.opsForList().leftPush(key, value);
            return true;
        } catch (Exception e) {
            log.error("redis error", e);
            return false;
        }
    }

    /**
     * 从消息队列中弹出消息
     *
     * @param key 键
     * @return
     */
    public Object rPopMsg(String key) {
        try {
            return redisTemplate.opsForList().rightPop(key);
        } catch (Exception e) {
            log.error("redis error", e);
            return null;
        }
    }

    /**
     * 查看消息
     *
     * @param key   键
     * @param start 开始位置
     * @param end   结束位置
     * @return 消息列表
     */
    public List<Object> getMsg(String key, long start, long end) {
        try {
            return redisTemplate.opsForList().range(key, start, end);
        } catch (Exception e) {
            log.error("redis error", e);
            return null;
        }
    }


    /**
     * 获取缓存的键 (游戏名称+platformCode+业务场景)
     *
     * @param gameName 游戏名称
     * @param platformCode 平台code
     * @param business 业务
     * @return 缓存的键
     */
    public String generateRedisKey(String gameName, String platformCode, String business) {
        return new StringBuilder(gameName).append(CommonConst.CACHE_SPLIT).append(platformCode)
                .append(CommonConst.CACHE_SPLIT).append(business).toString();

    }


    /**
     * 获取缓存的键 (游戏名称+platformCode+tenantId+业务场景)
     *
     * @param gameName 游戏名称
     * @param platformCode 平台code
     * @param tenantId 商户id
     * @param business 业务
     * @return 缓存的键
     */
    public String generateRedisKey(String gameName, String platformCode,String tenantId, String business){
        return new StringBuilder(gameName).append(CommonConst.CACHE_SPLIT).append(platformCode).append(CommonConst.CACHE_SPLIT).append(tenantId)
                .append(CommonConst.CACHE_SPLIT).append(business).toString();

    }


    /**
     * 获取缓存的键 (游戏名称+platformCode+tenantId+roundid+业务场景)
     *
     * @param gameName 游戏名称
     * @param platformCode 平台code
     * @param tenantId 租户id
     * @param roundId  局号
     * @param business 业务
     * @return 缓存的键
     */
    public String generateRedisKey(String gameName,String platformCode,String tenantId, Long roundId, String business) {
        return new StringBuilder(gameName).append(CommonConst.CACHE_SPLIT).append(platformCode).append(CommonConst.CACHE_SPLIT).append(tenantId)
                .append(CommonConst.CACHE_SPLIT).append(roundId).append(CommonConst.CACHE_SPLIT).append(business).toString();

    }

    /**
     * 获取缓存的键 (游戏名称+platformCode+tenantId+roundid+buildingNum+业务场景)
     *
     * @param gameName 游戏名称
     * @param platformCode 平台code
     * @param tenantId 租户id
     * @param roundId  局号
     * @param business 业务
     * @param buildingNum 建筑物编号
     * @return 缓存的键
     */
    public String generateRedisKey(String gameName,String platformCode,String tenantId, Long roundId, String business,Integer buildingNum) {
        return new StringBuilder(gameName).append(CommonConst.CACHE_SPLIT).append(platformCode).append(CommonConst.CACHE_SPLIT)
                .append(tenantId).append(CommonConst.CACHE_SPLIT).append(roundId).append(CommonConst.CACHE_SPLIT).append(business)
                .append(CommonConst.CACHE_SPLIT).append(buildingNum).toString();

    }

    /**
     * 发送消息给redis channel
     * @param channel
     * @param message
     */
    public void sendMessageToChannel(String channel, String message) {
        redisTemplate.convertAndSend(channel, message);
    }


}