SpringBoot2.2+版本整合redis(template/cacheManager/过期监听)

最新推荐文章于 2025-04-16 19:57:49 发布
最新推荐文章于 2025-04-16 19:57:49 发布
阅读量881 收藏 3
点赞数
分类专栏： SpringBoot 文章标签： spring boot redis java 缓存
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_44775299/article/details/107030902
版权

一、说明

在SpringBoot项目开发过程中，我们经常会有用到缓存的需求，这时候整合使用Redis无疑是很好的选择。SpringBoot官方就有很多整合NoSQL的starter库，方便我们集成开发。值得一提的是，SpringBoot版本1.+和2.+关于配置Redis有比较大的区别，网络上的很多旧版的资料都已不适用于高版本的SpringBoot，因此本文记录了基于SpringBoot2.2.8Release版本的整合。

二、整合配置

（一）添加pom依赖

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

（二）新建Redis配置类

说明：

  1. redisTemplate：最基础的组件，重写它主要是为了自定义序列化策略
  2. cacheManager：SpringBoot缓存体系中的缓存管理器
  3. redisMessageListenerContainer：Redis消息监听器，能实现消息订阅、过期通知等

1. RedisConfiguration

@EnableCaching
@Configuration
public class RedisConfiguration {

	/** 默认的java8日期时间格式 */
    private static final String    DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    /** 默认的java8日期格式 */
    private static final String    DEFAULT_DATE_FORMAT      = "yyyy-MM-dd";
    /** 默认的java8时间格式 */
    private static final String    DEFAULT_TIME_FORMAT      = "HH:mm:ss";

	/**
     * Redis访问模板
     */
    @Bean
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
        template.setConnectionFactory(factory);
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        // key都采用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        template.setHashKeySerializer(stringRedisSerializer);
        // value的序列化方式采用jackson
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        // 解决查询缓存转换异常的问题
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.activateDefaultTyping(objectMapper.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.NON_FINAL);
        // 添加java8时间相关序列化/反序列化处理
        JavaTimeModule javaTimeModule = new JavaTimeModule();
        javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
        javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
        javaTimeModule.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
        javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
        javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
        javaTimeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
        objectMapper.registerModule(javaTimeModule);

        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        template.setValueSerializer(jackson2JsonRedisSerializer);
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();

        return template;
    }

	/**
     * 缓存管理器
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory, RedisTemplate redisTemplate) {

        // 配置默认过期时间和序列化机制
        RedisCacheConfiguration defaultCacheConfig = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofSeconds(60L))
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(redisTemplate.getValueSerializer()));

        // 自定义缓存空间应用不同配置，可以配置不同的过期时间
        Set<String> cacheNames =  new HashSet<>();
        Map<String, RedisCacheConfiguration> configMap = new HashMap<>(RedisCacheSpaceExpireConfig.EXPIRE_TIME_MAP.size());
        for (Map.Entry<String, Integer> entry : RedisCacheSpaceExpireConfig.EXPIRE_TIME_MAP.entrySet()) {
            String cacheName = entry.getKey();
            Integer expireMinute = entry.getValue();
            cacheNames.add(cacheName);
            configMap.put(cacheName, defaultCacheConfig.entryTtl(Duration.ofMinutes(expireMinute)));
        }

        return RedisCacheManager.builder(redisConnectionFactory)
                .cacheDefaults(defaultCacheConfig)
                .initialCacheNames(cacheNames)
                .withInitialCacheConfigurations(configMap)
                .build();

    }

    /**
     * 消息监听器
     */
    @Bean
    RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory connectionFactory) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        return container;
    }

}

2. RedisCacheSpaceExpireConfig（缓存空间过期时间配置类）

public class RedisCacheSpaceExpireConfig {

    public static final String MINUTE_1 = "MINUTE_1";
    public static final String MINUTE_3 = "MINUTE_3";
    public static final String MINUTE_5 = "MINUTE_5";
    public static final String MINUTE_15 = "MINUTE_10";
    public static final String MINUTE_30 = "MINUTE_30";

    public static final String HOUR_1 = "HOUR_1";
    public static final String HOUR_2 = "HOUR_2";
    public static final String HOUR_6 = "HOUR_6";
    public static final String HOUR_12 = "HOUR_12";

    public static final String DAY_1 = "DAY_1";
    public static final String DAY_3 = "DAY_3";
    public static final String DAY_10 = "DAY_10";
    public static final String DAY_30 = "DAY_30";

    /**
     * 过期时间键值对 k-v : 名称-过期时间(分钟)
     */
    public static final HashMap<String, Integer> EXPIRE_TIME_MAP = new HashMap<String, Integer>(){
        {
            put(MINUTE_1, 1);
            put(MINUTE_3, 3);
            put(MINUTE_5, 5);
            put(MINUTE_15, 15);
            put(MINUTE_30, 30);

            put(HOUR_1, 60);
            put(HOUR_2, 2 * 60);
            put(HOUR_6, 6 * 60);
            put(HOUR_12, 12 * 60);

            put(DAY_1, 60 * 24);
            put(DAY_3, 60 * 24 * 3);
            put(DAY_10, 60 * 24 * 10);
            put(DAY_30, 60 * 24 * 30);

        }
    };

}

三、使用示范

（一）简单读写

@RestController
@RequestMapping("demo")
public class DemoController {
	
	@Resource
    private RedisTemplate redisTemplate;

	@PostMapping("/simple-string")
    public String testExpire(String message) {
        redisTemplate.opsForValue().set("demo", message);
        return "success";
    }

	@GetMapping("/simple-string")
    public String testExpire(String message) {
        redisTemplate.opsForValue().set("demo", message);
        return "success";
    }

}

（二）缓存

以Mybatis的Mapper方法为例：Member类为实力类，读者视自己情况修改。RedisCacheSpaceExpireConfig为前文配置缓存空间过期时间的配置类。
SpringBoot的缓存除了加载DAO层上，还能加载各种层的方法上，视业务情况使用即可。


    /**
     * 根据主键ID和商家号查找会员：联合主键进行缓存，缓存时长为5分钟
     *
     * @param id         主键
     * @param merchantId 商家号
     * @return 会员
     */
    @Cacheable(cacheNames = RedisCacheSpaceExpireConfig.MINUTE_5, key = "'member:'.concat(#merchantId).concat(#id)")
    Member selectByIdAndMerchantId(@Param("id") Long id, @Param("merchantId") Long merchantId);

	/**
     * 根据主键ID和商家号修改会员：删除联合主键缓存内容
     *
     * @param id         主键
     * @param merchantId 商家号
     * @return 会员
     */
    @CacheEvict(cacheNames = RedisCacheSpaceExpireConfig.MINUTE_5, key = "'member:'.concat(#merchantId).concat(#id)")
    void updateByIdAndMerchantId(@Param("id") Long id, @Param("merchantId") Long merchantId, @Param("member") Member member);

说明：关于SpringBoot的缓存，本文不拓展讲，感兴趣的读者可自行查阅相关资料。缓存注解中的key支持SPEL表达式：
在这里插入图片描述

（三）过期事件监听

@Component
public class RedisKeyExpirationListener extends KeyExpirationEventMessageListener {

    public RedisKeyExpirationListener(RedisMessageListenerContainer listenerContainer) {
        super(listenerContainer);
    }

    @Resource
    private RedisTemplate redisTemplate;
    
    /**
     * 针对redis数据失效事件，进行数据处理
     *
     * @param message redis数据的key值
     * @param pattern 
     */
    @Override
    public void onMessage(Message message, byte[] pattern) {
        String redisKey = message.toString();
		// 取出我们自定义的业务标识前缀，可以使用枚举类辅助
        String prefixStr = redisKey.substring(0, redisKey.indexOf(":"));
        if (StrUtil.isBlank(prefixStr)) {
            return;
        }
        // 以不同的锁Key作为redis锁，并设置过期时间3分钟，确保多节点并发时仅执行一次任务，且锁会自动释放
        if (redisTemplate.opsForValue().setIfAbsent("lock:" + redisKey, redisKey, 3, TimeUnit.MINUTES)) {
            // 业务信息：可以是表ID、数据编码等
            String businessKey = redisKey.substring(prefixStr.length() + 1);
            switch (prefixStr) {
                case "order":
                	System.out.println("处理订单，订单号：" + businessKey );
                    break;
                case "stock":
                    System.out.println("处理库存，仓库号：" + businessKey );
                    break;
                default:
                    break;
            }
            // 释放redis锁
            redisTemplate.delete(redisKey);
        }
    }
}
Spring Boot基础学习笔记19：自定义RedisTemplate与RedisCacheManager
howard2005的专栏
03-19 1237
文章目录零、学习目标一、为什么要采用自定义Redis缓存序列化机制二、自定义RedisTemplate（一）Redis API 默认序列化机制（二）自定义RedisTemplate序列化机制（三）创建Spring Boot项目 - RedisTemplateDemo（四）创建评论实体类 - Comment（五）创建评论仓库接口 - CommentRepository（六）创建评论服务类 - CommentService（七）创建评论控制器 - CommentController（八）配置应用属性文件 - a
Redis教程(十一)：Redis的发布订阅和事件监听功能
十三月的博客
02-27 805
Redis的发布/订阅（Pub/Sub）功能是一种消息传递模式，用于实现消息发布者（publisher）和订阅者（subscriber）之间的消息通信。在这种模式下，消息的发送者（发布者）将消息发送到特定的频道（channel），而订阅了该频道的接收者（订阅者）将会接收到这些消息。发布者负责向指定的频道发布消息。发布者将消息发送到指定的频道后，所有订阅了该频道的订阅者都会接收到这些消息。频道是消息的传输通道，它用于将消息从发布者传递给订阅者。
SpringBoot2.x集成Redis (StringTemplate与redisTemplate的不同用法)
LarsCheng's Blog
08-13 9523
1.Redis介绍 Redis数据库是一个完全开源免费的高性能Key-Value数据库。它支持存储的value类型有五种，包括string(字符串)、list(链表)、set(集合)、zset(sorted set –有序集合)和hash（哈希类型） Redis非常快，每秒可执行大约110000次的设置(SET)操作，每秒大约可执行81000次的读取/获取(GET)操作。 2.开发工具...
Redis实现分布式锁
最新发布
一位Java开发工程师
04-16 636
Redis 锁是一种机制，用于在分布式环境中协调多个客户端对共享资源的访问。通过使用 Redis 实现分布式锁，可以确保在同一时间只有一个客户端能够访问或修改特定的资源，从而避免竞争条件和数据不一致的问题。Redis 锁通常基于 Redis 的一些特性实现，如键过期、原子操作等。
SpringBoot配置RedisTemplate和RedisCacheManager
眼前一座山，踏平它
11-28 1万+
import com.dxy.cache.pojo.Dept; import com.fasterxml.jackson.annotation.JsonAutoDetect; import com.fasterxml.jackson.annotation.PropertyAccessor; import com.fasterxml.jackson.databind.ObjectMapper; i...
自定义RedisTemplate和RedisCacheManager
weixin_43631820的博客
06-14 2184
默认的RedisTemplate和RedisCacheManager的使用JDK的序列化方式，可以自定义为string和json序列化 @Configuration public class MyRedisConfig { @Bean public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws Unknow
【spring】自定义二级Cache
morris
04-28 911
Spring Cache是Spring-context包中提供的基于注解方式使用的缓存组件，定义了一些标准接口，通过实现这些接口，就可以通过在方法上增加注解来实现缓存。这样就能够避免缓存代码与业务处理耦合在一起的问题。 Spring Cache核心的接口就两个：Cache和CacheManager。 Cache接口：该接口定义提供缓存的具体操作，比如缓存的放入、读取、清理： CacheManager接口：主要提供Cache实现bean的创建，每个应用里可以通过cacheName来对Cache进行隔离，每个
Springboot（四十六）SpringBoot3整合redis并配置哨兵模式
camellia的博客
11-29 1883
但是呢，Springboot3中部署redis的配置和Springboot2中的配置完全不同。上次我的redis是在centos服务器上直接安装的，这次在Springboot3的配置中，我的redis使用docker来部署。安装redis就不需要使用dockerfile了，太麻烦了。我这里的配置比较简单，能用的上的就是这些。其余的配置如果需要请自行添加。我这里再来记录一下Springboot3中配置redis的全部代码。到这里，你的redis其实就可以使用了。有好的建议，请在下方输入你的评论。
springboot,redis,caffeine二级缓存搭建
zhuasheng
12-07 670
准备工作 1，springboot项目搭建 2，redis 集成 redis maven依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> redis相关配置 spring: redis:
SpringBoot + Redis 以及在工具类里注入 Service（Redis）
LinzhiQQQ的博客
12-02 4013
现在的场景是需要做 token 验证，那么用户退出登录之后，我们给他设置一个新的 token，然后当用户拿着已经注销了的token再进行访问验证时，到 Redis 里查看对比两个token是否一致，如果不一致说明token已过期 所以现在我们需要在 验证 token 的 Class 里面使用 RedisService 从数据库里拿出 token 做对比 由于工具类是 静态的方法，并且也不是 c...
SpringBoot整合Redis消息队列
热门推荐
浅汐
06-28 7万+
消息模型 1）队列模型 队列模型如图所示，它具有以下几个特点，就像我们用微信和好友（群聊除外）聊天一样，微信就是这个队列，我们可以和很多个好友聊天，但是每条消息只能发给一个好友。 只有一个消费者将获得消息 生产者不需要在接收者消费该消息期间处于运行状态，接收者也同样不需要在消息发送时处于运行状态。 每一个成功处理的消息都由接收者签收 2）发布/订阅模型 发布/订阅模型如图所示，不用说，和订阅公众号是一样的。 多个消费者可以获得消息 在发布者和订阅者之间存在时间依赖性。发布者需要建立一个t
springboot自定义RedisTemplate与RedisCacheManager
小城我家
07-09 1693
RedisTemplate看下源码 @Override public void afterPropertiesSet() { super.afterPropertiesSet(); boolean defaultUsed = false; //判断默认序列化是否为空 if (defaultSerializer == null) { //为空就走JDK的序列化方式 defaultSerializer = new JdkSerializationRedisSerializer(
spring boot 集成 redis简单使用 以及 RedisTemplate 简单使用
qq_39564710的博客
02-05 961
一、Redis介绍 Redis的特点： 1，Redis读取的速度是110000次/s，写的速度是81000次/s； 2，原子。Redis的所有操作都是原子性的，同时Redis还支持对几个操作全并后的原子性执行。 3，支持多种数据结构：string（字符串）；list（列表）；hash（哈希），set（集合）；zset(有序集合) 4，持久化，集群部署 5，支持过期时间，支持事务，消息订阅 二、项目集成Redis 1、在common模块添加依赖 由于redis缓存是公共应...
springboot2.0以上版本 使用 Jedis 和 Template 两种方式连接redis
追风筝的人博客
03-29 2168
首先我们要知道，Springboot整合Redis有两种方式，分别是Jedis和RedisTemplate，这两者有何区别？ Jedis是Redis官方推荐的面向Java的操作Redis的客户端，而RedisTemplate是SpringDataRedis中对JedisApi的高度封装。其实在Springboot的官网上我们也能看到，官方现在推荐的是SpringDataRedis形式，相对于Je...
Springboot 自定义缓存配置 CacheManager 及redis集成
Ricardo.M.Yu的博客
04-26 4848
现有项目中经常遇到的缓存集成问题，Springboot提供了统一的接口抽象与缓存管理器，可集成多种缓存类型，如 ConcurrentMap 缓存、redis缓存，并可以随时无缝替换底层缓存存储。
【四】Spring Boot之 Spring Boot + Cache + RedisTemplate整合
Sid小杰的博客
10-16 2542
项目目录 pom.xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="...
为什么要重写RedisTemplate
listeningdu的博客
12-14 358
这样更切合业务并且代码操作更加简单，SpringBoot官方的设置也是当你手动注入一个RedisTemplate的Bean时，优先使用你手动注入的RedisTemplate。由此种方式序列化的key在存入Redis数据库时会被转为16进制同时具有类型前缀，这样想要拿取此key对应的value还要先算出此key的值，所以不采用该种。原文链接：https://blog.csdn.net/yjrguxing/article/details/112056548。所以我们一般重写一个。
springboot为什么需要重新编写redis的redistemplate模板
qq_26463745的博客
04-04 1023
1、springboot中自动集成了redistemplate两种实例化方式（及存储方式） 1、redistemplate<object,object> 2、redistemplate<string,string> 2、提供的两种方法并不好用，比方说我需要存储一个字符串指向对象的数据，如使用第一种，存储的方式则为jdk实例化，不太好懂，数据也看不清楚。如使用第二种的话，我需...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值