使用Spring自带的缓存注解维护数据一致性-平芜编程栈

简介

Cache（缓存），已经是项目中不可缺失的存在，登录时，存储用户信息、操作权限、Token 等，高并发场景，存储热点信息、实时信息等。按照类型分类，可分为本地缓存和分布式缓存，前者重启服务失效，后者可以持久化，按照设置的过期时间或策略失效。

一旦项目中需要使用到缓存，就需要考虑到数据一致性问题，即缓存数据与数据库数据的一致性问题，本文介绍在 Spring Boot 项目中，如何使用 Spring 自带的注解来进行数据一致性的维护。

整合

Spring 自带了缓存维护的注解，如果你的项目就是 Spring/Spring Boot 项目，不需要额外引入依赖

但如果你需要缓存不会因项目重启而失效，可以引入 Redis，把 Redis 当作缓存容器，需引入 Redis 依赖。基本所有的项目都会用到 Redis，当然引入了就需要保证系统与 Redis 的连通。

<!-- 引入 Redis --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency>

在项目中创建一个 Redis 缓存配置类，里面对缓存进行统一的配置，如过期时间等。

importorg.springframework.cache.annotation.EnableCaching;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.springframework.data.redis.cache.RedisCacheConfiguration;importorg.springframework.data.redis.cache.RedisCacheManager;importorg.springframework.data.redis.connection.RedisConnectionFactory;importorg.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;importorg.springframework.data.redis.serializer.RedisSerializationContext;importorg.springframework.data.redis.serializer.StringRedisSerializer;importjava.time.Duration;/** * Redis 缓存配置 */@Configuration@EnableCachingpublicclassRedisCacheConfig{@BeanpublicRedisCacheManagercacheManager(RedisConnectionFactoryconnectionFactory){RedisCacheConfigurationconfig=RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofMinutes(30)).serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(newStringRedisSerializer())).serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(newGenericJackson2JsonRedisSerializer()));returnRedisCacheManager.builder(connectionFactory).cacheDefaults(config).build();}}

配置文件中，添加 Redis 配置。

spring:redis:host:localhostport:6379

使用

配合下面几个注解使用，可以加在接口上，如下，cacheNames是设置缓存名称，key设置缓存的 key 值，可以用#与方法入参关联，如#id表示 key 值取自方法入参 id 的值。

@Cacheable(cacheNames = “缓存名”, key = “#id”)：添加缓存；
@CachePut(cacheNames = “缓存名”, key = “#id”)：执行方法后，添加缓存；
@CacheEvict(cacheNames = “缓存名”, key = “#id”)：使缓存失效；

需要注意的是，这套缓存作用的机制是，关联方法入参与返回，当方法入参相同时，返回缓存中的结果，不再执行代码。所以只有相同的入参才能用得上缓存。

验证

创建下面这四个接口，查询方法添加缓存，新增方法执行后添加缓存，删除和更新方法删除缓存。

importorg.example.service.CacheService;importorg.springframework.cache.annotation.CacheEvict;importorg.springframework.cache.annotation.CachePut;importorg.springframework.cache.annotation.Cacheable;importorg.springframework.web.bind.annotation.*;importjavax.annotation.Resource;@RestController@RequestMapping("/cache")publicclassCacheController{@ResourceprivateCacheServicecacheService;@GetMapping("/getOne")@Cacheable(cacheNames="cacheName",key="#id")publicStringgetOne(@RequestParamStringid){returncacheService.getOne();}@PostMapping("/createOne")@CachePut(cacheNames="cacheName",key="#id")publicStringcreateOne(@RequestParamStringid){returncacheService.createOne();}@PostMapping("/deleteOne")@CacheEvict(cacheNames="cacheName",key="#id")publicStringdeleteOne(@RequestParamStringid){returncacheService.deleteOne();}@PostMapping("/updateOne")@CacheEvict(cacheNames="cacheName",key="#id",allEntries=true)publicStringupdateOne(@RequestParamStringid){returncacheService.updateOne();}}

对应的实现类代码。

importorg.springframework.stereotype.Service;@ServicepublicclassCacheServiceImplimplementsCacheService{@OverridepublicStringgetOne(){return"Select is a cache data.";}@OverridepublicStringcreateOne(){return"Create is a cache data.";}@OverridepublicStringdeleteOne(){return"Deleted is a cache data.";}@OverridepublicStringupdateOne(){return"Updated is a cache data.";}}