Springboot整合SpringCache+redis简化缓存开发

使用步骤：

1.引入依赖

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

2.写配置，在配置文件配置使用redis作为缓存

spring.cache.type=redis
#指定缓存过期时间，单位毫秒
spring.redis.time-to-live=3600000

引入的上面依赖后CacheAutoConfiguration会导入RedisCacheConfiguration,自动配置RedisCacheManager;

3.在启动类添加下面的注解开启缓存功能：

@EnableCaching

完成以上配置后，就可以使用注解为简化redis缓存管理，下面是一些常用到的注解：

@Cacheable:触发将数据保存到缓存中；

@CacheEvict：触发将数据从缓存中删除；

@CachePut：使用不影响方法执行的方式更新缓存；

@Caching：组合以上多个操作；

@CacheConfig：在类级别共享缓存的相同配置。

4.在需要缓存中的方法上添加对应的注解

@Cacheable({"category"})
@Override
public List<CategoryEntity> getLevel1Categorys() {//此处省略具体业务逻辑
}

如果使用上面的方式声明缓存，SpringCache会有以下默认行为：

如果缓存中已存在该数据，方法不再执行，直接查询缓存返回；
key默认自动生成，生成的规则为缓存的名字：：SimpleKey[](自主生成的key值)，如下图
缓存的value值，默认使用jdk序列化机制，将序列化的数据存到redis;
默认ttl时间为-1,即永不过期。

如果要想自己定义一些规则，SpringCashe是支持的：
指定key名字，使用key属性，接受spEl表达式，spEl支持的表达式详见官方文档；

注意spEl表达式如果是普通字符串，一定要带单引才生效

普通字符串不带单引号，不生效：

@Cacheable(value = {"category"},key = "level1Categorys") ✘

普通字符串带单引号，生效：

@Cacheable(value = {"category"},key = "'level1Categorys'") ✔

指定缓存的存活时间ttl，在appliaction配置文件中配置，参见上文描述；

将数据保存为json格式，方便不同编程语言解析,如果想实现这一步，需添加自定义配置，参考如下代码：

@Configuration
@EnableCaching  //将启动类的开启注解移到这方便统一管理
public class MyCacheConfig {@Beanpublic RedisCacheConfiguration cacheConfiguration(){RedisCacheConfiguration config=RedisCacheConfiguration.defaultCacheConfig();config=config.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()));config=config.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()));return config;}
}

注意，如果开启了Spring Cache自定义缓存，那么Spring只会来读取自定义缓存的内容，对于自定义缓存中没有的内容，将会缺失。像上面代码只配置了key和value序列化规则，没有配置缓存过期时间，即使配置文件配置了，不会读取，为了避免这个问题，对上面的方法进行升级如下：

@Configuration
@EnableCaching
public class MyCacheConfig {@Beanpublic RedisCacheConfiguration cacheConfiguration(CacheProperties cacheProperties){RedisCacheConfiguration config=RedisCacheConfiguration.defaultCacheConfig();config=config.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()));config=config.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()));CacheProperties.Redis redisProperties= cacheProperties.getRedis();//如果配置文件配置了过期时间，则读取if(redisProperties.getTimeToLive()!=null){config=config.entryTtl(redisProperties.getTimeToLive());}if(redisProperties.getKeyPrefix()!=null){   //如果配置文件配置了key前缀，则读取config=config.prefixKeysWith(redisProperties.getKeyPrefix());}if(!redisProperties.isCacheNullValues()){// //如果配置文件配置了不缓存空值，则禁用空值缓存config=config.disableCachingNullValues();}if(!redisProperties.isUseKeyPrefix()){  //如果配置文件配置禁用禁用key，则禁用config=config.disableKeyPrefix();}return config;}
}

附SpringCashce 在application.yml中的完整配置：

#上面还有spring在最左侧cache:type: redisredis:#设置缓存过期时间，单位mstime-to-live: 3600000#开启缓存null值，可防止缓存穿透cache-null-values: true#开启key前缀 不推荐，建议设置成falseuse-key-prefix: true#定义key前缀，不推荐，建议使用缓存分区#key-prefix: CACHE_

如果想在修改数据时触发对缓存的删除，在方面上方添加@CacheEvict并批量缓存分区即可。

如果想在修改时对多个缓存进行批量操作，可以使用下面两种方法中任一种：

@Caching(evict = {@CacheEvict(value = {"category"},key = "'level1Categorys'"),@CacheEvict(value = {"category"},key = "'getCatelogJson'"),})

value为设置缓存时指定的分区的名字，key为设置缓存时定义的方法名

方法二：

    @CacheEvict(value = "category",allEntries = true)

value为设置缓存时指定的分区的名字，allEntries设置为true，当标注有上面注解的方法被调用，数据修改时，指定缓存分区categorys的缓存都会被删除，当有请求再次添加缓存时，缓存分区categorys的所有数据会再次添加到缓存中。附设置缓存的方法

    @Cacheable(value = {"category"},key = "'level1Categorys'")@Overridepublic List<CategoryEntity> getLevel1Categorys() {//此处省略方法具体实现，重点在缓存注解声明}@Cacheable(value = {"category"},key = "#root.methodName")@Overridepublic Map<String,  List<Catelog2Vo>> getCatelogJson() {//此处省略方法具体实现，重点在缓存注解声明}

PS：存储同一类型的数据，可放到到同一分区，即@Cacheable注解里value的值。如此在redis缓存分区就有层次分明的结构了，这在缓存多的情况下，非常有用，能快速找到相关缓存，方便统一管理。

@注意@CacheEvict采用的是缓存一致性里的失效模式，@CachePut属于双写模式。

SpringCache有其优越之处，但存在一定的不足。

如SpringCache默认是不加锁的，要想解决缓存击穿问题，在使用时只有@Cacheable注解可配置sync属性的值为true加锁，其他注解不支持配置加锁，示例：

    @Cacheable(value = {"category"},key = "'level1Categorys'",sync = true)@Overridepublic List<CategoryEntity> getLevel1Categorys() {}

因此，要结合具体业务情况来看是否采用。

SpringCache适用场景：常规数据（读多写少，即时性、一致性要求不高的数据）

而对于即时性和数据一致性要求高的场景需要进行特殊设计，如引入读写锁，引入canal。

Springboot整合SpringCache+redis简化缓存开发

最新新闻

热搜词