springboot集成redis及其注解式开发

最新推荐文章于 2025-05-13 09:24:00 发布

Dawn.x

最新推荐文章于 2025-05-13 09:24:00 发布

阅读量438

点赞数

CC 4.0 BY-SA版权

文章标签： spring boot

本文链接：https://blog.csdn.net/qq_45510899/article/details/110491243

博客介绍了Spring Boot整合Redis的方法，包括导入pom依赖、进行yml配置、创建用于Redis数据缓存的RedisConfig类，还提及了两个缓存槽。此外，还涉及结合注解进行开发的内容。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot整合redis

导入pom依赖

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

yml配置

spring:
  redis:
      database: 0
      host: xxx
      port: 6379
      password: 123456
      jedis:
          pool:
              max-active: 100
              max-idle: 3
              max-wait: -1
              min-idle: 0
      timeout: 1000

创建RedisConfig
RedisConfig类用于Redis数据缓存

package com.xiaoyang.springbootmybatis.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.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.lang.reflect.Method;
import java.time.Duration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;


/**
 * redis配置类
 **/
@Configuration
@EnableCaching//开启注解式缓存
//继承CachingConfigurerSupport，为了自定义生成KEY的策略。可以不继承。
public class RedisConfig extends CachingConfigurerSupport {

    /**
     * 生成key的策略 根据类名+方法名+所有参数的值生成唯一的一个key
     *
     * @return
     */
    @Bean
    @Override
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object target, Method method, Object... params) {
                StringBuilder sb = new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(method.getName());
                for (Object obj : params) {
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }

    /**
     * 管理缓存
     *
     * @param redisConnectionFactory
     * @return
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        //通过Spring提供的RedisCacheConfiguration类，构造一个自己的redis配置类，从该配置类中可以设置一些初始化的缓存命名空间
        // 及对应的默认过期时间等属性，再利用RedisCacheManager中的builder.build()的方式生成cacheManager：
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();  // 生成一个默认配置，通过config对象即可对缓存进行自定义配置
        config = config.entryTtl(Duration.ofMinutes(1))     // 设置缓存的默认过期时间，也是使用Duration设置
                .disableCachingNullValues();     // 不缓存空值

        // 设置一个初始化的缓存空间set集合
        Set<String> cacheNames = new HashSet<>();
        cacheNames.add("my-redis-cache1");
        cacheNames.add("my-redis-cache2");

        // 对每个缓存空间应用不同的配置
        Map<String, RedisCacheConfiguration> configMap = new HashMap<>();
        configMap.put("my-redis-cache1", config);
        configMap.put("my-redis-cache2", config.entryTtl(Duration.ofSeconds(120)));

        RedisCacheManager cacheManager = RedisCacheManager.builder(redisConnectionFactory)     // 使用自定义的缓存配置初始化一个cacheManager
                .initialCacheNames(cacheNames)  // 注意这两句的调用顺序，一定要先调用该方法设置初始化的缓存名，再初始化相关的配置
                .withInitialCacheConfigurations(configMap)
                .build();
        return cacheManager;
    }

    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<Object, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);

        //使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值（默认使用JDK的序列化方式）
        Jackson2JsonRedisSerializer serializer = new Jackson2JsonRedisSerializer(Object.class);

        ObjectMapper mapper = new ObjectMapper();
        mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        serializer.setObjectMapper(mapper);

        template.setValueSerializer(serializer);
        //使用StringRedisSerializer来序列化和反序列化redis的key值
        template.setKeySerializer(new StringRedisSerializer());
        template.afterPropertiesSet();
        return template;
    }

    @Bean
    public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory factory) {
        StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
        stringRedisTemplate.setConnectionFactory(factory);
        return stringRedisTemplate;
    }

}


   @Configuration
  
  @Configuration底层是含有@Component ，所以@Configuration 具有和 @Component 的作用。
  @Configuration可理解为用spring的时候xml里面的<beans>标签。
  注： 
  1) 配置类必须以类的形式提供（不能是工厂方法返回的实例），允许通过生成子类在运行时增强（
  cglib 动态代理）。
  2) 配置类不能是 final 类（没法动态代理）。
  3) 配置注解通常为了通过 @Bean 注解生成 Spring 容器管理的类。
  4) 配置类必须是非本地的（即不能在方法中声明，不能是 private）。
  5) 任何嵌套配置类都必须声明为static。
  6) @Bean方法不能创建进一步的配置类（也就是返回的bean如果带有@Configuration，
  也不会被特殊处理，只会作为普通的 bean）。
   @EnableCaching
  1) @EnableCaching注解是spring framework中的注解驱动的缓存管理功能。
  自spring版本3.1起加入了该注解。
  2) 如果你使用了这个注解，那么你就不需要在XML文件中配置cache manager了。
  3) 当你在配置类(@Configuration)上使用@EnableCaching注解时，会触发一个post processor，
  这会扫描每一个spring bean，查看是否已经存在注解对应的缓存。如果找到了，
  就会自动创建一个代理拦截方法调用，使用缓存的bean执行处理。
  @Bean
  @Bean可理解为用spring的时候xml里面的<bean>标签。
  注： 
  1) @Bean注解在返回实例的方法上，如果未通过@Bean指定bean的名称，则默认与标注的方法名相同； 
  
  2) @Bean注解默认作用域为单例singleton作用域，可通过@Scope(“prototype”)设置为原型作用域；
  
  3) 既然@Bean的作用是注册bean对象，那么完全可以使用@Component、
  @Controller、@Service、@Repository等注解注册bean（在需要注册的类上加注解），
  当然需要配置@ComponentScan注解进行自动扫描。

名字my-redis-cache1和my-redis-cache2为两个缓存槽

结合注解开发

@Cacheable：作用是主要针对方法配置，能够根据方法的请求参数对其结果进行缓存 
主要参数说明： 
  1) value ： 
  缓存的名称，在 spring 配置文件中定义，必须指定至少一个，
  例如：@Cacheable(value=”mycache”) 或者 @Cacheable(value={”cache1”,”cache2”}。
  2) key ：缓存的 key，可以为空，
  如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合，
  例如：@Cacheable(value=”testcache”,key=”#userName”)。 
  3) condition ：缓存的条件，可以为空

@CachePut：作用是主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，
和 @Cacheable 不同的是，它每次都会触发真实查询
  方法的调用 
  主要参数说明：
  参数配置和@Cacheable一样。


@CacheEvict：作用是主要针对方法配置，能够根据一定的条件对缓存进行清空