All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.rustknife.jknife.cache.CacheRedisContext Maven / Gradle / Ivy

The newest version!
package com.rustknife.jknife.cache;

import com.rustknife.jknife.cache.config.SpringContextAccessor;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.util.CollectionUtils;

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

@SuppressWarnings({"DuplicatedCode", "unchecked", "ConstantConditions"})
public class CacheRedisContext {

    private RedisTemplate redisTemplate = null;
    private boolean          usePrefix = true;
    private DefaultRedisCachePrefix cachePrefix = new DefaultRedisCachePrefix();

    private String redisTemplateName;

    public CacheRedisContext(String redisTemplateName) {
        this.redisTemplateName = redisTemplateName;
    }
    public RedisTemplate getRedisTemplate() {
        if(this.redisTemplate == null)
            this.redisTemplate = SpringContextAccessor.getBean(this.redisTemplateName);
        return redisTemplate;
    }

    public byte [] getRawKey(String cacheName, String key){
        byte []rawKey = getRedisTemplate().getStringSerializer().serialize(key);
        if (!usePrefix || cacheName == null || cacheName.isEmpty())
            return rawKey;

        byte []prefix = cachePrefix.prefix(cacheName);
        byte[] prefixedKey = Arrays.copyOf(prefix, prefix.length + rawKey.length);
        System.arraycopy(rawKey, 0, prefixedKey, prefix.length, rawKey.length);

        return prefixedKey;
    }

    public void flushAll(){
        getRedisTemplate().execute(connection -> {
            connection.flushAll();
            return null;
        }, true);
    }

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

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

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

    /**
     * 模糊查找 key 列表,同 keys 命令
     * @param cacheName cacheName
     * @param pattern 通配串, 默认为 *
     * @return Set
     */
    public Set keys(String cacheName, String pattern){
        Set keysRaw = keysRaw(cacheName, pattern);
        if(keysRaw == null || keysRaw.size() <= 0)
            return new HashSet<>();

        HashSet keys = new HashSet<>();
        for(byte[] keyRaw: keysRaw)
            keys.add((String) getRedisTemplate().getStringSerializer().deserialize(keyRaw));
        return keys;
    }

    /**
     * 模糊查找 raw key 列表
     * @param cacheName cacheName
     * @param pattern 通配串, 默认为 *
     * @return Set
     */
    public Set keysRaw(String cacheName, String pattern){
        if(pattern == null || pattern.isEmpty())
            pattern = "*";
        if(cacheName != null && !cacheName.isEmpty())
            pattern = cacheName + pattern;
        return getRedisTemplate().keys(getRawKey(null, pattern));
    }

    /**
     * 删除缓存
     * @param keys 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public void del(String cacheName, String ... keys){
        if(keys == null || keys.length <= 0)
            return ;

        if(keys.length==1){
            getRedisTemplate().delete(getRawKey(cacheName, keys[0]));
            return ;
        }

        List rawKeys = new LinkedList<>();
        for(String v:keys) {
            rawKeys.add(getRawKey(cacheName, v));
        }
        getRedisTemplate().delete(rawKeys);
    }

    /**
     * 删除缓存列表
     * @param keys 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public void del(String cacheName, Set keys){
        if(keys == null || keys.isEmpty())
            return ;

        if(keys.size() == 1) {
            getRedisTemplate().delete(getRawKey(cacheName, keys.iterator().next()));
            return;
        }

        List rawKeys = new LinkedList<>();
        for(String v:keys) {
            rawKeys.add(getRawKey(cacheName, v));
        }
        getRedisTemplate().delete(rawKeys);
    }

    /**
     * 按原始 key 删除缓存
     * @param keys 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public void delByRowKeys(String ... keys){
        if(keys == null || keys.length <= 0)
            return ;

        if(keys.length == 1) {
            getRedisTemplate().delete(keys[0]);
            return;
        }
        getRedisTemplate().delete(CollectionUtils.arrayToList(keys));
    }

    /**
     * 删除缓存列表
     * @param keys 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public void delByRowKeys(Set keys){
        if(keys == null || keys.isEmpty())
            return ;

        if(keys.size() == 1) {
            getRedisTemplate().delete(keys.iterator().next());
            return;
        }
        getRedisTemplate().delete(keys);
    }

    //============================String=============================
    /**
     * 普通缓存获取
     * @param key 键
     * @return 值
     */
    public  T get(String cacheName, String key){
        if(key == null)
            return null;
        ValueOperations vo = getRedisTemplate().opsForValue();
        return vo.get(getRawKey(cacheName, key));
    }

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

    }

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     * @param key 键
     * @param item 项
     * @param by 要增加几(大于0)
     * @return
     */
    public double hincr(String cacheName, String key, String item,double by){
        return getRedisTemplate().opsForHash().increment(getRawKey(cacheName, key), item, by);
    }

    /**
     * hash递减
     * @param key 键
     * @param item 项
     * @param by 要减少记(小于0)
     * @return
     */
    public double hdecr(String cacheName, String key, String item,double by){
        return getRedisTemplate().opsForHash().increment(getRawKey(cacheName, key), item,-by);
    }

    //============================set=============================
    /**
     * 根据key获取Set中的所有值
     * @param key 键
     * @return
     */
    public Set sGet(String cacheName, String key){
        try {
            return getRedisTemplate().opsForSet().members(key);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

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

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

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

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

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

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

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

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

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

    /**
     * 将list放入缓存
     * @param key 键
     * @param value 值
     * @param time 时间(秒)
     * @return
     */
    public boolean lSet(String cacheName, String key, Object value, long time) {
        try {
            getRedisTemplate().opsForList().rightPush(getRawKey(cacheName, key), value);
            if (time > 0) expire(cacheName, key, time);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list放入缓存
     * @param key 键
     * @param value 值
     * @return
     */
    public boolean lSet(String cacheName, String key, List value) {
        try {
            getRedisTemplate().opsForList().rightPushAll(getRawKey(cacheName, key), value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list放入缓存
     * @param key 键
     * @param value 值
     * @param time 时间(秒)
     * @return
     */
    public boolean lSet(String cacheName, String key, List value, long time) {
        try {
            getRedisTemplate().opsForList().rightPushAll(getRawKey(cacheName, key), value);
            if (time > 0) expire(cacheName, key, time);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

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

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