深入理解 Spring Cache 的工作原理及集成其它第三方缓存

news2024/12/24 14:33:19

目录

  • 1、Spring Cache 简介
  • 2、常用注解
    • 2.1、常用注解介绍
    • 2.2、常用注解的主要参数
  • 3、缓存注解上 SPEL 表达式可使用的元数据
  • 4、入门案例
    • 4.1、引入依赖
    • 4.2、开启缓存功能
    • 4.3、使用缓存
      • 4.3.1、新建一个 `UserServiceImpl`
      • 4.3.2、新建一个 `UserController`
  • 5、工作原理
    • 5.1、缓存自动配置类 CacheAutoConfiguration
    • 5.2、默认缓存管理器 ConcurrentMapCacheManager
    • 5.3、默认缓存 ConcurrentMapCache
    • 5.4、@CachePut 注解
    • 5.5、@Cacheable 注解
    • 5.6、key 的生成策略
  • 6、Spring Cache 集成其它第三方缓存
    • 6.1、集成 Ehcache
      • 6.1.1、引入依赖
      • 6.1.2、开启缓存功能【已开启】
      • 6.1.3、配置缓存管理器
      • 6.1.4、调用 Controller
    • 6.2、集成 Redis
      • 6.2.1、引入依赖
      • 6.2.2、添加配置
      • 6.2.3、调用 Controller

1、Spring Cache 简介

Spring 从 3.1 开始定义了 org.springframework.cache.Cacheorg.springframework.cache.CacheManager 接口来统一不同的缓存技术

  • Cache:缓存接口,定义缓存操作。实现有:RedisCacheEhCacheCacheConcurrentMapCache
  • CacheManager : 缓存管理器,管理各种缓存(Cache)组件
  • keyGenerator : 缓存数据时 key 生成策略
  • serialize: 缓存数据时 value 序列化策略

2、常用注解

2.1、常用注解介绍

cache 方面的注解主要有以下 5 个:

  1. @Cacheable【创建、查询缓存】:触发缓存入口(一般放在创建和获取的方法上,@Cacheable 注解会先查询是否已经有缓存。如果有,则直接从缓存中返回;如果没有,则会执行方法并返回结果缓存【返回方法返回 NULL,则不进行缓存】)
  2. @CachePut【更新缓存】:更新缓存且不影响方法执行(用于修改的方法上,该注解下的方法始终会被执行)
  3. @CacheEvict【删除缓存】:触发缓存的 eviction(用于删除的方法上)
  4. @Caching【组合缓存配置】:将多个缓存组合在一个方法上(该注解可以允许一个方法同时设置多个注解)
  5. @CacheConfig【类级别共享配置】:在类级别设置一些缓存相关的共同配置(与其它缓存配合使用),避免在每个缓存方法上重复配置相同的缓存属性

2.2、常用注解的主要参数

@Cacheable/@CachePut/@CacheEvict 注解上的主要参数:

参数名解释举例
value缓存的名称,必须至少指定一个@Cacheable(value = “cache”) 或 @Cacheable(value = {“cache1”, “cache2”})
key缓存的 key。可以为空。如果指定,需要按照 SPEL 表达式编写;否则,按照方法的所有参数组合@Cacheable(value = “cache”, key = “#id”)
condition缓存的条件,可以为空。使用 SPEL 表达式编写。只有为 true,才进行缓存/清除缓存;在调用方法之前、之后都能判断@Cacheable(value = “cache”, condition = “#userName.length() > 5”)
allEntries是否清空所有缓存。如果指定为 true,则调用完方法后立即清空所有缓存
beforeInvocation是否在方法执行前清空。如果指定为 true,则在方法执行前就清空缓存
unless用于否决缓存,只在方法执行之后判断。对返回值 result 进行判断,如果为 true,则不会缓存;否则,会缓存

3、缓存注解上 SPEL 表达式可使用的元数据

Spring Cache 提供了一些供我们使用的 SpEL 上下文数据,下表:

名称位置描述示例
methodNameroot 对象当前被调用的方法名#root.methodname
methodroot 对象当前被调用的方法#root.method.name
targetroot 对象当前被调用的目标对象实例#root.target
targetClassroot 对象当前被调用的目标对象的类#root.targetClass
argsroot 对象当前被调用的方法的参数列表#root.args[0]
cachesroot 对象当前方法调用使用的缓存列表#root.caches[0].name
Argument Name执行上下文当前被调用的方法的参数,如findArtisan(Artisan artisan),可以通过#artsian.id获得参数#artsian.id
result执行上下文方法执行后的返回值(仅当方法执行后的判断有效,如 unless cacheEvict的beforeInvocation=false)#result
  1. 当我们要使用root对象的属性作为key时我们也可以将“#root”省略,因为Spring默认使用的就是root对象的属性。如:@Cacheable(key = "targetClass + methodName +#p0")
  2. 使用方法参数时我们可以直接使用“#参数名”或者“#p参数index”。如:@Cacheable(value="userCache", key="#id")@Cacheable(value="userCache", key="#p0")

SpEL 提供了多种运算符

类型运算符
关系<,>,<=,>=,==,!=,lt,gt,le,ge,eq,ne
算术+,- ,* ,/,%,^
逻辑&&,
条件?: (ternary),?: (elvis)
正则表达式matches
其他类型?.,?[…],![…],1,$[…]

4、入门案例

4.1、引入依赖

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

4.2、开启缓存功能

开启缓存功能,需要先添加使能注解 @EnableCaching,通常习惯在启动类配置,否则缓存注解@Cacheable 等不起作用

4.3、使用缓存

4.3.1、新建一个 UserServiceImpl

@Slf4j
@Service
@CacheConfig(cacheNames = "userCache")
public class UserServiceImpl {

    // 模拟数据库数据
    private Map<Integer, User> userMap = new HashMap<>();

    @CachePut(key = "#user.id")
    public User add(User user) {
        log.info("add");
        userMap.put(user.getId(), user);
        return user;
    }

    @Cacheable(key = "#id")
    public User get(Integer id) {
        log.info("get");
        return userMap.get(id);
    }

    @CachePut(key = "#user.id")
    public User update(User user) {
        log.info("update");
        userMap.put(user.getId(), user);
        return user;
    }

    @CacheEvict(key = "#id")
    public void delete(Integer id) {
        log.info("delete");
        userMap.remove(id);
    }
}

4.3.2、新建一个 UserController

@RestController
public class UserController {

    @Autowired
    private UserServiceImpl userServiceImpl;

    @PostMapping
    public String add(@RequestBody User user) {
        userServiceImpl.add(user);
        return "add";
    }

    @GetMapping("/{id}")
    public User get(@PathVariable Integer id) {
        User user = userServiceImpl.get(id);
        return user;
    }

    @PutMapping
    public String update(@RequestBody User user) {
        userServiceImpl.update(user);
        return "update";
    }

    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id) {
        userServiceImpl.delete(id);
        return "delete";
    }

}

5、工作原理

5.1、缓存自动配置类 CacheAutoConfiguration

分析运行流程,首先要先从自动配置类入手,缓存的自动配置类为 CacheAutoConfiguration,其中它在 @Import 中导入了 CacheAutoConfiguration.CacheConfigurationImportSelector.class

static class CacheConfigurationImportSelector implements ImportSelector {
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    	// 获取所有的缓存类型
        CacheType[] types = CacheType.values();
        String[] imports = new String[types.length];

        for(int i = 0; i < types.length; ++i) {
        	// 根据缓存类型获取对应的配置类
            imports[i] = CacheConfigurations.getConfigurationClass(types[i]);
        }
        return imports;
    }
}

selectImports() 方法导入了所有的缓存配置类。因此,在返回值这里打上断点,查看结果如下:

在这里插入图片描述

那么,默认情况下是哪个配置类生效呢?在每一个配置类上都有对应的条件注解 @ConditionXxx()

org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration 为例:

@ConditionalOnBean({Cache.class})
@ConditionalOnMissingBean({CacheManager.class})
@Conditional({CacheCondition.class})
class GenericCacheConfiguration {
	//...
}

确保只有在存在 Cache Bean 且不存在 CacheManager Bean 的情况下,才会创建这个缓存管理器 SimpleCacheManager

为了在控制台上观察它的自动配置报告,现在 application.yml 全局配置文件中开启:

debug: true

运行主程序,打印控制台,发现只有一个 SimpleCacheConfiguration 匹配上。所以默认是它生效的:

在这里插入图片描述

SimpleCacheConfiguration 就是给容器中注册了一个 ConcurrentMapCacheManager 缓存管理器:

@ConditionalOnMissingBean({CacheManager.class})
@Conditional({CacheCondition.class})
class SimpleCacheConfiguration {

    @Bean
    ConcurrentMapCacheManager cacheManager(CacheProperties cacheProperties, CacheManagerCustomizers cacheManagerCustomizers) {
        ConcurrentMapCacheManager cacheManager = new ConcurrentMapCacheManager();
        List<String> cacheNames = cacheProperties.getCacheNames();
        if (!cacheNames.isEmpty()) {
            cacheManager.setCacheNames(cacheNames);
        }
        return (ConcurrentMapCacheManager)cacheManagerCustomizers.customize(cacheManager);
    }
}

5.2、默认缓存管理器 ConcurrentMapCacheManager

getCache() 方法:根据 name 获取缓存 ConcurrentMapCache,如果为空,则创建;否则,直接返回

@Nullable
public Cache getCache(String name) {
    Cache cache = (Cache)this.cacheMap.get(name);
    if (cache == null && this.dynamic) {
        synchronized(this.cacheMap) {
            cache = (Cache)this.cacheMap.get(name);
            if (cache == null) {
                cache = this.createConcurrentMapCache(name);
                this.cacheMap.put(name, cache);
            }
        }
    }
    return cache;
}

5.3、默认缓存 ConcurrentMapCache

public class ConcurrentMapCache extends AbstractValueAdaptingCache {
	// 存数据
	private final ConcurrentMap<Object, Object> store;
	// 序列化
	@Nullable
    private final SerializationDelegate serialization;	
	
	// 根据 key 查找
    @Nullable
    protected Object lookup(Object key) {
        return this.store.get(key);
    }
    
    // 添加
    public void put(Object key, @Nullable Object value) {
        this.store.put(key, this.toStoreValue(value));
    }
    
    // 删除
    public void evict(Object key) {
        this.store.remove(key);
    }
    //...
}

5.4、@CachePut 注解

@CachePut 注解流程:

  1. 先根据缓存名称获取缓存 CacheConcurrentMapCacheManager】,没有则创建。这里是 ConcurrentMapCache
  2. 调用 put() 方法存入缓存中【ConcurrentMapCache】,如果配置序列化,则将 value 先进行序列化

在这里插入图片描述

在这里插入图片描述

5.5、@Cacheable 注解

@Cacheable 注解流程:

  1. 先根据缓存名称获取缓存 CacheConcurrentMapCacheManager】,没有则创建。这里是 ConcurrentMapCache
  2. 调用 lookup() 方法从缓存中查询【ConcurrentMapCache】,如果查询到,则直接返回;否则,就调用目标方法,将目标方法返回的结果,放进缓存中

在这里插入图片描述

5.6、key 的生成策略

lookup() 方法的入参是 key。那这个 key 是如何来的呢?

通过断点信息查看,通过 CacheAspectSupport#generateKey() 方法生成的:

在这里插入图片描述

在它的方法中,是通过 keyGnerator 对象来制定 key 的生成策略:

在这里插入图片描述

默认情况是使用 SimpleKeyGenerator

在这里插入图片描述

通过生成的 key 查找 cache,如果存在,则直接返回:

在这里插入图片描述

6、Spring Cache 集成其它第三方缓存

SpringBoot的内置缓存以及整合第三方缓存

6.1、集成 Ehcache

6.1.1、引入依赖

只需添加以下依赖(在原有的依赖基础上):

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

6.1.2、开启缓存功能【已开启】

6.1.3、配置缓存管理器

@Configuration
public class EhCacheConfig {

    @Bean(name = "ehCacheManager")
    public CacheManager cacheManager() {
        // ①:设置内存存储位置和数量大小
        ResourcePools resourcePools = ResourcePoolsBuilder.newResourcePoolsBuilder()
                // 堆内存
                .heap(1000)
                // 堆外内存
                .offheap(10, MemoryUnit.MB)
                // 磁盘
                .disk(20,MemoryUnit.MB, true)
                .build();
        // ②:设置生存时间
        ExpiryPolicy expiry = ExpiryPolicyBuilder.timeToIdleExpiration(Duration.ofMillis(1000));
        // ③:设置 CacheConfiguration
        CacheConfiguration userCache = CacheConfigurationBuilder
                .newCacheConfigurationBuilder(Integer.class, String.class, resourcePools)
                .withExpiry(expiry)
                .build();
        // ④:设置磁盘存储的位置
        CacheManagerBuilder<PersistentCacheManager> cacheManagerBuilder = CacheManagerBuilder.newCacheManagerBuilder().with(CacheManagerBuilder.persistence("D:/data/"));
        // ⑤:设置缓存名称
        cacheManagerBuilder = cacheManagerBuilder.withCache("userCache", userCache);
        // 初始化 CacheManager
        return cacheManagerBuilder.build(true);

    }
}

6.1.4、调用 Controller

到这里,SpringBoot 整合 Ehcache 就做完了。可以发现一点,原始代码没有任何修改,仅仅是加了一组配置就可以变更缓存供应商了,这也是 SpringBoot 提供了统一的缓存操作接口的优势,变更实现并不影响原始代码的书写

6.2、集成 Redis

6.2.1、引入依赖

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

6.2.2、添加配置

spring:
  redis:
    host: 127.0.0.1
    port: 6379
  cache:
    redis:
      # 是否使用 key 前缀
      use-key-prefix: true
      # key 前缀
      key-prefix: "userCache:"
      # 是否缓存空值
      cache-null-values: true
      # 缓存过期时间,单位毫秒
      time-to-live: 3600000

6.2.3、调用 Controller


  1. … ↩︎

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Java建筑行业智能化管理系统源码,PC端、手机端、大屏端源码,智慧工地管理平台源码,智慧建设平台 智慧住建平台

智慧工地平台全套源码合作 智慧工地是指运用现代信息技术&#xff0c;如物联网&#xff08;IoT&#xff09;、大数据、人工智能&#xff08;AI&#xff09;、云计算、移动互联网等&#xff0c;对传统建筑工地进行智能化改造和管理的新型工地。它通过高度集成的系统和设备&#…

GeoCue与Xer Technologies合作推动无人机测绘技术革新

GeoCue与Xer Technologies合作推动无人机测绘技术革新 近期,LiDAR测绘硬件和软件开发商GeoCue与瑞士长航时混合动力无人机制造商Xer Technologies AG携手合作,成功将GeoCue的TrueView 720 LiDAR和图像传感器集成至Xer X8无人机平台。这一里程碑式的合作不仅标志着无人机测绘技…

Python手绘五星红旗,庆75周年

环境 pip install matplotlib pip install numpy 代码 import matplotlib.pyplot as plt import numpy as np# 中国国旗的标准尺寸比例是 3:2 width, height 300, 200 # 这里可以调整为任何满足3:2比例的尺寸# 创建一个新图形 fig, ax plt.subplots(figsize(width/100, h…

js 字符串下划线转驼峰 驼峰转下划线

一、下划线转驼峰 1、效果 2、示例 function underscoreToCamelCase(str) {return str.replace(/(_\w)/g, function(match) {return match[1].toUpperCase();}).replace(/^_/, ); }// 示例 let snakeCaseStr "hello_world"; let camelCaseStr underscoreToCamelC…

【Diffusion分割】Cold SegDiffusion:医学图像分割的扩散模型

Cold SegDiffusion: A novel diffusion model for medical image segmentation 摘要&#xff1a; 随着深度学习的发展&#xff0c;扩散模型在医学图像分割任务中表现出了卓越的性能。然而&#xff0c;传统的分割扩散模型通常采用随机高斯噪声生成分割掩膜&#xff0c;导致分割…

【华为HCIP实战课程七】OSPF邻居关系排错MTU问题,网络工程师

一、MTU MUT默认1500,最大传输单元,一致性检测 [R3-GigabitEthernet0/0/1]mtu 1503//更改R3的MTU为1503 查看R3和SW1之间的OSPF邻居关系正常: 默认华为设备没有开启MTU一致性检测! [R3-GigabitEthernet0/0/1]ospf mtu-enable //手动开启MTU检测 [SW1-Vlanif30]ospf mtu…

项目——超级马里奥——Day(2)

争取今天晚上能搞一半啊&#xff0c;啊啊啊啊&#xff0c;感觉事多的忙不过来 设计思路&#xff1a; 1&#xff09;创建并完成常量类 ------->一张图片的情况 先完成对图片的封装------>把图片加载一遍 &#xff08;老实说&#xff0c;我也不太知道为什么&#xff0…

Windows 开发工具使用技巧 QT使用安装和使用技巧 QT快捷键

一、QT配置 1. 安装 Qt 开发框架 1、下载 1、进入下载地址 下载地址1 (官方, 需注册账号)&#xff1a; https://www.qt.io/download下载地址2&#xff08;推荐&#xff09;&#xff1a; http://download.qt.io/http://download.qt.io/archive/qt/ &#xff08;或更直接的…

【C++前缀和】1878. 矩阵中最大的三个菱形和|1897

本文涉及的基础知识点 C算法&#xff1a;前缀和、前缀乘积、前缀异或的原理、源码及测试用例 包括课程视频 LeetCode 1878. 矩阵中最大的三个菱形和 难度分&#xff1a;1897 给你一个 m x n 的整数矩阵 grid 。 菱形和 指的是 grid 中一个正菱形 边界 上的元素之和。本题中的…

ElasticSearch备考 -- Update by query Reindex

一、题目 有个索引task&#xff0c;里面的文档长这样 现在需要添加一个字段all&#xff0c;这个字段的值是以下 a、b、c、d字段的值连在一起 二、思考 需要把四个字段拼接到一起&#xff0c;组成一个新的字段&#xff0c;这个就需要脚本&#xff0c; 这里有两种方案&#xff…

ES 文件浏览器批量下载的链接

在 ES 文件浏览器上的网页上下载文件需要一个一个点击下载&#xff0c;这样非常麻烦&#xff0c;实际上文件在网页上都对应有一个真实的地址&#xff0c;这样通过 For 循环可以打印出下载地址&#xff0c;然后粘贴到迅雷中就可以批量下载了 http://10.0.0.47:5050/download?pa…

【Canvas与徽章】盾形银底红带Best Quality Premium徽章

【成图】 【代码】 <!DOCTYPE html> <html lang"utf-8"> <meta http-equiv"Content-Type" content"text/html; charsetutf-8"/> <head><title>BestQulity金属牌Draft3</title><style type"text/css…

怎么成为年薪53万的AI产品经理?我分析了200份大厂的招聘要求

我在 BOSS 直聘搜索AI产品经理&#xff0c;筛选了公司规模在10000人以上的公司&#xff0c;清洗整理后得到 229 个岗位信息&#xff0c;分析得到如下信息&#xff1a; 按最低薪资算&#xff0c;平均年薪 40.2 万&#xff1b;取薪资范围均值&#xff0c;平均年薪 52.9 万;只有 …

判断两棵树是否相等

判断两棵树是否相等 两棵树是否相等的判断条件&#xff1a; 1. 树的结构一样 2. 对应节点存放的值相等 思路1&#xff1a; 首先对树的结果判断&#xff0c;若结构一样&#xff0c;则进行下一步节点中值的判断&#xff0c;若结构不一样&#xff0c;直接返回false 1.定义一个f…

C++ | Leetcode C++题解之第458题可怜的小猪

题目&#xff1a; 题解&#xff1a; class Solution { public:int poorPigs(int buckets, int minutesToDie, int minutesToTest) {if (buckets 1) {return 0;}vector<vector<int>> combinations(buckets 1,vector<int>(buckets 1));combinations[0][0] …

万字长文带你从底层到实战了解Python中的time模块,从基础到进阶让你轻松掌握时间管理

博客主页&#xff1a;长风清留扬-CSDN博客系列专栏&#xff1a;Python基础专栏每天更新大数据相关方面的技术&#xff0c;分享自己的实战工作经验和学习总结&#xff0c;尽量帮助大家解决更多问题和学习更多新知识&#xff0c;欢迎评论区分享自己的看法感谢大家点赞&#x1f44…

图解Linux文件属性与目录配置

Linux的文件属性十分重要&#xff0c;与windows的文件属性有很大不同&#xff0c;Linux的文件增加了许多属性&#xff0c;如读写、连接数、文件拥有者及所属群组。如果一个文件属于一个群组&#xff0c;那么这个群组的成员就可以访问&#xff0c;其他的群组就不能访问&#xff…

Qt中的网络客户端

目录 HttpClient http报文相关 HttpClient发送报文格式 x-www-form-urlencoded: multipart/form-data raw binary QUrl QNetworkAccessManager Http-Get Http-Post http-post:form-data ftp-up ftp-down QDesktopServices HttpClient http报文相关 URL是为了 统…

人机协作:科技与人类智慧的融合

随着科技的飞速发展&#xff0c;越来越多的领域开始借助人工智能&#xff08;AI&#xff09;和自动化技术来提升工作效率。人机协作&#xff08;Human-Machine Collaboration&#xff09;这一概念逐渐成为现代技术进步的核心。它不仅改变了我们的工作方式&#xff0c;也在重新定…