SpringBoot集成redis（1）|（redisTemplate方式集成）

忘是亡心i 2023-10-03 20:17 49阅读 0赞

## SpringBoot集成redis（1）|（redisTemplate方式集成） ##

--------------------

### 文章目录  SpringBoot集成redis（1）|（redisTemplate方式集成）  @\[TOC\]  前言  一、redis是什么？  二、集成步骤  1.依赖引入  2.文件配置  3.定义redisKey的规则  4.定义数据存储对象  5.redis操作工具类编写  6.业务调用代码  7.redis存储数据展示  总结 ###

章节  
第一章链接: [SpringBoot集成Elasticsearch7.x（1）|（增删改查功能实现）][SpringBoot_Elasticsearch7.x_1]

## 前言 ##

本章节主要介绍SpringBoot项目集成Redis的一些相关知识，主要介绍的是基于Springboot自带的redisTemplate方式实现对redis的操作，redisTemplate优势有封装了好多函数，配置比较简单，且支持单机、哨兵、集群模式切换。

## 一、redis是什么？ ##

Redis 是一个内存中的数据结构存储系统，它可以用作数据库，缓存。它支持多种类型的数据结构，如字符串（strings）、哈希列（hashes）、列表（lists）、集合（sets）、有序集合（sorted sets）与范围查询，bitmaps、hyperloglogs和地理空间（geospatial）索引半径查询。Redis内置了复制（replication）、LUA脚本（Luascripting）、LRU驱动事件（LRU eviction）、事务（transactions）和不同级别的磁盘持久化（persistence），并通过Redis哨兵（Sentinel）和自动分区（Cluster）提高可用性（highavailability）

## 二、集成步骤 ##

### 1.依赖引入 ###

> pom依赖如下，主要列出SpringBoot依赖版本以及Redis版本，其他需要依赖自行添加

<parent>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-parent</artifactId>
          <version>2.5.7</version>
          <relativePath/>
      </parent>
      
      
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-redis</artifactId>
          <version>2.6.1</version>
      </dependency>

### 2.文件配置 ###

> yml配置,配置了单机模式、哨兵模式、集群模式

spring:
      redis:
        host: 127.0.0.1
        port: 6379
        password: redis
        timeout: 30000
        database: 1
    #哨兵配
    #    sentinel:
    #      master: mymaster
    #      nodes: 127.0.0.1:26379,127.0.0.1:26380,127.0.0.1:26381
    #集群配置
    #    cluster:
    #      max-redirects: 100
    #      nodes: 127.0.0.1:6379,127.0.0.1:6380,127.0.0.1:6381,127.0.0.1:6382,127.0.0.1:6383,127.0.0.1:6384

### 3.定义redisKey的规则 ###

> 定义redis存储数据key的规则，key类似于给redis数据进行存储划分，通过建立规范的key可以很好的维护redis数据的，呈现出问题的时候也方便排查，

/**
     * Created by Oak on 2022/1/13.
     * Description: 定义redis中key规则
     * {项目名称}：{模块/_描述/}：/{参数}/    value
     */
    public class RedisKey {
        
    
        public static final String PREFIX ="explo:";
        public static final String TEST =PREFIX+"test:%s";
        public static final String USER =PREFIX+"user:%s";
        public static final String EMPLOYEE =PREFIX+"employee:%s";
        /**shiro 用户session redis key*/
        public static final String SHIRO_SESSION =PREFIX+"session:";
        /**shiro 用户cache redis key*/
        public static final String SHIRO_CACHE = PREFIX+"cache";
        /**登录错误次数 redis key*/
        public static final String LOGIN_FAIL = PREFIX+"login_fail:";
    
        public static String keyFormate(String template,String keyword){
        
            return String.format(template, keyword);
        }
    }

--------------------

### 4.定义数据存储对象 ###

> 定义数据库集合，定义好字段，该处用了lombok表达式，如不需要可自定义set、get方法取代

@Data
    @NoArgsConstructor
    @AllArgsConstructor
    @Builder
    public class EmployeeDto {
        
        private String id;
        private String name;
        private String no_id;
        private int workYear;
        private String dept;
        private EmpInfoPo info;
    }

--------------------

> EmpInfoPo 实体类

@Data
    @NoArgsConstructor
    @AllArgsConstructor
    @Builder
    public class EmpInfoPo {
        
        private int age;
        @DateTimeFormat(pattern = "yyyy-MM-dd")
        private Date birth;
        private int gender;
        private String like;
    }

--------------------

### 5.redis操作工具类编写 ###

> 主要封装redis操作函数，业务层实现单纯的业务和redis操作进行解耦，这样方便管理，以及异常处理。包含对string、set、map、list、object等的操作。

package com.oak.net.redis;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    
    import java.util.*;
    import java.util.concurrent.TimeUnit;
    
    /**
     * Description:redis 操作类
     */
    @Component
    public class RedisUtil {
        
        @Autowired
        private RedisTemplate<String, Object> 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(Arrays.asList(key));
                }
            }
        }
        /**
         * 普通缓存获取
         *
         * @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   键
         * @param delta 要增加几(大于0)
         * @return
         */
        public long incr(String key, long delta) {
        
            if (delta < 0) {
        
                throw new RuntimeException("递增因子必须大于0");
            }
            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;
            }
        }
    }

--------------------

### 6.业务调用代码 ###

> 业务层使用redis代码，操作redis的函数在工具类里面基本全部覆盖，增删改查，自增、自减、判断key是否存在等待。这里不一一举例，大家可以详细参考 RedisUtil工具类

import com.oak.net.redis.RedisKey;
    import com.oak.net.redis.RedisUtil;
    import com.oak.net.response.ResponseHandle;
    import com.oak.net.rest.entity.dto.EmployeeDto;
    import com.oak.net.rest.entity.dto.po.EmpInfoPo;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.Calendar;
    import java.util.Date;
    
    /**
     * Created by Oak 
     * Description:
     */
    
    @Api(tags = {
        "redis相关接口"})
    @RestController
    @RequestMapping("/redis")
    public class DemoCtrl {
        
        @Autowired
        private RedisUtil redisUtil;
        @ApiOperation(value = "保存员工信息", notes = "保存员工信息")
        @PostMapping(value = "/save")
        public ResponseHandle save() {
        
            Calendar calendar = Calendar.getInstance();
            calendar.add(Calendar.YEAR, -25);
            Date date = calendar.getTime();
            EmpInfoPo empInfoPo = EmpInfoPo.builder()
                    .age(25)
                    .gender(1)
                    .like("打篮球")
                    .birth(date)
                    .build();
            EmployeeDto build = EmployeeDto.builder()
                    .id("100")
                    .name("测试数据")
                    .dept("测试部门")
                    .workYear(2)
                    .no_id("20221001")
                    .info(empInfoPo)
                    .build();
            redisUtil.set(RedisKey.keyFormate(RedisKey.EMPLOYEE, build.getId()), build, 100);
            return ResponseHandle.SUCCESS(build);
        }
    }

--------------------

### 7.redis存储数据展示 ###

> 使用redisClient工具连接redis数据库，打开数据查看存储的数据格式如下

![请添加图片描述][6c3ed1419f32493a8c84fb758397a76e.png]

--------------------

## 总结 ##

以上就是SpringBoot集成redis内容，在RedisUtil封装了各种操作redis的函数，基本覆盖完全，通过这一篇文章可以掌握对redis操作。

[SpringBoot_Elasticsearch7.x_1]: https://blog.csdn.net/Oaklkm/article/details/125890437?spm=1001.2014.3001.5502
[6c3ed1419f32493a8c84fb758397a76e.png]: https://img-blog.csdnimg.cn/6c3ed1419f32493a8c84fb758397a76e.png