使用步骤:
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支持的表达式详见官方文档;
指定缓存的存活时间ttl,在appliaction配置文件中配置,参见上文描述;
将数据保存为json格式,方便不同编程语言解析,如果想实现这一步,需添加自定义配置,参考如下代码:
@Configuration
@EnableCaching //将启动类的开启注解移到这方便统一管理
public class MyCacheConfig {
@Bean
public 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 {
@Bean
public 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: redis
redis:
#设置缓存过期时间,单位ms
time-to-live: 3600000
#开启缓存null值,可防止缓存穿透
cache-null-values: true
#开启key前缀
use-key-prefix: true
#定义key前缀
key-prefix: CACHE_