SpringBoot集成Redis使用Cache缓存的实现方法

 更新时间:2024年10月12日 10:25:21   作者:秋意钟  
SpringBoot通过配置RedisConfig类和使用Cache注解可以轻松集成Redis实现缓存,主要包括@EnableCaching开启缓存,自定义key生成器,改变序列化规则,以及配置RedisCacheManager,本文为使用SpringBoot与Redis处理缓存提供了详实的指导和示例,感兴趣的朋友一起看看吧

使用SpringBoot集成Redis使用Cache缓存只要配置相应的配置类,然后使用Cache注解就能实现

RedisConfig配置

新建RedisConfig配置类

package com.bdqn.redis.config;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import java.lang.reflect.Method;
import java.time.Duration;
/**
 * @author cuishujian
 * @date 2024/9/25
 */
@Configuration
@EnableCaching// 开启缓存
public class RedisConfig extends CachingConfigurerSupport {
    /**
     * 自定义生成 key的规则
     * 缓存对象集合中,缓存是以 key-value 形式保存的
     * 当不指定缓存的 key时,SpringBoot会使用 SimpleKeyGenerator 生成 key
     * @return
     */
    @Bean
    public KeyGenerator keyGenerator(){
        return new KeyGenerator(){
            public Object generate(Object target, Method method, Object... params){
                // 格式化缓存key字符串
                StringBuilder sb = new StringBuilder();
                // 追加类名
                sb.append(target.getClass().getName());
                // 追加方法名
                sb.append(method.getName());
                // 遍历参数并且追加
                for (Object obj : params) {
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }
    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory){
        RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        // 解决查询缓存转换异常的问题
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        // 使用Jackson2JsonRedisSerialize 替换默认序列化
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(om, Object.class);
        // 设置value的序列化对象和key的序列化对象
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }
    /**
     * 采用RedisCacheManager作为缓存管理器
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory factory){
        // 创建Redis序列化对象
        RedisSerializer<String> redisSerializer = new StringRedisSerializer();
        // 解决查询缓存转换异常的问题
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        // 创建Jackson的序列化对象
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(om, Object.class);
        // 配置序列化(解决乱码问题)
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                // 7天缓存过期
                .entryTtl(Duration.ofDays(7))
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                .disableCachingNullValues();
        RedisCacheManager cacheManager = RedisCacheManager.builder(factory)
                .cacheDefaults(config)
                .build();
        return cacheManager;
    }
}

以上代码说明如下:

@EnableCaching:使用此注解开启缓存

keyGenerator():使用此方法自定义key生成规则

redisTemplate():使用此方法改变默认的序列化规则,将数据序列化为json格式。当我们引入了spring-boot-starter-data-reids时,RedisAutoConfiguration自动配置类帮我们注入了RedisTemplate<Object,Object>和StringRedisTemplate两个组件来操作redis,其中RedisTemplate<Object,Object>的键值都是对象,StringRedisTemplate用来操作字符串的。RedisTemplate使用的是JdkSerializationRedisSerializer,存入数据会将数据先序列化成字节数据然后再存入Redis,如果希望将数据序列化为json格式,则要改变默认的序列化规则

cacheManager():使用此方法自定义RedisCacheManager改变默认的序列化规则,将数据序列化为json格式

Cache注解

@Cacheable

  • 作用:主要针对方法配置,能够根据方法的请求参数对其结果进行缓存。在查询时,会先从缓存中取数据,若不存在才再发起对数据库的访问。
  • 参数:
    • value/cacheNames:指定缓存存储的集合名。
    • key:缓存对象存储在Map集合中的key值,非必需,缺省按照函数的所有参数组合作为key值,若自己配置需使用SpEL表达式。
    • condition:缓存对象的条件,非必需,也需使用SpEL表达式,只有满足表达式条件的内容才会被缓存。
    • unless:另一个缓存条件参数,非必需,也需使用SpEL表达式,但判断时机在函数被调用之后,所以它可以通过对result进行判断。
    • keyGenerator:用于指定key生成器,非必需。
    • cacheManager:用于指定使用哪个缓存管理器,非必需。
    • cacheResolver:用于指定使用哪个缓存解析器,非必需。
  • 示例:@Cacheable(value = "user", key = "#id"),表示使用id作为key,将方法的返回结果缓存到名为“user”的缓存中。

@CachePut

  • 作用:主要针对方法配置,能够根据方法的请求参数对其结果进行缓存,并且每次都会触发真实方法的调用(与@Cacheable不同)。主要用于数据新增和修改操作上。
  • 参数:与@Cacheable类似。
  • 示例:@CachePut(value = "user", key = "#user.id"),表示以user.id作为key,将方法的返回结果更新到名为“user”的缓存中。

@CacheEvict

  • 作用:主要针对方法配置,能够根据一定的条件对缓存进行清空。通常用在删除方法上。
  • 参数:
    • value/cacheNames:指定缓存存储的集合名。
    • key:指定清除数据的key值。
    • allEntries:非必需,默认为false。若设置为true,则清除缓存组件下的所有数据。
    • beforeInvocation:非必需,默认为false。若设置为true,则在方法执行前清除缓存,否则在方法执行后清除。
  • 示例:@CacheEvict(value = "user", key = "#id"),表示从名为“user”的缓存中移除key为id的数

到此这篇关于SpringBoot集成Redis使用Cache缓存的文章就介绍到这了,更多相关SpringBoot使用Cache缓存内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java基础异常处理代码及原理解析

    Java基础异常处理代码及原理解析

    这篇文章主要介绍了java基础异常处理代码及原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • java File类的基本使用方法总结

    java File类的基本使用方法总结

    这篇文章主要介绍了java File类的基本使用方法总结,为大家分享了java实现上传代码,感兴趣的小伙伴们可以参考一下
    2016-04-04
  • spring文件下载的四种方式及对比分析

    spring文件下载的四种方式及对比分析

    本文对比spring文件下载的四种方式,每种方式结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2025-08-08
  • Java通过Socket实现简单多人聊天室

    Java通过Socket实现简单多人聊天室

    这篇文章主要为大家详细介绍了Java通过Socket实现简单多人聊天室,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04
  • Java缺失区间的查找方法

    Java缺失区间的查找方法

    在 Java 的算法世界里,有许多有趣又具有挑战性的问题等待我们去探索,今天,跟着小编一起来深入研究缺失区间的查找秘籍,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2025-02-02
  • Java中的functor实现

    Java中的functor实现

    Java中的functor实现...
    2006-12-12
  • 详解Java 连接MongoDB集群的几种方式

    详解Java 连接MongoDB集群的几种方式

    这篇文章主要介绍了详解Java 连接MongoDB集群的几种方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • MyBatis基本实现过程

    MyBatis基本实现过程

    这篇文章主要介绍了Spring整合mybatis实现过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2021-07-07
  • Java中的并发工具类详细解析

    Java中的并发工具类详细解析

    这篇文章主要介绍了Java中的并发工具类详细解析,CountDownLatch、 CyclicBarrier 和 Semaphore 工具类提供了一种并发流程控制的手段,Exchanger 工具类则提供了在线程间交换数据的一种手段,需要的朋友可以参考下
    2023-12-12
  • SpringBoot中@PathVariable、@RequestParam和@RequestBody的区别和使用详解

    SpringBoot中@PathVariable、@RequestParam和@RequestBody的区别和使用详解

    这篇文章主要介绍了SpringBoot中@PathVariable、@RequestParam和@RequestBody的区别和使用详解,@PathVariable 映射 URL 绑定的占位符,通过@RequestMapping注解中的{}占位符来标识URL中的变量部分,需要的朋友可以参考下
    2024-01-01

最新评论