[Java知识库]Spring Boot 整合 Redis

准备工作（在项目中一般是要写到公共服务中）

• 导入依赖包

  <!-- redis -->
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-redis</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.CachingConfigurerSupport;
  import org.springframework.cache.annotation.EnableCaching;
  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.time.Duration;
  
  /** 
  * 说明：redis配置类 
  * 作者：FH Admin 
  * from：fhadmin.cn 
  */@Configuration
  @EnableCaching
  public class RedisConfig extends CachingConfigurerSupport {
  
      @Bean
      public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
          RedisTemplate<String, Object> template = new RedisTemplate<>();
          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);
          template.setConnectionFactory(factory);
          //key序列化方式
          template.setKeySerializer(redisSerializer);
          //value序列化
          template.setValueSerializer(jackson2JsonRedisSerializer);
          //value hashmap序列化
          template.setHashValueSerializer(jackson2JsonRedisSerializer);
          return template;
      }
  
      @Bean
      public CacheManager cacheManager(RedisConnectionFactory factory) {
          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(factory)
                  .cacheDefaults(config)
                  .build();
          return cacheManager;
      }
  }
  
  

• 因为首页接口对应获取的首页数据变化不大，但访问量较大，所以就有必要将首页接口数据缓存到redis缓存中，减少数据库压力和提高访问速度
• Spring Boot缓存注解
  • 缓存@Cacheable（一般用在查询的方法上）
    • 根据方法对其返回结果进行缓存，下次请求时，如果缓存存在，则直接读取缓存数据；如果不存在，则执行方法，并把返回的结果存入缓存中
    • 属性及其描述
      • value：缓存名称，必填，指定缓存存放在哪块命名空间
      • cacheNames：与value差不多，二选一即可
      • key：可选属性，可以使用SpEL标签自定义缓存的key
  • 缓存@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")