redis template工具類

package com.devin.multi_room.util;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * @author devin
 * @version 1.1.0
 * 基于spring和redis的redisTemplate工具類
 * 針對所有的hash 都是以h開頭的方法
 * 針對所有的Set 都是以s開頭的方法  不含通用方法
 * 針對所有的List 都是以l開頭的方法
 * 為避免不必要的錯誤，key值都設定了不能為空串
 * @date 2019/12/19
 */
@Component
@Slf4j
public class RedisUtil {

    private RedisTemplate<String, Object> redisTemplate;

    @Autowired
    public RedisUtil(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    /** 預設緩存時間30d */
    public static Integer EXPIRE_TIME_DEFAULT = 24 * 60 * 60 * 30;

    /** 分頁查詢緩存時間為2h */
    public static Integer EXPIRE_TIME_PAGE_QUERY = 60 * 60 * 2;

    /**
     * 指定緩存失效時間
     *
     * @param key  鍵
     * @param time 時間(秒)
     * @return true 成功 false 失敗
     */
    public boolean expire(final String key, final long time) {
        try {
            if (time > 0 && key != null && !key.isEmpty()) {
                redisTemplate.expire(key, time, TimeUnit.SECONDS);
            }
            return true;
        } catch (Exception e) {
            log.error("指定" + key + "失效時間失敗, 原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 根據正規表達式删除key
     *
     * @param pattern 正規表達式
     */
    public void deleteByPattern(final String pattern) {
        Set<String> keys = redisTemplate.keys(pattern);
        if (keys != null && !keys.isEmpty()) {
            Long delete = redisTemplate.delete(keys);
            log.info("已删除滿足正規表達式[" + pattern + "]的key，删除數量：" + delete);
        }
    }

    /**
     * 根據key 擷取過期時間
     *
     * @param key 鍵 不能為null
     * @return 時間(秒) 傳回0 代表為永久有效 傳回-2表示key不存在 傳回-1表示key沒有設定過期政策
     * @throws NullPointerException key為null時抛出
     */
    public long getExpire(final String key) {
        if (null == key) {
            throw new NullPointerException("key不能為null");
        }
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }

    /**
     * 正規表達式比對是否存在該key
     *
     * @param pattern 正規表達式
     * @return true 存在 false 不存在
     */
    public boolean hasKeyByPattern(final String pattern) {
        Set<String> keys = redisTemplate.keys(pattern);
        return keys != null && !keys.isEmpty();
    }

    /**
     * 判斷key是否存在
     *
     * @param key 鍵
     * @return true 存在 false不存在
     * @throws NullPointerException key值為null時抛出
     */
    public boolean hasKey(final String key) {
        if (null == key) {
            throw new NullPointerException("key值不能為null");
        }
        return redisTemplate.hasKey(key);
    }

    /**
     * 删除緩存
     *
     * @param keys 可以傳一個值 或多個
     */
    public void del(final String... keys) {
        if (keys != null && keys.length > 0) {
            if (keys.length == 1) {
                redisTemplate.delete(keys[0]);
                log.info("删除鍵[" + keys[0] + "]");
            } else {
                log.info("删除鍵" + Arrays.toString(keys));
                redisTemplate.delete(Arrays.asList(keys));
            }
        }
    }


    //============================String相關=============================//

    /**
     * 普通緩存擷取
     *
     * @param key 鍵
     * @return 值 如果 key為null 傳回 null
     */
    public Object get(final String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }

    /**
     * 普通緩存擷取
     *
     * @param pattern 鍵,帶有正規表達式
     * @return 值 如果值不存在傳回 null 如果值有一個傳回一個對象， 如果值有多個，傳回List<Object> 類型
     */
    public Object getByPattern(final String pattern) {
        Set<String> keys = redisTemplate.keys(pattern);
        if (keys == null || keys.size() == 0) {
            return null;
        }
        List<Object> objects = redisTemplate.opsForValue().multiGet(keys);
        if (objects == null || objects.size() == 0) {
            return null;
        } else if (objects.size() == 1) {
            return objects.get(0);
        } else {
            return objects;
        }
    }


    /**
     * 普通緩存放入
     *
     * @param key   鍵
     * @param value 值
     * @return true成功 false失敗
     */
    public boolean set(final String key, final Object value) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            if (value == null) {
                throw new IllegalArgumentException("value不能為null");
            }
            redisTemplate.opsForValue().set(key, value);
            return true;
        } catch (Exception e) {
            log.error("設定緩存[" + key + "]失敗, 原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 普通緩存放入并設定時間
     *
     * @param key   鍵
     * @param value 值
     * @param time  時間(秒) time要大于0 如果time小于等于0 将設定無限期
     * @return true成功 false 失敗
     */
    public boolean set(final String key, final Object value, final long time) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            if (value == null) {
                throw new IllegalArgumentException("value不能為null");
            }
            if (time > 0) {
                redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
            } else {
                set(key, value);
            }
            return true;
        } catch (Exception e) {
            log.error("設定緩存[" + key + "]失敗, 原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 值遞增
     *
     * @param key 鍵
     * @param delta 每次遞增的值
     * @return 遞增後的值
     */
    public long incr(final String key, final long delta) {
        if (key == null || key.isEmpty()) {
            throw new IllegalArgumentException("key值不能為" + key);
        }
        if (delta < 0) {
            throw new IllegalArgumentException("遞增因子必須大于0");
        }
        return redisTemplate.opsForValue().increment(key, delta);
    }

    /**
     * 值遞減
     *
     * @param key 鍵
     * @param delta 每次遞減的值
     * @return 遞減後的值
     */
    public long decr(final String key, final long delta) {
        if (key == null || key.isEmpty()) {
            throw new IllegalArgumentException("key值不能為" + key);
        }
        if (delta < 0) {
            throw new RuntimeException("遞減因子必須大于0");
        }
        return redisTemplate.opsForValue().increment(key, -delta);
    }

    //============================Map相關=============================//

    /**
     * 擷取hash中的某一項
     *
     * @param key  鍵 不能為null和空串
     * @param item 項 不能為null
     * @throws IllegalArgumentException 當key或者item為null或者空字元串時抛出
     * @return 值
     */
    public Object hGet(final String key, final String item) {
        if (key == null || key.isEmpty()) {
            throw new IllegalArgumentException("key值不能為" + key);
        }
        if (item == null || item.isEmpty()) {
            throw new IllegalArgumentException("item值不能為" + key);
        }
        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 擷取hash中的所有鍵值
     *
     * @param key 鍵
     * @throws IllegalArgumentException key值為null或者空字元串時抛出
     * @return 對應的多個鍵值
     */
    public Map<Object, Object> hGetAll(final String key) {
        if (key == null || key.isEmpty()) {
            throw new IllegalArgumentException("key值不能為" + key);
        }
        return redisTemplate.opsForHash().entries(key);
    }

    /**
     * 設定多個hash值
     *
     * @param key 鍵
     * @param map 對應多個鍵值
     * @return true 成功 false 失敗
     */
    public boolean hMultiSet(final String key, final Map<String, Object> map) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            if (map == null) {
                throw new IllegalArgumentException("map不能為null");
            }
            redisTemplate.opsForHash().putAll(key, map);
            return true;
        } catch (Exception e) {
            log.error("設定多個hash值失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 設定多個hash值并設定過期時間
     *
     * @param key  鍵
     * @param map  對應多個鍵值
     * @param time 時間(秒)
     * @return true成功 false失敗
     */
    public boolean hMultiSet(final String key, final Map<String, Object> map, final long time) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            if (map == null) {
                throw new IllegalArgumentException("map不能為null");
            }
            redisTemplate.opsForHash().putAll(key, map);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            log.error("設定多個hash值失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 向一張hash表中放入資料,如果不存在将建立
     *
     * @param key   鍵
     * @param item  項
     * @param value 值
     * @return true 成功 false失敗
     */
    public boolean hSet(final String key, final String item, final Object value) {
        try {
            if (key == null || key.isEmpty()) {
                if (item == null || item.isEmpty()) {
                    throw new IllegalArgumentException("item值不能為" + key);
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForHash().put(key, item, value);
            return true;
        } catch (Exception e) {
            log.error("設定多個hash值失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 向一張hash表中放入資料,如果不存在将建立
     *
     * @param key   鍵
     * @param item  項
     * @param value 值
     * @param time  時間(秒)  注意:如果已存在的hash表有時間,這裡将會替換原有的時間
     * @return true 成功 false失敗
     */
    public boolean hSet(final String key, final String item, final Object value, final long time) {
        try {
            if (key == null || key.isEmpty()) {
                if (item == null || item.isEmpty()) {
                    throw new IllegalArgumentException("item值不能為" + key);
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForHash().put(key, item, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            log.error("設定多個hash值失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 删除hash表中的值
     *
     * @param key  鍵 不能為null
     * @param item 項 可以使多個 不能為null
     */
    public void hDel(final String key, final Object... item) {
        if (key == null || key.isEmpty()) {
            if (item == null) {
                throw new IllegalArgumentException("item值不能為null");
            }
            throw new IllegalArgumentException("key值不能為" + key);
        }
        if (item.length > 0) {
            redisTemplate.opsForHash().delete(key, item);
        }
    }

    /**
     * 判斷hash表中是否有該項的值
     *
     * @param key  鍵 不能為null
     * @param item 項 不能為null
     * @throws IllegalArgumentException 當key或者item為null或者空串的時候抛出該異常
     * @return true 存在 false不存在
     */
    public boolean hHasKey(final String key, final String item) {
        if (key == null || key.isEmpty()) {
            if (item == null) {
                throw new IllegalArgumentException("item值不能為null");
            }
            throw new IllegalArgumentException("key值不能為" + key);
        }
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash遞增 如果不存在,就會建立一個 并把新增後的值傳回
     *
     * @param key  鍵
     * @param item 項
     * @throws IllegalArgumentException 當key或者item為null或者空串時抛出此異常
     * @param by   要增加幾(大于0)
     * @return 增加後的值
     */
    public double hIncr(final String key, final String item, final double by) {
        if (key == null || key.isEmpty()) {
            if (item == null) {
                throw new IllegalArgumentException("item值不能為null");
            }
            throw new IllegalArgumentException("key值不能為" + key);
        }
        return redisTemplate.opsForHash().increment(key, item, by);
    }

    /**
     * hash遞減
     *
     * @param key  鍵
     * @param item 項
     * @throws IllegalArgumentException 當key或者item為null或者空串時抛出此異常
     * @param by   要減少記(小于0)
     * @return 減少後的值
     */
    public double hDecr(final String key, final String item, final double by) {
        if (key == null || key.isEmpty()) {
            if (item == null) {
                throw new IllegalArgumentException("item值不能為null");
            }
            throw new IllegalArgumentException("key值不能為" + key);
        }
        return redisTemplate.opsForHash().increment(key, item, -by);
    }

    //============================set相關=============================//

    /**
     * 根據key擷取Set中的所有值
     *
     * @param key 鍵
     * @return 如果該鍵不存在，那麼傳回null,如果存在，那麼傳回Set
     */
    public Set<Object> sGet(final String key) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForSet().members(key);
        } catch (Exception e) {
            log.error("擷取set中的所有值失敗，原因：" + e.getMessage());
            return null;
        }
    }

    /**
     * 根據value從一個set中查詢,是否存在
     *
     * @param key   鍵
     * @param value 值
     * @return true 存在 false不存在
     */
    public boolean sHasKey(final String key, final Object value) {
        try {
            if (key == null || key.isEmpty()) {
                if (value == null) {
                    throw new IllegalArgumentException("value值不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForSet().isMember(key, value);
        } catch (Exception e) {
            log.error("查詢value失敗，原因" + e.getMessage());
            return false;
        }
    }

    /**
     * 将資料放入set緩存
     *
     * @param key    鍵
     * @param values 值 可以是多個
     * @return 成功個數， 失敗傳回0
     */
    public long sSet(final String key, final Object... values) {
        try {
            if (key == null || key.isEmpty()) {
                if (values == null) {
                    throw new IllegalArgumentException("values值不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForSet().add(key, values);
        } catch (Exception e) {
            log.error("設定多個set類型值失敗，原因" + e.getMessage());
            return 0;
        }
    }

    /**
     * 将set資料放入緩存
     *
     * @param key    鍵
     * @param time   時間(秒)
     * @param values 值 可以是多個
     * @return 成功個數 失敗傳回0
     */
    public long sSetAndTime(final String key, final long time, final Object... values) {
        try {
            if (key == null || key.isEmpty()) {
                if (values == null) {
                    throw new IllegalArgumentException("values值不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            Long count = redisTemplate.opsForSet().add(key, values);
            if (time > 0) {
                expire(key, time);
            }
            return count;
        } catch (Exception e) {
            log.error("設定多個set類型值失敗，原因" + e.getMessage());
            return 0;
        }
    }

    /**
     * 擷取set緩存的長度
     *
     * @param key 鍵
     * @return set的長度，如果不存在傳回0
     */
    public long sGetSetSize(final String key) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            log.error("擷取set類型長度失敗，原因：" + e.getMessage());
            return 0;
        }
    }

    /**
     * 移除值為value的
     *
     * @param key    鍵
     * @param values 值 可以是多個
     * @return 移除的個數，不存在傳回0
     */
    public long setRemove(final String key, final Object... values) {
        try {
            if (key == null || key.isEmpty()) {
                if (values == null) {
                    throw new IllegalArgumentException("values值不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            Long count = redisTemplate.opsForSet().remove(key, values);
            return count;
        } catch (Exception e) {
            log.error("移除多個set值失敗，原因：" + e.getMessage());
            return 0;
        }
    }

    //===============================list相關=================================//

    /**
     * 擷取list緩存的内容
     *
     * @param key   鍵
     * @param start 開始
     * @param end   結束  0 到 -1代表所有值
     * @return 指定範圍内的元素清單。
     * 超出範圍的索引不會産生錯誤。如果start大于清單的末尾，則傳回一個空清單。如果stop大于清單的實際末尾，則Redis會将其視為清單的最後一個元素。
     */
    public List<Object> lGet(final String key, final long start, final long end) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForList().range(key, start, end);
        } catch (Exception e) {
            log.error("擷取list緩存内容失敗，原因：" + e.getMessage());
            return null;
        }
    }

    /**
     * 擷取list緩存的長度
     *
     * @param key 鍵
     * @return list緩存的長度
     */
    public long lGetListSize(final String key) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForList().size(key);
        } catch (Exception e) {
            log.error("擷取list緩存長度失敗，原因：" + e.getMessage());
            return 0;
        }
    }

    /**
     * 通過索引 擷取list中的值
     *
     * @param key   鍵
     * @param index 索引  index>=0時， 0 表頭，1 第二個元素，依次類推；index<0時，-1，表尾，-2倒數第二個元素，依次類推
     * @return 成功傳回list中指定索引的侄，失敗傳回null
     */
    public Object lGetIndex(final String key, final long index) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            return redisTemplate.opsForList().index(key, index);
        } catch (Exception e) {
            log.error("擷取list緩存長度失敗，原因：" + e.getMessage());
            return null;
        }
    }

    /**
     * 将list放入緩存
     *
     * @param key   鍵
     * @param value 值
     * @return 成功傳回true，失敗傳回false
     */
    public boolean lSet(final String key, final Object value) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForList().rightPush(key, value);
            return true;
        } catch (Exception e) {
            log.error("擷取list緩存失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 将list放入緩存
     *
     * @param key   鍵
     * @param value 值
     * @param time  時間(秒)
     * @return 成功傳回true， 失敗傳回false
     */
    public boolean lSet(final String key, final Object value, final long time) {
        try {
            if (key == null || key.isEmpty()) {
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForList().rightPush(key, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            log.error("設定list緩存失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 将list放入緩存
     *
     * @param key   鍵
     * @param value 值
     * @return 成功傳回true，失敗傳回false
     */
    public boolean lSet(final String key, final List<Object> value) {
        try {
            if (key == null || key.isEmpty()) {
                if (value == null) {
                    throw new IllegalArgumentException("value不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForList().rightPushAll(key, value);
            return true;
        } catch (Exception e) {
            log.error("設定list緩存失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 将list放入緩存
     *
     * @param key   鍵
     * @param value 值
     * @param time  時間(秒)
     * @return 成功傳回true，失敗傳回false
     */
    public boolean lSet(final String key, final List<Object> value, final long time) {
        try {
            if (key == null || key.isEmpty()) {
                if (value == null) {
                    throw new IllegalArgumentException("value不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForList().rightPushAll(key, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            log.error("設定list緩存失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 根據索引修改list中的某條資料
     *
     * @param key   鍵
     * @param index 索引
     * @param value 值
     * @return 成功傳回true，失敗傳回false
     */
    public boolean lUpdateIndex(final String key, final long index, final Object value) {
        try {
            if (key == null || key.isEmpty()) {
                if (value == null) {
                    throw new IllegalArgumentException("value不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            redisTemplate.opsForList().set(key, index, value);
            return true;
        } catch (Exception e) {
            log.error("設定list緩存失敗，原因：" + e.getMessage());
            return false;
        }
    }

    /**
     * 移除N個值為value
     *
     * @param key   鍵
     * @param count 移除多少個
     * @param value 值
     * @return 移除的個數
     */
    public long lRemove(final String key, final long count, final Object value) {
        try {
            if (key == null || key.isEmpty()) {
                if (value == null) {
                    throw new IllegalArgumentException("value不能為null");
                }
                throw new IllegalArgumentException("key值不能為" + key);
            }
            Long remove = redisTemplate.opsForList().remove(key, count, value);
            return remove == null ? 0 : remove;
        } catch (Exception e) {
            log.error("移除list緩存失敗，原因：" + e.getMessage());
            return 0;
        }
    }
}