Spring Boot项目@Cacheable注解的使用

server/2025/2/25 5:04:56/

@Cacheable 是 Spring 框架中用于缓存的注解之一，它可以帮助你轻松地将方法的结果缓存起来，从而提高应用的性能。下面详细介绍如何使用 @Cacheable 注解以及相关的配置和注意事项。

1. 基本用法

1.1 添加依赖

首先，确保你的项目中包含了 Spring Cache 的依赖。如果你使用的是 Spring Boot，可以在 pom.xml 或 build.gradle 中添加以下依赖：

Maven:

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

Gradle:

implementation 'org.springframework.boot:spring-boot-starter-cache'
1.2 启用缓存

在你的 Spring Boot 应用的主类或配置类上添加 @EnableCaching 注解，以启用缓存功能。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;@SpringBootApplication
@EnableCaching
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
1.3 使用 @Cacheable 注解

假设你有一个服务类 DataService，其中有一个方法 getSortedData 需要缓存其结果。你可以使用 @Cacheable 注解来实现这一点。

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;@Service
public class DataService {@Cacheable("sortedData")public TableDataInfo getSortedData(String param) {// 模拟耗时操作try {Thread.sleep(2000);} catch (InterruptedException e) {Thread.currentThread().interrupt();}// 返回模拟数据return new TableDataInfo();}
}

解释:

  • @Cacheable("sortedData"): 这个注解告诉 Spring 在调用 getSortedData 方法时，先检查名为 sortedData 的缓存中是否存在与参数 param 对应的结果。
    • 如果存在，则直接返回缓存中的结果，不再执行方法体。
    • 如果不存在，则执行方法体，将结果存入缓存中，并返回结果。
1.4 自定义缓存键

默认情况下，Spring 使用方法参数作为缓存键。如果你需要自定义缓存键，可以使用 key 属性。

@Cacheable(value = "sortedData", key = "#param")
public TableDataInfo getSortedData(String param) {// 方法体
}

解释:

  • key = "#param": 使用方法参数 param 作为缓存键。

你还可以使用 SpEL（Spring Expression Language）来构建更复杂的缓存键。

@Cacheable(value = "sortedData", key = "#param + '_' + #anotherParam")
public TableDataInfo getSortedData(String param, String anotherParam) {// 方法体
}

2. 配置缓存管理器

Spring 支持多种缓存实现，如 Caffeine、Ehcache、Redis 等。下面分别介绍如何配置这些缓存管理器。

2.1 使用 Caffeine 作为缓存实现

  1. 添加依赖:

    <dependency><groupId>com.github.ben-manes.caffeine</groupId><artifactId>caffeine</artifactId>
</dependency>

  2. 配置 Caffeine:

    你可以在 application.yml 或 application.properties 中配置 Caffeine 的缓存参数。

    application.yml:

    spring:cache:type: caffeinecaffeine:spec: maximumSize=1000,expireAfterAccess=60s

    application.properties:

    spring.cache.type=caffeine
spring.cache.caffeine.spec=maximumSize=1000,expireAfterAccess=60s
    • maximumSize=1000: 设置缓存的最大条目数为 1000。
    • expireAfterAccess=60s: 设置缓存条目在最后一次访问后的过期时间为 60 秒。
2.2 使用 Ehcache 作为缓存实现

  1. 添加依赖:

    <dependency><groupId>org.ehcache</groupId><artifactId>ehcache</artifactId>
</dependency>

  2. 配置 Ehcache:

    创建一个 ehcache.xml 文件，并在其中定义缓存配置。

    ehcache.xml:

    <config xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'xmlns='http://www.ehcache.org/v3'xsi:schemaLocation="http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core.xsd"><cache alias="sortedData"><key-type>java.lang.String</key-type><value-type>com.ruoyi.common.core.page.TableDataInfo</value-type><resources><heap unit="entries">1000</heap><offheap unit="MB">100</offheap></resources></cache>
</config>
    • <heap unit="entries">1000</heap>: 设置堆内存中缓存的最大条目数为 1000。
    • <offheap unit="MB">100</offheap>: 设置堆外内存中缓存的最大大小为 100MB。

  3. 配置 Spring 使用 Ehcache:

    在 application.yml 或 application.properties 中指定 Ehcache 配置文件的位置。

    application.yml:

    spring:cache:type: ehcacheehcache:config: classpath:ehcache.xml

    application.properties:

    spring.cache.type=ehcache
spring.cache.ehcache.config=classpath:ehcache.xml
2.3 使用 Redis 作为缓存实现

  1. 添加依赖:

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

  2. 配置 Redis:

    在 application.yml 或 application.properties 中配置 Redis 连接信息。

    application.yml:

    spring:cache:type: redisredis:host: localhostport: 6379

    application.properties:

    spring.cache.type=redis
spring.redis.host=localhost
spring.redis.port=6379

  3. 可选配置:

    你可以进一步配置 Redis 的缓存行为，例如设置最大内存大小和淘汰策略。

    application.yml:

    spring:redis:lettuce:pool:max-active: 20max-idle: 10min-idle: 5timeout: 5000ms

3. 其他相关注解

除了 @Cacheable，Spring 还提供了其他几个注解来管理缓存：

3.1 @CachePut

@CachePut 注解用于更新缓存中的值，但不会影响方法的执行。每次调用带有 @CachePut 注解的方法时，都会执行方法体并将结果存入缓存。

@CachePut(value = "sortedData", key = "#param")
public TableDataInfo updateSortedData(String param) {// 更新逻辑return new TableDataInfo();
}
3.2 @CacheEvict

@CacheEvict 注解用于从缓存中移除一个或多个条目。适用于需要清除缓存的情况。

@CacheEvict(value = "sortedData", key = "#param")
public void deleteSortedData(String param) {// 删除逻辑
}// 清除整个缓存
@CacheEvict(value = "sortedData", allEntries = true)
public void clearAllSortedData() {// 清除所有缓存
}
3.3 @Caching

@Caching 注解允许你在同一个方法上组合多个缓存操作。

@Caching(put = {@CachePut(value = "sortedData", key = "#param"),@CachePut(value = "anotherCache", key = "#param")},evict = {@CacheEvict(value = "oldCache", key = "#param")}
)
public TableDataInfo updateAndEvict(String param) {// 更新逻辑return new TableDataInfo();
}

4. 示例代码

下面是一个完整的示例，展示了如何使用 @Cacheable 注解以及配置 Caffeine 缓存。

4.1 项目结构
src
├── main
│   ├── java
│   │   └── com
│   │       └── example
│   │           ├── Application.java
│   │           ├── config
│   │           │   └── CacheConfig.java
│   │           ├── service
│   │           │   └── DataService.java
│   │           └── model
│   │               └── TableDataInfo.java
│   └── resources
│       └── application.yml
java_303">4.2 Application.java
package com.example;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;@SpringBootApplication
@EnableCaching
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
java_320">4.3 CacheConfig.java
package com.example.config;import com.github.benmanes.caffeine.cache.Caffeine;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.caffeine.CaffeineCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import java.util.concurrent.TimeUnit;@Configuration
@EnableCaching
public class CacheConfig {@Beanpublic CacheManager cacheManager() {CaffeineCacheManager cacheManager = new CaffeineCacheManager("sortedData");cacheManager.setCaffeine(caffeineCacheBuilder());return cacheManager;}Caffeine<Object, Object> caffeineCacheBuilder() {return Caffeine.newBuilder().expireAfterWrite(60, TimeUnit.SECONDS).maximumSize(1000);}
}
java_352">4.4 DataService.java
package com.example.service;import com.example.model.TableDataInfo;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;@Service
public class DataService {@Cacheable("sortedData")public TableDataInfo getSortedData(String param) {// 模拟耗时操作try {Thread.sleep(2000);} catch (InterruptedException e) {Thread.currentThread().interrupt();}// 返回模拟数据return new TableDataInfo();}
}
java_377">4.5 TableDataInfo.java
package com.example.model;public class TableDataInfo {// 模拟数据模型
}
4.6 application.yml
spring:cache:type: caffeine

5. 注意事项

  1. 缓存一致性:

    • 确保在更新数据时正确使用 @CachePut 和 @CacheEvict 注解，以保持缓存的一致性。
    • 对于分布式系统，考虑使用支持分布式缓存的实现（如 Redis）。

  2. 缓存失效策略:

    • 根据业务需求选择合适的缓存失效策略（如基于时间、基于条件等）。
    • 定期清理过期或不必要的缓存条目，以避免内存泄漏。

  3. 缓存击穿和穿透:

    • 缓存击穿: 当缓存失效后，大量请求同时涌入数据库，导致数据库压力骤增。
      • 解决方案: 可以使用互斥锁（如 Redis 分布式锁）来防止缓存击穿。
    • 缓存穿透: 当查询一个不存在的数据时，所有请求都直接打到数据库。
      • 解决方案: 可以在缓存中存储一个空对象或特殊标记，表示该数据不存在。

  4. 缓存雪崩:

    • 当大量缓存同时失效时，大量请求直接打到数据库，导致数据库压力骤增。
    • 解决方案: 可以设置不同的过期时间，避免缓存同时失效。

6. 调试和监控

为了更好地管理和调试缓存，可以使用以下工具和方法：

  • 日志记录: 在方法上添加日志记录，查看缓存的命中率和缓存操作的频率。
  • 监控工具: 使用监控工具（如 Prometheus、Grafana）来监控缓存的性能指标。
  • Spring Boot Actuator: 提供了缓存相关的端点，可以方便地查看缓存的状态和统计信息。

启用 Spring Boot Actuator:

  1. 添加依赖:

    <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

  2. 配置暴露端点:

    application.yml:

    management:endpoints:web:exposure:include: "caches"

  3. 访问缓存端点:

    访问 http://localhost:8080/actuator/caches 可以查看缓存的状态信息。

总结

通过使用 @Cacheable 注解，可以轻松地在 Spring 应用中实现缓存机制，从而提高应用的性能和响应速度。结合不同的缓存实现（如 Caffeine、Ehcache、Redis），你可以根据具体需求灵活配置缓存策略，确保缓存的有效性和高效性。


http://www.ppmy.cn/server/170479.html

相关文章

【AI】VS Code中使用GitHub Copilot

【AI】VS Code中使用GitHub Copilot

在VS Code中使用GitHub Copilot可以显著提升开发效率和代码质量&#xff0c;以下是其主要优势&#xff1a; 1. 代码自动补全 智能建议&#xff1a;Copilot能根据上下文提供代码补全建议&#xff0c;减少手动输入。 多语言支持&#xff1a;支持多种编程语言&#xff0c;适用于不…
阅读更多...
DeepSeek 助力 Vue 开发：打造丝滑的缩略图列表（Thumbnail List）

DeepSeek 助力 Vue 开发：打造丝滑的缩略图列表（Thumbnail List）

前言&#xff1a;哈喽&#xff0c;大家好&#xff0c;今天给大家分享一篇文章&#xff01;并提供具体代码帮助大家深入理解&#xff0c;彻底掌握&#xff01;创作不易&#xff0c;如果能帮助到大家或者给大家一些灵感和启发&#xff0c;欢迎收藏关注哦 &#x1f495; 目录 Deep…
阅读更多...
k8s的资源说明 cpu 内存 requests usage limits

k8s的资源说明 cpu 内存 requests usage limits

一、k8s资源配置 在 Kubernetes 中&#xff0c;有三个非常重要的资源概念&#xff0c;分别是资源请求&#xff08;Requests&#xff09;、资源使用率&#xff08;Usage&#xff09; 和 资源限制&#xff08;Limits&#xff09; 1、资源请求 Requests 资源请求 是 Pod 启动时…
阅读更多...
深度学习驱动下的字符识别：挑战与创新

深度学习驱动下的字符识别：挑战与创新

一、引言 1.1 研究背景 深度学习在字符识别领域具有至关重要的地位。随着信息技术的飞速发展&#xff0c;对字符识别的准确性和效率要求越来越高。字符识别作为计算机视觉领域的一个重要研究方向&#xff0c;其主要目的是将各种形式的字符转换成计算机可识别的文本信息。近年…
阅读更多...
YOLOv11-ultralytics-8.3.67部分代码阅读笔记-dataset.py

YOLOv11-ultralytics-8.3.67部分代码阅读笔记-dataset.py

dataset.py ultralytics\data\dataset.py 目录 dataset.py 1.所需的库和模块 2.class YOLODataset(BaseDataset): 3.class YOLOMultiModalDataset(YOLODataset): 4.class GroundingDataset(YOLODataset): 5.class YOLOConcatDataset(ConcatDataset): 6.class Sema…
阅读更多...
Rust并发编程实践：10分钟入门系统级编程

Rust并发编程实践：10分钟入门系统级编程

目录 学前一问&#xff1a;Rust为何而出现&#xff1f; 摘要 引言 正文解析&#xff1a; 一、Rust中的并发编程基础 1.1 线程 1.2 协程 二、Rust并发编程的高级特性 2.1 通道 2.2 原子操作 2.3 锁 三、实例展示&#xff1a;优化并发编程性能 1. 并行计算 2. 异步…
阅读更多...
CentOS创建软链接(符号链接)、硬链接和区别

CentOS创建软链接(符号链接)、硬链接和区别

一、创建软链接(符号链接) 查看ln --help: 命令&#xff1a; ln -s 源 链接名 例如在/data目录下有个zulu8.84.0.15-ca-jdk8.0.442-linux_x64.tar.gz文件&#xff0c;我们为它创建软链接 ln -s /data/zulu8.84.0.15-ca-jdk8.0.442-linux_x64.tar.gz /data/java8 删除软链…
阅读更多...
计算机网络-面试总结

计算机网络-面试总结

计算机网络 从输入一个URL到页面加载完成的过程 整体流程 DNS查询过程SSL四次握手HTTP 的长连接与短连接 HTTP 的 GET 和 POST 区别浏览器访问资源没有响应&#xff0c;怎么排查? OSI七层参考模型 TCP/IP四层参考模型比较 TCP/IP 参考模型与 OSI 参考模型 TCP三次握手&四…
阅读更多...
最新文章

Copyright @ 2022~2023