springboot集成redis：整合单节点redis、发布订阅、哨兵-主备读写分离、集群

不念不忘少年蓝@ 2023-10-09 23:20 10阅读 0赞

**目录**

一、springboot整合单节点redis

1、添加依赖

2、添加配置application.yml配置

3、添加配置类

4、工具类

5、发布与订阅

5.1 添加配置对象

5.2 定义消息接收类

5.3 使用：在redisUtils工具类中添加发布消息的方法

5.4 发布消息

二、哨兵-主备读写分离

1.添加依赖

2、配置yml

3、添加配置文件

4、工具类同上

三、集群

1、添加Spring Boot和Redis依赖

2、修改配置文件

3、配置类(创建RedisTemplate实例)

4、工具类同上

5、使用postman调接口测试Redis集群

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

## 一、springboot整合单节点redis ##

### 1、添加依赖 ###

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
        <version>2.7.0</version>
    </dependency>

### 2、添加配置application.yml配置 ###

spring:
      redis:
        database: 0
        host: 127.0.0.1
        port: 6379
        password: 
        lettuce:
          pool:
             # 连接池中的最大空闲连接 默认8      
            max-idle: 8
            # 连接池中的最小空闲连接 默认0
            min-idle: 0
            # 连接池最大连接数 默认8 ，负数表示没有限制
            max-active: 8
            # 连接池最大阻塞等待时间（使用负值表示没有限制） 默认-1
            max-wait: -1
        timeout: 30000

### 3、添加配置类 ###

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.data.redis.connection.RedisConnectionFactory;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    
    import javax.annotation.Resource;
    
    /**
     * @Description: redis配置类
     */
    @Configuration
    public class RedisConfiguration {
    
        @Resource
        private RedisConnectionFactory redisConnectionFactory;
    
        @Bean
        public RedisTemplate<String, Object> redisTemplate() {
            RedisTemplate<String, Object> redisTemplate= new RedisTemplate<>();
            // 可根据需要添加序列化器
            // template.setDefaultSerializer(new Jackson2JsonRedisSerializer<>(Object.class));
            // key采用String的序列化方式
            redisTemplate.setKeySerializer(new StringRedisSerializer());
            redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
            redisTemplate.setHashKeySerializer(new StringRedisSerializer());
            redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
            redisTemplate.setConnectionFactory(redisConnectionFactory);
            return redisTemplate;
        }
    
    }

### 4、工具类 ###

import com.fasterxml.jackson.core.type.TypeReference;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import lombok.extern.log4j.Log4j2;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.core.ZSetOperations;
    import org.springframework.stereotype.Component;
    import org.springframework.util.CollectionUtils;
    import org.springframework.util.StringUtils;
    
    import java.io.IOException;
    import java.util.Collection;
    import java.util.List;
    import java.util.Map;
    import java.util.Set;
    import java.util.concurrent.TimeUnit;
    
    
    /**
     * Redis工具类
     */
    
    @Component
    @Log4j2
    public final class RedisUtil {
        @Autowired
        private RedisTemplate<String, Object> redisTemplate;
    
    
        public Map<String, Object> obtainMap(String jsonString) {
            ObjectMapper mapper = new ObjectMapper();
            Map<String, Object> map = null;
            try {
                map = mapper.readValue(jsonString, new TypeReference<Map<String, Object>>() {});
            } catch (IOException e) {
                e.printStackTrace();
            }
            return map;
        }
    
    
        // =============================common============================
        /**
         * 指定缓存失效时间
         * @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 Boolean.TRUE.equals(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 键
         * @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;
            }
        }
        //==============================zset===================================
    
        /**
         * 添加一个元素到排序集合
         *
         * @param key 键
         * @param value 值
         * @param score 分数
         * @return 是否成功添加
         */
        public Boolean zAdd(String key, Object value, double score) {
            ZSetOperations<String, Object> zSetOperations = redisTemplate.opsForZSet();
            return zSetOperations.add(key, value, score);
        }
    
        /**
         * 获取排序集合指定排名范围内的元素
         *
         * @param key 键
         * @param start 起始排名（从0开始）
         * @param end 终止排名（从0开始）
         * @return 排序集合指定排名范围内的元素
         */
        public Set<Object> zRange(String key, long start, long end) {
            ZSetOperations<String, Object> zSetOperations = redisTemplate.opsForZSet();
            return zSetOperations.range(key, start, end);
        }
    
        /**
         * 获取排序集合指定分数范围内的元素
         *
         * @param key 键
         * @param minScore 最小分数
         * @param maxScore 最大分数
         * @return 排序集合指定分数范围内的元素
         */
        public Set<Object> zRangeByScore(String key, double minScore, double maxScore) {
            ZSetOperations<String, Object> zSetOperations = redisTemplate.opsForZSet();
            return zSetOperations.rangeByScore(key, minScore, maxScore);
        }
    
        /**
         * 获取排序集合元素个数
         *
         * @param key 键
         * @return 排序集合元素个数
         */
        public Long zSize(String key) {
            ZSetOperations<String, Object> zSetOperations = redisTemplate.opsForZSet();
            return zSetOperations.size(key);
        }
    
        /**
         * 获取排序集合指定元素的分数
         *
         * @param key 键
         * @param value 值
         * @return 排序集合指定元素的分数
         */
        public Double zScore(String key, Object value) {
            ZSetOperations<String, Object> zSetOperations = redisTemplate.opsForZSet();
            return zSetOperations.score(key, value);
        }
    
        /**
         * 删除排序集合指定元素
         *
         * @param key 键
         * @param values 待删除的元素
         * @return 删除的元素个数
         */
        public Long zRemove(String key, Object... values) {
            ZSetOperations<String,Object> zSetOperations = redisTemplate.opsForZSet();
            return zSetOperations.remove(key, values);
        }
    
    
        // ===============================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;
            }
        }
    
    
    }

### 5、发布与订阅 ###

#### 5.1 添加配置对象 ####

/**
         * 消息监听
         * <p>
         * 可以传入多个 MessageListenerAdapter
         */
        @Bean
        RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory connectionFactory, MessageListenerAdapter messageListenerAdapter) {
            RedisMessageListenerContainer container = new RedisMessageListenerContainer();
            // 监听所有库的key过期事件
            container.setConnectionFactory(connectionFactory);
            // 可以添加多个 messageListener，配置不同的通道
            container.addMessageListener(messageListenerAdapter, new PatternTopic("user"));
            return container;
        }
        /**
         * 消息监听器适配器，绑定消息处理器
         * <p>
         * 可以配置多个 listenerAdapter，监听不同的通道
         */
        @Bean
        MessageListenerAdapter listenerAdapter(RedisMessageListener receiver) {
            return new MessageListenerAdapter(receiver, "onMessage");
        }

**其中的new PatternTopic("user")中的 user 就是通道名。**

#### 5.2 定义消息接收类 ####

/**
     * Redis 消息接收
     *
     * @Author Lizhou
     **/
    @Slf4j
    @Component
    public class RedisMessageListener implements MessageListener {
    
        @Override
        public void onMessage(Message message, byte[] pattern) {
            // 接收的topic
            log.info("channel:" + new String(pattern));
            // 消息的POJO
            log.info("message:" + message.toString());
        }
    }

#### 5.3 使用：在redisUtils工具类中添加发布消息的方法 ####

/**
         * 向通道发布消息
         */
        public boolean convertAndSend(String channel, Object message) {
            if (StringUtils.isEmpty(channel)) {
                return false;
            }
            try {
                redisTemplate.convertAndSend(channel, message);
    //            log.info("发送消息成功，channel：{}，message：{}", channel, message);
                return true;
            } catch (Exception e) {
    //            log.info("发送消息失败，channel：{}，message：{}", channel, message);
                e.printStackTrace();
            }
            return false;
        }

#### 5.4 发布消息 ####

public void get1(){
       String message = "Hello World!";
       // 发送消息
       redisUtils.convertAndSend("user", message);
    }

只要发布消息到通道中，有监听器的存在，就会跑到消息接收类RedisMessageListener的onMessage方法中。

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

## 二、哨兵-主备读写分离 ##

### 1.添加依赖 ###

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>

### 2、配置yml ###

spring:
      redis:
        client-type: LETTUCE
        sentinel:
          master: mymaster
          nodes: 192.168.109.134:26380,192.168.109.134:26381,192.168.109.134:26382
          password:

### 3、添加配置文件 ###

@Configuration
    public class RedisConfig {
    
        @Autowired
        private Environment environmet;
    
        @Bean("lettuceConnectionFactory")
        public RedisConnectionFactory lettuceConnectionFactory() {
            String master = environmet.getProperty("spring.redis.sentinel.master");
            Set<String> nodes = StringUtils.commaDelimitedListToSet(environmet.getProperty("spring.redis.sentinel.nodes"));
            String password = environmet.getProperty("spring.redis.sentinel.password");
    
            RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration(master, nodes);
            sentinelConfig.setPassword(RedisPassword.of(password));
            return new LettuceConnectionFactory(sentinelConfig);
        }
    
        @Bean
        public RedisTemplate<String, Object> redisTemplate(@Qualifier("lettuceConnectionFactory") RedisConnectionFactory factory) {
            RedisTemplate<String, Object> redisTemplate = new RedisTemplate();
            redisTemplate.setConnectionFactory(factory);
            return redisTemplate;
        }
        
    }

### 4、工具类同上 ###

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

## 三、集群 ##

### 1、添加Spring Boot和Redis依赖 ###

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>

### 2、修改配置文件 ###

spring:
      redis:
        database: 0
        cluster:
          nodes: 192.168.177.128:6379,192.168.177.128:6380,192.168.177.128:6381,192.168.177.128:6382,192.168.177.128:6383,192.168.177.128:6384
        password:
        lettuce:
          pool:
            # 连接池中的最大空闲连接 默认8
            max-idle: 8
            # 连接池中的最小空闲连接 默认0
            min-idle: 0
            # 连接池最大连接数 默认8 ，负数表示没有限制
            max-active: 8
            # 连接池最大阻塞等待时间（使用负值表示没有限制） 默认-1
            max-wait: -1
        timeout: 30000

### 3、配置类(创建RedisTemplate实例) ###

@Configuration
    public class RedisConfig {
    
        @Autowired
        private RedisConnectionFactory redisConnectionFactory;
    
        @Bean
        public RedisTemplate<String, Object> redisTemplate() {
            RedisTemplate<String, Object> redisTemplate= new RedisTemplate<>();
            // 可根据需要添加序列化器
            // template.setDefaultSerializer(new Jackson2JsonRedisSerializer<>(Object.class));
            // key采用String的序列化方式
            redisTemplate.setKeySerializer(new StringRedisSerializer());
            redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
            redisTemplate.setHashKeySerializer(new StringRedisSerializer());
            redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
            redisTemplate.setConnectionFactory(redisConnectionFactory);
            return template;
        }
    
    }

### 4、工具类同上 ###

### 5、使用postman调接口测试Redis集群 ###

@Slf4j
    @RestController
    public class TestController {
    
        @Resource
        private RedisUtil redisUtil;
    
        @GetMapping("/set")
        public String set(){
            redisUtil.set("key1", "value");
            return "success";
        }
    
        @GetMapping("/get")
        public String get(){
            Object result = redisUtil.get("key1");
            return result.toString();
        }
    
    }