spring cache 如果是单应用直接使用本地缓存就可以,如果是分布式系统,就需要使用分布式缓存,否则请求会直接访问数据库。下面使用redis 做为spring cache的缓存容器。 版本为2.1.4
新建一个spring boot 项目
pom.xml如下依赖
代码语言:javascript复制<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
application.properties
代码语言:javascript复制server.port=8082
#redis config
spring.redis.host=localhost
spring.redis.port=6379
spring.redis.password=
DemoApplication启动类头部加入@EnableCaching开启缓存 redis.config配置
代码语言:javascript复制@Configuration
public class RedisConfig{
@Bean
public RedisTemplate<String, Serializable> customRedisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Serializable> template = new RedisTemplate<String, Serializable>();
template.setConnectionFactory(factory);
template.setKeySerializer(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.setValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
return template;
}
@Bean
public RedisCacheManager cacheManager(RedisConnectionFactory factory,RedisTemplate customRedisTemplate){
//可以配置缓存过期时间,是否缓存null值,配置前缀,配置数据转换器
RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(customRedisTemplate.getValueSerializer()));
RedisCacheManager cacheManager = RedisCacheManager.builder(RedisCacheWriter.lockingRedisCacheWriter(factory))
.cacheDefaults(config)
.build();
return cacheManager;
}
}
写一个测试服务
代码语言:javascript复制@Service
@CacheConfig(cacheNames = "person")
public class UserService {
private Person person = null;
@Cacheable(key = "#id")
public Person getUserById(Long id){
//如果没走缓存,会打印下面这句话
System.out.println("=>操作数据库,根据id获取用户信息");
return this.person;
}
@CachePut(key = "#person.id")
public Person savePerson(Person person){
System.out.println("=>操作数据库保存用户数据");
this.person = person;
return this.person;
}
@CacheEvict(key = "#id")
public void delPerson(Long id){
System.out.println("=>操作数据库删除用户数据");
person = null;
}
}
测试用例
代码语言:javascript复制@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
@Autowired
private UserService userService;
@Test
public void testRedisCache(){
Person person = new Person(1L,"陈大侠","18","男");
System.out.println("插入用户,新增缓存");
userService.savePerson(person);
System.out.println("第一次获取用户,存在缓存就从缓存返回,不存在就从数据库取");
Person dbPerson = userService.getUserById(1L);
System.out.println(dbPerson);
System.out.println("更新用户,更新缓存");
person.setAge("88");
userService.savePerson(person);
System.out.println("第二次获取用户,看缓存是否有变化");
dbPerson = userService.getUserById(1L);
System.out.println(dbPerson);
System.out.println("删除用户,删除缓存");
//userService.delPerson(1L);
System.out.println("第三次再次获取用户,看缓存是否有变化");
dbPerson = userService.getUserById(1L);
System.out.println(dbPerson);
}
}
这里我注释了删除操作,为的是不删除缓存,先跑一下
可以看到redis已经有了缓存,现在把删除操作注释去掉,把redis的缓存删除
代码语言:javascript复制插入用户,新增缓存
=>操作数据库保存用户数据
第一次获取用户,存在缓存就从缓存返回,不存在就从数据库取
Person{id=1, name='陈大侠', age='18', sex='男'}
更新用户,更新缓存
=>操作数据库保存用户数据
第二次获取用户,看缓存是否有变化
Person{id=1, name='陈大侠', age='88', sex='男'}
删除用户,删除缓存
=>操作数据库删除用户数据
第三次再次获取用户,看缓存是否有变化
=>操作数据库,根据id获取用户信息
null
1.可以看到第一次获取用户没有打印"操作数据库"日志,数据是从缓存中获取的 2.更新后,再次获取用户,用户信息已经变化了,说明缓存也被更新 3.删除操作,会让缓存失效,可以看到控制台打印了 “操作数据库”的日志,但用户信息为null 自此redis缓存已经可以用了,回过来看缓存注解
spring cache 注解详解
@CacheConfig
:主要用于配置该类中会用到的一些共用的缓存配置。在这里@CacheConfig(cacheNames = “person”):配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中,我们也可以不使用该注解,直接通过@Cacheable自己配置缓存集的名字来定义。
@Cacheable
:配置了getUserById函数的返回值将被加入缓存。同时在查询时,会先从缓存中获取,若不存在才再发起对数据库的访问。该注解主要有下面几个参数:
value、cacheNames:两个等同的参数(cacheNames为Spring 4新增,作为value的别名),用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig,因此在Spring 3中原本必须有的value属性,也成为非必需项了
key:缓存对象存储在Map集合中的key值,非必需,缺省按照函数的所有参数组合作为key值,若自己配置需使用SpEL表达式,比如:@Cacheable(key = “#p0”):使用函数第一个参数作为缓存的key值,更多关于SpEL表达式的详细内容可参考官方文档
condition:缓存对象的条件,非必需,也需使用SpEL表达式,只有满足表达式条件的内容才会被缓存,比如:@Cacheable(key = “#p0”, condition = “#p0.length() < 3”),表示只有当第一个参数的长度小于3的时候才会被缓存,若做此配置上面的AAA用户就不会被缓存,读者可自行实验尝试。
unless:另外一个缓存条件参数,非必需,需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机,该条件是在函数被调用之后才做判断的,所以它可以通过对result进行判断。
keyGenerator:用于指定key生成器,非必需。若需要指定一个自定义的key生成器,我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口,并使用该参数来指定。需要注意的是:该参数与key是互斥的
cacheManager:用于指定使用哪个缓存管理器,非必需。只有当有多个时才需要使用
cacheResolver:用于指定使用那个缓存解析器,非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器,并用该参数指定。
除了这里用到的两个注解之外,还有下面几个核心注解:
@CachePut
:配置于函数上,能够根据参数定义条件来进行缓存,它与@Cacheable不同的是,它每次都会真是调用函数,所以主要用于数据新增和修改操作上。它的参数与@Cacheable类似,具体功能可参考上面对@Cacheable参数的解析
@CacheEvict
:配置于函数上,通常用在删除方法上,用来从缓存中移除相应数据。除了同@Cacheable一样的参数之外,它还有下面两个参数:
allEntries:非必需,默认为false。当为true时,会移除所有数据
beforeInvocation:非必需,默认为false,会在调用方法之后移除数据。当为true时,会在调用方法之前移除数据。
总结
Spring Cache 相比于在代码中直接使用Redis操作缓存更方便一些,毕竟它已经给你实现了缓存操作逻辑,并且提供注解,在一些缓存使用频繁场景,比如商品信息,还是非常方便的。 同时由于它跟Spring有关联,造成了一定的复杂性和不直观。 由于Spring Cache通过AOP来实现,那就需要增强代理,如果注解用在内部方法上,必然是不会生效的 这里有一篇文章,是别人写的,Spring Cache注解不生效的问题,并且详细说明了原因:为什么私有方法上的Spring Cache注解不生效?