spring boot整合redis

最新推荐文章于 2024-05-13 17:37:41 发布

GeminiXin.

最新推荐文章于 2024-05-13 17:37:41 发布

阅读量282

点赞数 2

分类专栏： redis 文章标签： redis

本文链接：https://blog.csdn.net/weixin_44890938/article/details/119719583

版权

redis 专栏收录该内容

15 篇文章 1 订阅

订阅专栏

1.新建一个spring boot项目，导入redis的依赖

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

在springboot 2.x后，原来使用的 Jedis 被 lettuce 替换；
- jedis：采用的直连，多个线程操作的话，是不安全的。如果要避免不安全，使用jedis pool连接池！类似BIO模式
- lettuce：采用netty，实例可以在多个线程中共享，不存在线程不安全的情况！可以减少线程数据了，类似NIO模式
分析
```
@ConditionalOnClass        //	当给定的类名在类路径上存在，则实例化当前Bean
```
1.JedisConnectionConfiguration类中@ConditionalOnClass注解中有两个类是默认不存在的，所以Jedis是无法生效的；

2.LettuceConnectionConfiguration类中@ConditionalOnClass的类已经生效；

在这里插入图片描述

spring boot自动配置

# springboot 所有的配置类都会有一个自动配置类 RedisAutoConfiguration
# 自动配置类都会绑定一个 properties 配置文件 RedisProperties
# org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
# org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,\
# org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\

在这里插入图片描述

RedisAutoConfiguration类中只有两个简单的bean，分别是RedisTemplate和StringRedisTemplate，当看到xxTemplate时可以对比RestTemplat、SqlSessionTemplate,通过使用这些Template来间接操作组件。那么这俩也不会例外。分别用于操作Redis和Redis中的String数据类型。

	@Bean
	@ConditionalOnMissingBean(name = "redisTemplate")
	@ConditionalOnSingleCandidate(RedisConnectionFactory.class)
	public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
		RedisTemplate<Object, Object> template = new RedisTemplate<>();
		template.setConnectionFactory(redisConnectionFactory);
		return template;
	}

	@Bean
	@ConditionalOnMissingBean
	@ConditionalOnSingleCandidate(RedisConnectionFactory.class)
	public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
		StringRedisTemplate template = new StringRedisTemplate();
		template.setConnectionFactory(redisConnectionFactory);
		return template;
	}

@ConditionalOnBean         //	当给定的在bean存在时,则实例化当前Bean
@ConditionalOnMissingBean  //	当给定的在bean不存在时,则实例化当前Bean
@ConditionalOnClass        //	当给定的类名在类路径上存在，则实例化当前Bean
@ConditionalOnMissingClass //	当给定的类名在类路径上不存在，则实例化当前Bean

在RedisTemplate上也有一个 @ConditionalOnMissingBean(name = "redisTemplate")注解，说明我们是可以对其进行定制化的;

RedisProperties 是 redis的配置类绑定的配置文件；

@ConfigurationProperties(
    prefix = "spring.redis"
)
public class RedisProperties {
# Redis数据库索引（默认为0）
spring.redis.database=0  
# Redis服务器地址
spring.redis.host=192.168.x.x
# Redis服务器连接端口
spring.redis.port=6379  
# Redis服务器连接密码（默认为空）
spring.redis.password=  
# 连接池最大连接数（使用负值表示没有限制）
spring.redis.pool.max-active=8  
# 连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.pool.max-wait=-1  
# 连接池中的最大空闲连接
spring.redis.pool.max-idle=8  
# 连接池中的最小空闲连接
spring.redis.pool.min-idle=0  
# 连接超时时间（毫秒）
spring.redis.timeout=0  
}

2.使用RedisTemplate

在测试类中注入 RedisTemplate ，操作 redis ；

在这里插入图片描述

@SpringBootTest
class SpringbootRedisApplicationTests {

    @Autowired
    RedisTemplate redisTemplate;

    /**
     * Redis常见的五大数据类型
     *  String（字符串）、List（列表）、Set（集合）、Hash（散列）、ZSet（有序集合）
     *  stringRedisTemplate.opsForValue()[String（字符串）]
     *  stringRedisTemplate.opsForList()[List（列表）]
     *  stringRedisTemplate.opsForSet()[Set（集合）]
     *  stringRedisTemplate.opsForHash()[Hash（散列）]
     *  stringRedisTemplate.opsForZSet()[ZSet（有序集合）]
     */
    @Test
    void contextLoads() {
        redisTemplate.opsForValue().set("keyTest","valueTest");
        System.out.println(redisTemplate.opsForValue().get("keyTest"));
    }

}

3.序列化

当在redis服务器上查看数据时，会发现redisTemplate.opsForValue().set("keyTest","valueTest")是乱码，可是程序中可以正常输出，这时候就关系到存储对象的序列化问题，在网络中传输的对象也是一样需要序列化，否者就全是乱码。

在这里插入图片描述

默认的RedisTemplate序列化器是采用JDK序列化器

在这里插入图片描述

我们可以定制RedisTemplate就可以对其进行修改
- 直接调用RedisSerializer的静态方法来返回序列化器，然后set
- 自定义new相应的实现类，然后set
定制RedisTemplate的模板

@Configuration
public class RedisConfig {

    @Bean
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
        template.setConnectionFactory(factory);
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        // key采用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        // hash的key也采用String的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        // value序列化方式采用jackson
        template.setValueSerializer(jackson2JsonRedisSerializer);
        // hash的value序列化方式采用jackson
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }
}

测试

在这里插入图片描述

自定义Redis工具类

package com.ceair.openapi.portal.common.util;
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.HashOperations;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
 * @ClassName RedisUtil
 * @Description redis工具类
 * @Author lijiacheng
 * @Date 2020/2/25 15:22
 * @Version V1.0
 */
@Slf4j
@Component
public final class RedisUtil {
    @Autowired
    private RedisTemplate<String, Object> redisTemplate;
    @Autowired
	private StringRedisTemplate stringRedisTemplate;
    /**
     * 指定缓存失效时间
     * @param key  键
     * @param time 时间(秒)
     * @return boolean
     */
    public boolean expire(String key, long time) {
        try {
            if (time > 0) {
                redisTemplate.expire(key, time, TimeUnit.SECONDS);
            }
            return true;
        } catch (Exception e) {
            log.error("异常信息：",e);
            return false;
        } finally {
        }
    }
    /**
     * 根据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) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }
    }
    /**
     * 删除缓存
     * @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(CollectionUtils.arrayToList(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) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }
    }
    /**
     * 普通缓存放入并设置时间
     *
     * @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) {
            log.error("异常信息：",e);
            return false;
        } finally {
        }
    }
    /**
     * 普通缓存放入并设置时间
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒) time要大于0 如果time小于等于0 将设置无限期
     * @return true成功 false 失败
     */
    public boolean set(String key, String value, long time) {
    	try {
    		redisTemplate.opsForValue().set(key, value);
    		if (time > 0) {
    			expire(key, time);
    		} 
    		return true;
    	} catch (Exception e) {
    		log.error("异常信息：",e);
    		return false;
    	} finally {

        }
    }
    /**
     * 递增
     *
     * @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);
    }
    /**
     * HashGet
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return 值
     */
    public Object hget(String key, String item) {
        return redisTemplate.execute((RedisCallback<Object>) connection -> {
            RedisSerializer<String> serializer = redisTemplate.getStringSerializer();
            byte[] value = connection.hGet(serializer.serialize(key), serializer.serialize(item));
            if (value==null)  return null;
            return serializer.deserialize(value);
            //return SerializationUtil.deserialize(value);
        });
    }
    /**
     * 获取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, String> map) {

        try {

        	stringRedisTemplate.opsForHash().putAll(key, map);
            return true;

        } catch (Exception e) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }

    }


    /**
     * 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) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }

    }


    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */

    public boolean hset(String key, String item, Object value) {
        return redisTemplate.execute((RedisCallback<Boolean>) connection -> {
            RedisSerializer<String> serializer = redisTemplate.getStringSerializer();
            boolean result = connection.hSet(serializer.serialize(key), serializer.serialize(item),serializer.serialize(String.valueOf(value)));
            return result;
        });
//        try {
//
//        	stringRedisTemplate.opsForHash().put(key, item, value);
//
//            return true;
//
//        } catch (Exception e) {
//            log.error("异常信息：",e);
//            return false;
//        } finally {
//
//        }

    }

    /**
     * 功能描述：获取hash表中某个字段的值
     *
     * @param id
     * @param key
     * @return
     */
    public <T> T getHashFieldToObject(String id, String key, Class<T> clazz) {
        String string = getHashField(id, key);
        return JSONObject.parseObject(string, clazz);
    }

    /**
     * 功能描述：获取hash表中某个字段的值
     *
     * @param id
     * @param key
     * @return ss
     */
    public String getHashField(String id, String key) {
        HashOperations<String, String, String> opt = stringRedisTemplate.opsForHash();
        return opt.get(id, key);
    }

    /**
     * 获取hash表所有的值
     * @param id
     * @param clazz
     * @return
     */
    public <T> List<T> getHashAll(String id, Class<T> clazz) {
        HashOperations<String, String, String> opt = stringRedisTemplate.opsForHash();
        List<String> values = opt.values(id);
        List<T> list = new ArrayList<>();
        for (String str : values) {
            T t = JSONObject.parseObject(str, clazz);
            list.add(t);
        }
        return list;
    }


    /**
     * HashGet  获取所有key
     * @return 值
     */

    public Set<Object> hkeys(String key) {

        return redisTemplate.opsForHash().keys(key);

    }
    /**
     * 删除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);

    }




    /**
     * 根据key获取Set中的所有值
     *
     * @param key 键
     * @return
     */

    public Set<Object> sGet(String key) {

        try {

            return redisTemplate.opsForSet().members(key);

        } catch (Exception e) {

            log.error("异常信息：",e);

            return null;

        } finally {

        }

    }


    /**
     * 根据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) {

            log.error("异常信息：",e);

            return false;

        } finally {

        }

    }


    /**
     * 将数据放入set缓存
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 成功个数
     */

    public long sSet(String key, Object... values) {

        try {

            return redisTemplate.opsForSet().add(key, values);

        } catch (Exception e) {

            log.error("异常信息：",e);

            return 0;

        } finally {

        }

    }


    /**
     * 将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) {

            log.error("异常信息：",e);

            return 0;

        } finally {

        }

    }


    /**
     * 获取set缓存的长度
     *
     * @param key 键
     * @return
     */

    public long sGetSetSize(String key) {

        try {

            return redisTemplate.opsForSet().size(key);

        } catch (Exception e) {

            log.error("异常信息：",e);

            return 0;

        } finally {

        }

    }


    /**
     * 移除值为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) {

            log.error("异常信息：",e);

            return 0;

        } finally {

        }

    }




    /**
     * 获取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) {

            log.error("异常信息：",e);

            return null;

        } finally {

        }

    }


    /**
     * 获取list缓存的长度
     *
     * @param key 键
     * @return
     */

    public long lGetListSize(String key) {

        try {

            return redisTemplate.opsForList().size(key);

        } catch (Exception e) {

            log.error("异常信息：",e);

            return 0;

        } finally {

        }

    }


    /**
     * 通过索引 获取list中的值
     *
     * @param key   键
     * @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
     * @return Object
     */

    public Object lGetIndex(String key, long index) {

        try {

            return redisTemplate.opsForList().index(key, index);

        } catch (Exception e) {

            log.error("异常信息：",e);

            return null;

        } finally {

        }

    }


    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
//     * @param time  时间(秒)
     * @return
     */
    public boolean lSet(String key, Object value) {

        try {

            redisTemplate.opsForList().rightPush(key, value);

            return true;

        } catch (Exception e) {

            log.error("异常信息：",e);

            return false;

        } finally {

        }

    }


    /**
     * 将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) {

            log.error("异常信息：",e);

            return false;

        } finally {

        }

    }
    
    public boolean lpush(String key, String value) {
        try {
            redisTemplate.opsForList().leftPush(key, value);
            return true;
        } catch (Exception e) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }
    }
    
    public String rpop(String key) {
    	String result = "";
    	try {
    		result = (String) redisTemplate.opsForList().rightPop(key, 0, TimeUnit.SECONDS);
    		return result;
    	} catch (Exception e) {
    		log.error("异常信息：",e);
    		return result;
    	} finally {

        }
    }
    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
//     * @param time  时间(秒)
     * @return
     */
    public boolean lSet(String key, List<Object> value) {

        try {

            redisTemplate.opsForList().rightPushAll(key, value);

            return true;

        } catch (Exception e) {

            log.error("异常信息：",e);

            return false;

        } finally {

        }

    }


    /**
     * 将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) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }
    }

    /**
     * 根据索引修改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) {
            log.error("异常信息：",e);
            return false;
        } finally {

        }
    }

    /**
     * 移除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) {
            log.error("异常信息：",e);
            return 0;
        } finally {

        }
    }

}

GeminiXin.

关注

2
点赞
踩
1

收藏

觉得还不错? 一键收藏
2
评论
spring boot整合redis

1.新建一个spring boot项目，导入redis的依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> <version>2.5.3</version>
复制链接

扫一扫