Spring缓存注解浅析及实践

最新推荐文章于 2025-06-19 06:00:00 发布
最新推荐文章于 2025-06-19 06:00:00 发布
阅读量877 收藏 15
点赞数 14
CC 4.0 BY-SA版权
文章标签： spring 缓存 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/2401_89221445/article/details/145115912

一 背景

缓存是我们日常开发常被使用的技术栈，一般用来降低数据库读取压力，提升系统查询性能。使用缓存的数据一般为不常变化且使用率很高的数据，比如：配置信息、商品信息、用户信息等。我们一般的做法：第一次从数据库中读取数据，然后放到缓存中并设置缓存超期时间，缓存超期之后再从数据库从新读取，如果涉及到更新和删除数据也要同步缓存，这样才能解决缓存数据一致性问题，但我们常规的做法一般是使用缓存的put、get等命令把写入和读取缓存的代码写在方法体内部，这样缓存相关的操作代码就会耦合在业务代码里。

能不能加个缓存注解就能把缓存的的问题给解决了呢？常规的做法是自己定义一个缓存注解，使用AOP的机制来实现缓存读写和同步，但实际上我们做这一步是多余的，因为Spring本身就提供了强大的缓存注解功能，我们何必再重复造轮子呢。下面将简单介绍下Spring的几个关键缓存注解及如何使用它们来实现缓存读写、更新和删除。

二 Spring几个关键缓存注解介绍

下面简单介绍几个Spring提供的核心缓存注解：@EnableCaching，@Cacheable，@CachePut，@CacheEvict ，如下：

注解名称简介
@EnableCaching该注解用来开启缓存功能，配置类中需要加上这个注解，Spring才知道你需要缓存功能，另外其他和缓存相关的注解才会生效，Spring缓存注解也是通过AOP实现的，通过AOP来拦截需要使用缓存的方法，实现缓存功能。
@Cacheable该注解用来赋予缓存功能，它可以标记在一个方法上，也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的，当标记在一个类上时则表示该类所有的方法都是支持缓存的。对于一个支持缓存的方法，Spring会在其被调用后将其返回值缓存起来，以保证下次利用同样的参数访问该方法可以直接从缓存中获取结果，而不需要再次执行该方法。@Cacheable可以指定三个属性：value、key和condition。 value： value和cacheNames属性作用一样，必须指定其中一个，表示当前方法的返回值是会被缓存在哪个Cache上的，对应Cache的名称。 key： 缓存以key->value的形式存储，key属性指定缓存内容对应的key，key属性支持SpEL表达式；当我们没有指定该属性时，Spring将使用默认策略生成key。 condition： 用来控制缓存的使用条件，condition属性默认为true，其值是通过SpEL表达式来指定的，当为true时表示先尝试从缓存中获取；若缓存中不存在则执行方法并将方法返回值存入缓存；当为false时不走缓存直接执行方法，并且返回结果也不会存入缓存。
@CachePut该注解用来将结果放入缓存，该注解的用法跟@Cacheable类似，区别如下： @CachePut：这个注释可以确保方法被执行，同时方法的返回值也被记录到缓存中。 @Cacheable：当重复使用相同参数调用方法的时候，方法本身不会被调用执行，即方法本身被略过了，取而代之的是方法的结果直接从缓存中找到并返回了。 所以，@CachePut一般被用于缓存的更新同步，确保缓存数据一致性。
@CacheEvict该注解用来清除缓存，如果标注在方法上则目标方法被调用时会清除指定的缓存，@CacheEvict一般用于数据删除时同时删除缓存，确保缓存数据一致性。

三 工程实践

3.1 引入依赖

要在springboot中使用缓存，重点要引入依赖：spring-boot-starter-data-redis

xml

代码解读

复制代码

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.example</groupId> <artifactId>spring-cache</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <name>spring-cache</name> <url>http://maven.apache.org</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <spring.boot.version>2.3.8.RELEASE</spring.boot.version> <slf4j-api.version>1.7.29</slf4j-api.version> <log4j-api.version>2.3</log4j-api.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> <version>${spring.boot.version}</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <version>${spring.boot.version}</version> <scope>test</scope> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j-api.version}</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>${log4j-api.version}</version> <scope>provided</scope> </dependency> </dependencies> </project>

3.2 核心代码

首先，要创建缓存配置类，配置类中需要定义一个bean：缓存管理器，类型为CacheManager；另外两个配置：cacheEnable为true开启缓存，false为关闭缓存，cacheTtl为统一的缓存超时时间。

kotlin

代码解读

复制代码

package com.java.demo.config; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.cache.CacheManager; import org.springframework.cache.annotation.EnableCaching; import org.springframework.cache.support.NoOpCacheManager; 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.StringRedisTemplate; import java.time.Duration; /** * redis缓存配置类 * * @author jiangzhaojing * @date 2024-11-29 15:01:12 */ @Configuration @EnableCaching public class RedisCacheConfig { @Value("${cache.enable:false}") private Boolean cacheEnable; @Value("${cache.ttl:120}") private Long cacheTtl; @Autowired private StringRedisTemplate redisTemplate; /** * 缓存管理bean注入 * * @param redisConnectionFactory * @return */ @Bean public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) { if (cacheEnable) { RedisCacheConfiguration config = instanceConfig(); return RedisCacheManager.builder(redisConnectionFactory) .cacheDefaults(config) .transactionAware() .build(); } return new NoOpCacheManager(); } /** * 实例配置 * * @return */ private RedisCacheConfiguration instanceConfig() { return RedisCacheConfiguration.defaultCacheConfig() .entryTtl(Duration.ofSeconds(cacheTtl)) .disableCachingNullValues(); } }

其次，创建测试需要实体类，需要注意是，该实体类必须实现Serializable，否则会出现序列化异常。

typescript

代码解读

复制代码

package com.java.demo.model; import java.io.Serializable; /** * 用户实体类 * * @author jiangzhaojing * @date 2024-11-29 15:01:12 * 用户相关属性 */ public class User implements Serializable { private String userId; private String userName; public User() { } public User(String userId, String userName) { this.userId = userId; this.userName = userName; } @Override public String toString() { return String.format("[userId:%s,userName:%s]", userId, userName); } public String getUserId() { return userId; } public void setUserId(String userId) { this.userId = userId; } public String getUserName() { return userName; } public void setUserName(String userName) { this.userName = userName; } }

然后，创建接口服务及实现类，并在实现类方法上增加缓存注解，如下：

java

代码解读

复制代码

package com.java.demo.service; import com.java.demo.model.User; /** * 用户相关服务 * * @author jiangzhaojing * @date 2024-11-29 15:01:12 */ public interface UserService { /** * 根据用户ID获取用户 * * @param userId * @return */ User getUserById(String userId); /** * 更新用户 * * @param user * @return */ User updateUser(User user); /** * 删除用户 * * @param userId */ void deleteUser(String userId); }

kotlin

代码解读

复制代码

package com.java.demo.service.impl; import com.java.demo.model.User; import com.java.demo.service.UserService; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.cache.annotation.CacheEvict; import org.springframework.cache.annotation.CachePut; import org.springframework.cache.annotation.Cacheable; import org.springframework.stereotype.Component; /** * 用户相关服务实现 * * @author jiangzhaojing * @date 2024-11-29 15:01:12 */ @Component public class UserServiceImpl implements UserService { private final static Logger logger = LoggerFactory.getLogger(UserServiceImpl.class); /** * 根据用户ID获取用户 * * @param userId * @return */ @Override @Cacheable(cacheNames = "users", key = "#userId") public User getUserById(String userId) { logger.info("调用了方法[getUserById],入参:{}", userId); //正常下面应该从数据库中读取 return new User("123", "li lei"); } /** * 更新用户 * * @param user * @return */ @Override @CachePut(cacheNames = "users", key = "#user.userId") public User updateUser(User user) { logger.info("调用了方法[updateUser],入参:{}", user); return user; } /** * 更新用户 * * @param userId * @return */ @Override @CacheEvict(cacheNames = "users", key = "#userId") public void deleteUser(String userId) { logger.info("调用了方法[deleteUser],入参:{}", userId); } }

然后，写一个应用的启动类

kotlin

代码解读

复制代码

package com.java.demo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.ComponentScan; @SpringBootApplication @ComponentScan("com.java.demo") public class Application { public static void main(String[] args) { SpringApplication.run(Application.class); } }

最后，配置文件配置缓存相关配置项，其中spring.redis.host，spring.redis.password，spring.redis.port三项根据实际配置填写

ini

代码解读

复制代码

spring.redis.host=//redis地址 spring.redis.database=0 spring.redis.port=//redis端口 spring.redis.password=//redis密码 spring.redis.timeout=5000 spring.redis.jedis.pool.max-idle=8 spring.redis.jedis.pool.min-idle=1 spring.redis.jedis.pool.max-active=8 spring.redis.jedis.pool.max-wait=3000 cache.enable=true cache.ttl=300

3.3 测试用例

java

代码解读

复制代码

package com.java.demo; import com.java.demo.model.User; import com.java.demo.service.UserService; import org.junit.Test; import org.junit.runner.RunWith; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; /** * 用户相关服务 * * @author jiangzhaojing * @date 2024-11-29 15:01:12 */ @RunWith(SpringRunner.class) @SpringBootTest public class CacheTest { private final static Logger logger = LoggerFactory.getLogger(CacheTest.class); @Autowired private UserService userService; @Test public void testCache() { //第一次读取缓存为空 logger.info("1.user:{}", userService.getUserById("123")); //第二次直接从缓存读取 logger.info("2.user:{}", userService.getUserById("123")); //更新缓存 userService.updateUser(new User("123", "zhang hua")); //第三次直接从缓存读取 logger.info("3.user:{}", userService.getUserById("123")); //删除缓存 userService.deleteUser("123"); logger.info("test finish!"); } }

第一次读取，缓存还没有则直接进入方法体并写入缓存，如下图：





第二次读取，因缓存存在则跳过方法直接从缓存中读取，从第三行日志可以看出来，如下：





更新数据时，使用@CachePut更新缓存，同步缓存数据：





删除数据时，及时使用 @CacheEvict清理缓存，确保缓存数据与数据库数据一致。

四 总结

从上面的解析和实践中可以看到使用Spring提供的@EnableCaching注解可以方便进行缓存的处理，避免缓存处理逻辑与业务代码耦合，让代码更优雅，从一定程度上提升了开发效率。但细心的同学会发现一个问题：@EnableCaching注解并未提供缓存超期的属性，所以我们无法通过@EnableCaching设置缓存超时时间，只能通过CacheManager设置一个统一的缓存超期时间。通过@EnableCaching源码我们也能发现并无缓存超期属性，如下：

java

代码解读

复制代码

package org.springframework.cache.annotation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import org.springframework.core.annotation.AliasFor; @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Inherited @Documented public @interface Cacheable { @AliasFor("cacheNames") String[] value() default {}; @AliasFor("value") String[] cacheNames() default {}; String key() default ""; String keyGenerator() default ""; String cacheManager() default ""; String cacheResolver() default ""; String condition() default ""; String unless() default ""; boolean sync() default false; }

至于Spring不提供这个属性原因，可能是基于框架的扩展性和通用性方面的考虑，不过Spring的强大之处就在于它是可以扩展的，预留了很多扩展点等待我们去实现，本文因篇幅有限不在本篇讨论如何扩展实现缓存超时时间的问题，留在后面的文章继续探讨。以上的分析讨论及代码难免有错误之处，敬请同学们指正！

Spring AI 实战：第六章、Spring AI源码浅析之一山可容二虎
liaokailin的专栏
05-04 1490
通过Debug看代码效率更高依赖ChatModel，而ChatModel由各个大模型的提供；通过手动定义多个 ChatClient 解决 NoUniqueBeanDefinitionException；Advisor 机制类似 AOP，可以在调用前后插入逻辑，可以自定义 Advisor 实现日志、缓存、限流等功能；chatModel.call()最终把请求转发到各个大模型的API调用规范实现上。看完代码以后期望你能自行读懂流式请求的操作（核心是Flux的操作，在第一章给出了示例）
Springboot整合redis实现缓存及其缓存运行原理浅析
qq_2309316384的博客
04-03 4294
声明:小白，学习阶段，主要目的是为了记录学习过程，本文仅供参考，如有不足的地方欢迎指出沟通交流 本文基于Springboot2.1.3版本开发: 准备阶段 首先是pom.xml文件所需的依赖: <dependencies> <!--redis依赖--> <dependency> <groupId&g...
Spring注解式缓存
m0_62019369的博客
11-14 1968
Redis是key-value存储的非关系型数据库。Spring Data Redis包含了多个模板实现，用来完成Redis数据库的数据存取功能spring注解式缓存中的巨坑~~~~~~~没有指定key，默认情况下spirng会使用SimpleKeyGenerator生成key，而Spring默认的SimpleKeyGenerator是不会将函数名组合进key中的，举个例子：@Component}}}}//注意返回的是字符串“4”}我们期望的输出是：123。
spring boot-----------------Spring缓存注解
java线程池
06-09 5090
Spring缓存注解   缓存大家应该不会陌生吧，像大家熟知的redis、memcached都是现在所流行的用与缓存数据的nosql，叫nosql的原因在于他们不是像我们jpa那样将数据存到磁盘中，他们主要是将数据存到内存中，然后我们访问数据的时候直接从内存加载出来，通过这样的方法来提高我们程序的运行效率。至于redis等他们具体如何运转的我就不一一介绍了.。   如果我们做web开发的话，那...
Spring缓存抽象：@Cache注解深度解析与最佳实践指南
最新发布
xiaoyu❅的博客
06-19 1030
if (param!= null) {} else {// 使用// ...缓存选择本地缓存：高性能、单机场景（Caffeine）分布式缓存：集群环境（Redis）键设计原则唯一性：不同参数产生不同键可读性：包含业务含义简洁性：避免过长键值失效策略TTL+随机抖动：防雪崩主动失效：数据变更时立即失效监控指标命中率：>80%为健康加载时间：<50ms内存使用：<70%最大限制重要提醒缓存不是万能的，不合理的使用反而会降低系统性能。始终基于性能测试和监控数据做决策。
Spring缓存注解
u013733643的博客
04-02 1302
一、简介  从3.1开始，Spring引入了对Cache的支持。其使用方法和原理都类似于Spring对事务管理的支持。Spring Cache是作用在方法上的，其核心思想是这样的：当我们在调用一个缓存方法时会把该方法参数和返回结果作为一个键值对存放在缓存中，等到下次利用同样的参数来调用该方法时将不再执行该方法，而是直接从缓存中获取结果进行返回。所以在使用Spring Cache的时候我们要保证我们缓存的方法对于相同的方法参数要有相同的返回结果。 使用Spring Cache需要我们做两方面的事： 1、声明某
@EnableCaching缓存
weixin_30273175的博客
07-18 1838
只有public方法，外部调用才有用，与异步相似 优化后 只有一个参数时，默认的key就参数，可以不写，比如这里写#id和不写key是一样的， 这里第二个如果不写，和其他两个指向就不是一回事了，现在三个方法指向相同，作用不同 转载于:https://www.cnblogs.com/dianzan/p/11209846....
spring缓存注解
weixin_44072515的博客
10-18 427
​ spring缓存是Spring框架中的功能,提供了应用程序中有效管理数据缓存的方式。缓存时一种将数据存储在内存中的技术，方便我们在后续访问相同数据时能更快的获取数据，而不必重新访问数据库或资源。​ Spring缓存的主要目标是提高应用程序的性能，减少对耗时资源的访问，并减少响应时间。它通过将数据存储在内存中的缓存中，以加快对数据的访问，从而提高了应用程序的响应速度。这在处理频繁访问的数据或计算昂贵的数据时特别有用。
浅析SpringCache缓存1
08-03
6. **JSR-107 支持**：从 Spring 4.1 开始，Spring Cache 添加了对 JSR-107（Java Caching API）标准的注解支持，使得开发者可以直接使用 JSR-107 提供的缓存注解，如 `@CacheResult`、`@CacheEvictAll` 等，增强了...
【后端】浅析缓存技术
wnm23的专栏
06-23 1523
缓存技术通过在高速存储介质中暂存数据副本，显著提升数据访问速度和系统响应性能。在人工智能领域，AI缓存技术特别突出。它利用先进的算法和模型预测用户需求，将数据预加载到内存中，以减少推断时间并提升AI模型的实时性能。另外，Alluxio作为一种开源的分布式存储系统，能够通过将数据在内存中进行存储和管理，为大数据处理提供高速访问能力，从而加速数据访问和分析过程。这些缓存技术不仅在数据管理和应用性能优化中发挥关键作用，也在提升系统效率和用户体验方面具有重要意义。
浅析基于Spring Security 的身份认证流程
Java技术攻略的博客
03-21 224
Spring Security 是一个专注于为 Java 应用程序提供身份认证和授权的框架。身份认证（authentication），即验证用户身份的合法性，以判断用户能否登录。授权（authentication），即验证用户是否有权限访问某些资源或者执行某些操作。本文将结合源码对身份认证（authentication）的流程和核心组件进行详细讲解。Spring Security 进行身份认证这一功能主要是通过一系列的过滤器链配合来实现的。
Spring提供的重要缓存注解
weixin_50074193的博客
05-18 1966
Spring提供的重要缓存注解 1、@Cacheable：针对方法配置，能够根据方法的请求参数对其结果进行缓存 @Cacheable 注解会先查询是否已经有缓存，有会使用缓存，没有则会执行方法并缓存方法 的返回值。 2、@CacheEvict：清空缓存 @CachEvict 的作用 主要针对方法配置，能够根据一定的条件对缓存进行清空 。 3、@CachePut：既调用方法，又更新缓存数据 @CachePut 注解的作用 主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和 @Cacheable 不同
Spring缓存注解--@Cacheable
热门推荐
llg___的博客
03-24 1万+
@Cacheable注解失效的原因。缓存以键值对的形式，key用来指定键，String类型。在方法或者类上加了@Cacheable注解，但是数据并未被缓存到Redis。即缓存解析器，该属性与cacheManager 是互斥的，只能指定一个。源码中这个属性是String数组类型，即可以指定多个缓存位置。其中，#参数名和其他字符串使用+号拼接出一个key的做法很常见。指定是否使用异步模式，默认false，即同步模式。，和condition是条件满足时缓存，二者相反。条件，指定符合什么条件的时候，才进行缓存。
Spring缓存注解使用
基地的博客
11-21 2710
Spring缓存注解使用 ​ 从3.1开始，Spring引入了对 Cache 的支持。 ​ Spring Cache 包含两个顶级接口，Cache（缓存）和 CacheManager（缓存管理器）。Cache 接口包含缓存的各种操作集合，Cache 接口下 Spring 提供了各种 xxxCache 的实现，比如：RedisCache、EhCache、ConcurrentMapCache。CacheManager 定义了创建、配置、获取、管理和控制多个唯一命名的 Cache，这些 Cache 存在于
掌握Spring缓存：@CachePut注解使用详解
在Spring框架中，缓存机制是一项重要的性能优化技术，它能够通过将方法的返回结果...在实际开发中，结合具体的业务场景和性能需求，灵活运用`@CachePut`及其他Spring缓存相关注解，可以使缓存的使用更加高效和安全。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值