Spring Boot项目@Cacheable注解的使用

@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: caffeine
    caffeine:
      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: ehcache
    ehcache:
      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: redis
  redis:
    host: localhost
    port: 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: 20
        max-idle: 10
        min-idle: 5
    timeout: 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
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);
    }
}
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 {

    @Bean
    public 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);
    }
}
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();
    }
}
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），你可以根据具体需求灵活配置缓存策略，确保缓存的有效性和高效性。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/978609.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Spring Cloud——路由网关Zuul

Spring Cloud——路由网关Zuul

??? 哈喽&#xff01;大家好&#xff0c;我是【一心同学】&#xff0c;一位上进心十足的【Java领域博主】&#xff01;??? 【一心同学】的写作风格&#xff1a;喜欢用【通俗易懂】的文笔去讲解每一个知识点&#xff0c;而不喜欢用【高大上】的官方陈述。 【一心同学】博客…
阅读更多...
WorldQuant Brain的专属语言——Fast Expression

WorldQuant Brain的专属语言——Fast Expression

使用brain需要的编程语言 在使用BRAIN平台时往往不需要事先有编码背景&#xff0c;因此小白也能很快对其上手&#xff0c;但有经验的程序员来讲&#xff0c;该平台暂时没有禁止API通信低强度进行时的程序化访问&#xff08;但是非常不好意思&#x1f623;怎么访问我没找到&…
阅读更多...
人大金仓KCA | 对象访问权限入门

人大金仓KCA | 对象访问权限入门

人大金仓KCA | 对象访问权限入门 一、知识预备1. 对象的分类2. 对象访问权限概述3. 级联授权4. 权限描述符5. 使用EasyKStudio查看用户权限 二、案例实施1. 用户授权综合案例2. 对象的创建者默认就是对象的所属主3. 该表对象的所属主4. 对象属主的权限设置5. 授权普通用户访问对…
阅读更多...
StrokesPlus【电脑鼠标键盘手势软件】v0.5.8.0 中文绿色便携版

StrokesPlus【电脑鼠标键盘手势软件】v0.5.8.0 中文绿色便携版

前言 StrokesPlus.net是一个超方便的手势识别软件&#xff0c;它能帮你用手势来代替鼠标和键盘操作。用起来既简单又灵活&#xff0c;功能还特别强大。 操作起来非常简单&#xff0c;它有好多实用的功能&#xff0c;比如智能识别你写的字、设定手势操作的区域、模拟鼠标的各种…
阅读更多...
springBoot统一响应类型3.1版本

springBoot统一响应类型3.1版本

前言&#xff1a; 通过实践而发现真理&#xff0c;又通过实践而证实真理和发展真理。从感性认识而能动地发展到理性认识&#xff0c;又从理性认识而能动地指导革命实践&#xff0c;改造主观世界和客观世界。实践、认识、再实践、再认识&#xff0c;这种形式&#xff0c;循环往…
阅读更多...
DDD 架构之领域驱动设计【通俗易懂】

DDD 架构之领域驱动设计【通俗易懂】

文章目录 1. 前言2. MVC 对比 DDD3. DDD 分层架构4. 完整业务流程 1. 前言 官方回答&#xff1a;DDD是一种应对复杂业务系统的设计方法&#xff0c;通过将软件设计与业务领域紧密结合&#xff0c;帮助开发人员构建清晰、可维护的领域模型。在复杂的业务系统中&#xff0c;它能…
阅读更多...
LeetCode 889.根据前序和后序遍历构造二叉树

LeetCode 889.根据前序和后序遍历构造二叉树

题目&#xff1a; 给定两个整数数组&#xff0c;preorder 和 postorder &#xff0c;其中 preorder 是一个具有 无重复 值的二叉树的前序遍历&#xff0c;postorder 是同一棵树的后序遍历&#xff0c;重构并返回二叉树。 如果存在多个答案&#xff0c;您可以返回其中 任何 一…
阅读更多...
SSM共享充电宝系统

SSM共享充电宝系统

&#x1f345;点赞收藏关注 → 添加文档最下方联系方式咨询本源代码、数据库&#x1f345; 本人在Java毕业设计领域有多年的经验&#xff0c;陆续会更新更多优质的Java实战项目希望你能有所收获&#xff0c;少走一些弯路。&#x1f345;关注我不迷路&#x1f345; 项目视频 SS…
阅读更多...
Android 常用命令和工具解析之存储相关

Android 常用命令和工具解析之存储相关

1 基本概念 2 命令解读 2.1 adb shell df df 命令主要用于需要检查文件系统上已使用和可用的磁盘空间的数量。如果没有指定文件名&#xff0c;则显示在当前所有挂载的文件系统上可用的空间。其原理是从proc/mounts 或 /etc/mtab 中检索磁盘信息。 注意&#xff1a;df命令并…
阅读更多...
51单片机编程学习笔记——LED原理图

51单片机编程学习笔记——LED原理图

大纲 概览LED电路图Resistor Pack3位数电阻表示法VCC 在《51单片机编程学习笔记——编译代码点亮LED》一文中&#xff0c;我们通过下面这段代码点亮了D1和D2两个LED灯。 sbit LED1P2^0; //将P2.0管脚定义为LED1 sbit LED2P2^1; //将P2.1管脚定义为LED2 …… LED10; LED20;那么…
阅读更多...
测试的BUG分析

测试的BUG分析

在了解BUG之前,我们要先了解软件测试的生命周期,因为大多数BUG都是在软件测试的过程中被发现的 软件测试的生命周期 在了解 软件测试的生命周期 之前,我们要先了解 软件的生命周期 ,虽然他们之间只差了两个字,但是差距还是很大的 首先是 软件生命周期 ,这个是站在 软件 的角…
阅读更多...
vue3+ts实现动态下拉选项为图标

vue3+ts实现动态下拉选项为图标

功能&#xff1a;实现可配置项&#xff0c;下拉选项为图标&#xff0c;如图&#xff1a; 代码如下&#xff1a; <el-select v-model"BuyVolAcc" size"small" style"width: 100%" class"icon-selector"><el-option v-for&qu…
阅读更多...
C语言（15）--------------＞一维数组

C语言（15）--------------＞一维数组

这篇文章介绍的是数组的定义、创建、初始化、使用&#xff0c;在数组中输入内容并输出数组中的内容&#xff0c;并探讨了数组在内存中的存储。里面有些内容建议大家参考下面的一些文章&#xff0c;有助于加深大家对于C语言的理解&#xff1a; C语言&#xff08;2&#xff09;-…
阅读更多...
RISCV指令集解析

RISCV指令集解析

参考视频&#xff1a;《RISC-V入门&进阶教程》1-4-RV32I基本指令集&#xff08;1&#xff09;_哔哩哔哩_bilibili privilege是特权指令集&#xff0c;有点系统调用的感觉&#xff0c;要走内核态。unprivilege指令集有点像普通的函数调用。
阅读更多...
2.27 链表中等 817

2.27 链表中等 817

817. Linked List Components class Solution { public:int numComponents(ListNode* head, vector<int>& nums) {// 将 nums 存储到一个 unordered_set 中&#xff0c;方便 O(1) 查找unordered_set<int> numSet(nums.begin(), nums.end());int count 0;bool …
阅读更多...
NFC拉起微信小程序申请URL scheme 汇总

NFC拉起微信小程序申请URL scheme 汇总

NFC拉起微信小程序&#xff0c;需要在微信小程序开发里边申请 URL scheme &#xff0c;审核通过后才可以使用NFC标签碰一碰拉起微信小程序 有不少人被难住了&#xff0c;从微信小程序开发社区汇总了以下信息&#xff0c;供大参考 第一&#xff0c;NFC标签打开小程序 https://de…
阅读更多...
rustdesk远程桌面自建服务器

rustdesk远程桌面自建服务器

首先&#xff0c;我这里用到的是阿里云服务器 centos7版本&#xff0c;win版客户端。 准备工作 centos7 服务器端文件&#xff1a; https://github.com/rustdesk/rustdesk-server/releases/download/1.1.11-1/rustdesk-server-linux-amd64.zip win版客户端安装包&#xff1…
阅读更多...
ERROR “GET /mobiles/13344444444/count/ HTTP/1.1“ 500 63503

ERROR “GET /mobiles/13344444444/count/ HTTP/1.1“ 500 63503

背景&#xff1a; 美多的&#xff0c;这个问题我不知道那个老师为啥没讲&#xff0c;我直接去看了他的源码发现可恶&#xff0c;直接啥也没有&#xff0c;关键是他竟然跑的通 早知道用postman代替这个该死的刷新就好了&#xff0c;我写了差不多20多次 view.py的 class Mobile…
阅读更多...
LabVIEW 项目长时间稳定运行注意事项

LabVIEW 项目长时间稳定运行注意事项

利用 LabVIEW 开发的上位机显示界面通过网络与数字板实现数据通讯&#xff0c;运行一周左右会出现一次数据掉线&#xff08;数据采集不上来&#xff09;&#xff0c;需重新 Connect 才能恢复的问题。 出现这种情况&#xff0c;可能是以下几方面原因导致&#xff1a; 网络通讯方…
阅读更多...
MYSQL学习笔记(十)：约束介绍(如：非空、唯一、主键、外键、级联、默认、检查约束)

MYSQL学习笔记(十)：约束介绍(如：非空、唯一、主键、外键、级联、默认、检查约束)

前言&#xff1a; 学习和使用数据库可以说是程序员必须具备能力&#xff0c;这里将更新关于MYSQL的使用讲解&#xff0c;大概应该会更新30篇&#xff0c;涵盖入门、进阶、高级(一些原理分析);这一篇讲解“约束”&#xff0c;如&#xff1a;非空、唯一、主键、外键、级联、默认…
阅读更多...
最新文章

Copyright @ 2022~2023