SpringBoot整合Redis

  • 使用场景:不经常修改的数据固定的数据经常查询的数据
  • 作用功能:提高查询速度
  • Spring Cache + Redis缓存数据
    • Spring Cache是一个非常优秀的缓存组件,自Spring3.1起,提供了类似于@Transactional注解事务的注解Cache抽象,方便切换各种底层Cahce,如redis
    • Spring Cahce优点
      • 提供基本的Cache抽象,方便切换各种底层Cache
      • 通过注解Cache可以实现类似于事务一样,缓存逻辑透明的应用到业务代码上,且只需要更少的代码即可完成
      • 提供事务回滚时也自动回滚缓存
      • 支持比较复杂的缓存逻辑
  • 准备工作(在项目中一般是要写到公共服务中)
    • 导入依赖包
      <!-- redis -->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-redis</artifactId>
      </dependency>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-cache</artifactId>
      </dependency>
      
      <!-- spring2.X集成redis所需common-pool2 -->
      <dependency>
          <groupId>org.apache.commons</groupId>
          <artifactId>commons-pool2</artifactId>
          <version>2.6.0</version>
      </dependency>
      
    • 在配置文件中配置Redis
      # Redis配置
      spring.redis.host=127.0.0.1
      spring.redis.port=6379
      spring.redis.database=0
      spring.redis.timeout=1800000
      
      spring.redis.lettuce.pool.max-active=20
      spring.redis.lettuce.pool.max-wait=-1
      # 最大阻塞等待时间(负数表示没限制)
      spring.redis.lettuce.pool.max-idle=5
      spring.redis.lettuce.pool.min-idle=0
      
    • 创建redis缓存配置类,配置插件(较为固定)
      package com.xsha.servicebase;
      
      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.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;
      
      @Configuration
      @EnableCaching
      public class RedisConfig {
      
          /**
           * 自定义key规则
           * @return KeyGenerator
           */
          @Bean
          public KeyGenerator keyGenerator() {
              return new KeyGenerator() {
                  @Override
                  public Object generate(Object o, Method method, Object... objects) {
                      StringBuilder sb = new StringBuilder();
                      sb.append(o.getClass().getName());
                      sb.append(method.getName());
                      for (Object obj: objects) {
                          sb.append(obj.toString());
                      }
                      return sb.toString();
                  }
              };
          }
      
          /**
           * 设置RedisTemplate规则
           * @param redisConnectionFactory 连接工厂
           * @return RedisTemplate
           */
          @Bean
          public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
              RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();
              redisTemplate.setConnectionFactory(redisConnectionFactory);
              Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
      
              // 解决查询缓存转换差异的问题
              ObjectMapper om = new ObjectMapper();
              // 指定要序列化的域,field、set和get以及修饰符的范围,ANY是都有包括private和public
              om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
              // 指定序列化输入的类型,类必须是非final修饰的类,比如String、Integer等会抛出异常
              om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
              jackson2JsonRedisSerializer.setObjectMapper(om);
      
              // 序列号key value
              redisTemplate.setKeySerializer(new StringRedisSerializer());
              redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
              redisTemplate.setHashKeySerializer(new StringRedisSerializer());
              redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
      
              redisTemplate.afterPropertiesSet();
              return redisTemplate;
          }
      
          /**
           * 设置CacheManager缓存规则
           * @param redisConnectionFactory 连接工厂
           * @return CacheManager
           */
          @Bean
          public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
              RedisSerializer<String> redisSerializer = new StringRedisSerializer();
              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);
      
              // 配置序列化(解决乱码问题),过期时间600秒
              RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                      .entryTtl(Duration.ofSeconds(600))
                      .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                      .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                      .disableCachingNullValues();
      
              RedisCacheManager cacheManager = RedisCacheManager.builder(redisConnectionFactory)
                      .cacheDefaults(config)
                      .build();
              return cacheManager;
          }
      }
      
      
    • 因为首页接口对应获取的首页数据变化不大,但访问量较大,所以就有必要将首页接口数据缓存到redis缓存中,减少数据库压力和提高访问速度
    • Spring Boot缓存注解
      • 缓存@Cacheable(一般用在查询的方法上)
        • 根据方法对其返回结果进行缓存,下次请求时,如果缓存存在,则直接读取缓存数据;如果不存在,则执行方法,并把返回的结果存入缓存中
        • 属性及其描述
          • value:缓存名称,必填,指定缓存存放在哪块命名空间
          • cacheNames:与value差不多,二选一即可
          • key:可选属性,可以使用SpEL标签自定义缓存的key
          • keyGenerator: 可以使用配置类中配置的keyGenerator组件,如@Cacheable(value="abc", keyGenerator="keyGenerator"),这样redis中缓存的键名称为abc::类的全路径名称+方法名+参数名
      • 缓存@CachePut(一般用在新增的方法上)
        • 使用该注解标志的方法,每次都会执行,并将结果存入指定的缓存中。其他方法可以直接从响应的缓存中读取缓存数据,而不需要再去查询数据库
        • 属性及其描述
          • value:缓存名称,必填,指定缓存存放在哪块命名空间
          • cacheNames:与value差不多,二选一即可
          • key:可选属性,可以使用SpEL标签自定义缓存的key
      • 缓存@CacheEvict(一般用在更新或者删除的方法上)
        • 使用该注解标志的方法,会清空指定的缓存
        • 属性及其描述
          • value:缓存名称,必填,指定缓存存放在哪块命名空间
          • cacheNames:与value差不多,二选一即可
          • key:可选属性,可以使用SpEL标签自定义缓存的key
          • allEntries:是否清空所有缓存,默认为false,如果指定为true,则方法调用后将立即清空所有的缓存
          • beforeInvocation:是否在方法执行前就清空,默认为false,如果指定为true,则在方法执行前就会清空缓存
      • 注意事项: 属性key的值需要再价格单引号,不然会报错。如@Cacheable(key="'keyName'", value="valueName")
posted @ 2022-03-02 07:59  xsha_h  阅读(203)  评论(0编辑  收藏  举报