Spring Boot 中使用 Redis

科技资讯 投稿 6000 0 评论

Spring Boot 中使用 Redis

Redis 环境

下载地址:https://redis.io/download/
下载后上传到云服务器上,如 /usr/local 中

gcc 环境安装:yum install -y gcc-c++

解压:tar -zxvf xxx

进入解压后的 redis 目录下执行
编译:make
安装:make install

下载 redis/bin/redis.conf 进行下列配置后上传覆盖原文件:
1. 注释掉 bind 127.0.0.1
2. 设置 protected-mode 为 no
3. 建议设置密码 requirepass xxx

在 redis/bin 下执行命令使用配置文件方式后台启动 redis:
./redis-server redis.conf &

查看 redis 启动状态:
ps -ef|grep redis

其他:
关闭 redis:redis-cli shutdown

连接问题参考:
1. 终端执行,防火墙放行:firewall-cmd --zone=public --add-port=6379/tcp --permanent
2. 终端执行,防火墙重启:firewall-cmd --reload
3. 云服务器端口开放问题:在实例-》安全组管理中开放 6379 端口

Spring Boot 中使用 Redis

1. 添加 pom

<!-- spring-boot-starter-data-redis 若需要指定版本号自行 maven 仓库中找 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2. 添加配置

spring:
  redis:
    database: 0
    host: xxxxx      # Redis服务器地址,修改为你的地址
    port: 6379              # Redis服务器连接端口
    password: xxxxx          # Redis服务器连接密码(默认为空)
    timeout: 3000           # Redis服务器链接超时配置

3. 导入 redis 工具类

PS:redis 工具类对常用操作进行了封装,可自行研究食用。

/**
 * Redis 工具类
 */
@Component
public class RedisUtil {

    @Resource
    private RedisTemplate<String, Object> redisTemplate;

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

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

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

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

    /**
     * 删除缓存
     *
     * @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 值
     */
    public Object get(String key {
        return key == null ? null : redisTemplate.opsForValue(.get(key;
    }

    /**
     * 普通缓存放入
     *
     * @param key   键
     * @param value 值
     * @return true成功 false失败
     */
    public boolean set(String key, Object value {
        try {
            redisTemplate.opsForValue(.set(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 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 {
            e.printStackTrace(;
            return false;
        }
    }

    /**
     * 分布式锁
     * @param key               锁住的key
     * @param lockExpireMils    锁住的时长。如果超时未解锁,视为加锁线程死亡,其他线程可夺取锁
     * @return
     */
    public boolean setNx(String key, Long lockExpireMils {
        // new RedisCallback<>( {
        //     @Override
        //     public Object doInRedis(RedisConnection redisConnection throws DataAccessException {
        //         return null;
        //     }
        // };
        return (boolean redisTemplate.execute((RedisCallback connection -> {
            //获取锁
            /*
              setNX(k,v:如果该键不存在,则设置该键的值为指定的字符串;否则不做任何事情;
              使用 setNX( 命令可以实现分布式锁等功能,因为该命令在设置键值对时是具有原子性的。
              在多线程或多进程环境中,如果多个线程或进程同时尝试使用 setNX( 命令来设置同一个键,
              只有一个线程或进程能够成功地设置,其他线程或进程会失败,从而实现了互斥操作。
             */
            return connection.setNX(key.getBytes(, String.valueOf(System.currentTimeMillis( + lockExpireMils + 1.getBytes(;
        };
    }

    /**
     * 递增
     *
     * @param key   键
     * @param delta 要增加几(大于0
     * @return
     */
    public long incr(String key, long delta {
        if (delta < 0 {
            throw new RuntimeException("递增因子必须大于0";
        }
        // 将指定 key 的值增加 delta。如果 key 不存在,则会先创建一个初始值为 0 的 key,然后再执行增加操作。
        return redisTemplate.opsForValue(.increment(key, delta;
    }

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

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

    /**
     * HashGet
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @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 true 成功 false 失败
     */
    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 时间(秒
     * @return true成功 false失败
     */
    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 {
            e.printStackTrace(;
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value {
        try {
            redisTemplate.opsForHash(.put(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 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 {
            e.printStackTrace(;
            return false;
        }
    }

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

    /**
     * 判断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  键
     * @param item 项
     * @param by   要增加几(大于0
     * @return
     */
    public double hincr(String key, String item, double by {
        return redisTemplate.opsForHash(.increment(key, item, by;
    }

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

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

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

    /**
     * 将set数据放入缓存
     *
     * @param key    键
     * @param time   时间(秒
     * @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 {
            e.printStackTrace(;
            return 0;
        }
    }

    /**
     * 获取set缓存的长度
     *
     * @param key 键
     * @return
     */
    public long sGetSetSize(String key {
        try {
            return redisTemplate.opsForSet(.size(key;
        } catch (Exception e {
            e.printStackTrace(;
            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;
        } catch (Exception e {
            e.printStackTrace(;
            return 0;
        }
    }
    //===============================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 {
            e.printStackTrace(;
            return null;
        }
    }

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

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

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒
     * @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 {
            e.printStackTrace(;
            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 {
            e.printStackTrace(;
            return false;
        }
    }

    /**
     * 将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 {
            e.printStackTrace(;
            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 {
            e.printStackTrace(;
            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;
        } catch (Exception e {
            e.printStackTrace(;
            return 0;
        }
    }

    /**
     * 模糊查询获取key值
     *
     * @param pattern
     * @return
     */
    public Set keys(String pattern {
        return redisTemplate.keys(pattern;
    }

    /**
     * 使用Redis的消息队列
     *
     * @param channel
     * @param message 消息内容
     */
    public void convertAndSend(String channel, Object message {
        redisTemplate.convertAndSend(channel, message;
    }


    //=========BoundListOperations 用法 start============

    /**
     * 将数据添加到Redis的list中(从右边添加)
     *
     * @param listKey
     * @param timeout 有效时间
     * @param unit    时间类型
     * @param values  待添加的数据
     */
    public void addToListRight(String listKey, long timeout, TimeUnit unit, Object... values {
        //绑定操作
        BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey;
        //插入数据
        boundValueOperations.rightPushAll(values;
        //设置过期时间
        boundValueOperations.expire(timeout, unit;
    }

    /**
     * 根据起始结束序号遍历Redis中的list
     *
     * @param listKey
     * @param start   起始序号
     * @param end     结束序号
     * @return
     */
    public List<Object> rangeList(String listKey, long start, long end {
        //绑定操作
        BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey;
        //查询数据
        return boundValueOperations.range(start, end;
    }

    /**
     * 弹出右边的值 --- 并且移除这个值
     *
     * @param listKey
     */
    public Object rightPop(String listKey {
        //绑定操作
        BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey;
        return boundValueOperations.rightPop(;
    }

    //=========BoundListOperations 用法 End============

}

4. 测试

@RunWith(SpringRunner.class
@SpringBootTest
public class MyTest {

    @Resource
    private RedisUtil redisUtil;

    @Resource
    private RedisTemplate<String, Object> redisTemplate;

    @Test
    public void test_redis_util( {
        boolean flag = redisUtil.set("key", "value";
        String v = (String redisUtil.get("key";
        System.out.println("flag = " + flag + " v = " + v;
    }

    @Test
    public void test_redisTemplate( {
        ValueOperations<String, Object> ops = redisTemplate.opsForValue(;
        ops.set("k1", "v1";
        System.out.println(ops.get("k1";
    }
}    

编程笔记 » Spring Boot 中使用 Redis

赞同 (34) or 分享 (0)
游客 发表我的评论   换个身份
取消评论

表情
(0)个小伙伴在吐槽