SpringBoot2.x—SpringCache(3) CacheManager源码

CacheManager是用来存储Cache对象。而Cache对象中存储的是K-V缓存数据,在宏观意义上将CacheNames::Key才是存储结构中实际的Key。Cache对象可以看做一组(配置)K-V数据。

CacheManager既然存储所有的Cache对象。那么开篇需要考虑两个问题:

  1. Cache什么时候被CacheManager存储;
  2. 存储Cache时,是否可以增强Cache功能;

1. CacheManager在Spring Cache中的作用

1. Spring Cache结构

缓存抽象不提供实际的存储,而是依赖于org.springframework.cache.Cacheorg.springframework.cache.CacheManager接口实现抽象,SpringCache的缓存架构如图一所示。

SpringBoot2.x—SpringCache(3) CacheManager源码_第1张图片
图1-SpringCache的缓存架构.png

2. Spring Cache流程

  1. 项目启动加载bean时,解析缓存注解,创建代理对象。
  2. 调用方法时,直接调用代理对象,在代理方法中获取到指定的CacheManager对象。
  3. 根据注解的cacheNames属性,在CacheManager中获取到Cache对象,然后调用org.springframework.cache.Cache中的方法对缓存数据进行操作。调用流程如图2所示。
SpringBoot2.x—SpringCache(3) CacheManager源码_第2张图片
图2-Spring Cache调用流程.png
  • CacheManager:主要作用是存储某一数据结构(例如Redis)中所有Cache对象。
  • Cache:作用是操纵Cache对象中的K-V数据。

2. 如何自定义实现CacheManager

自定义实现CacheManager对象,可以参考org.springframework.data.redis.cache.RedisCacheManager类,类继承结构如图3所示。

SpringBoot2.x—SpringCache(3) CacheManager源码_第3张图片
图3-RedisCacheManager继承结构图.png

2.1 AbstractCacheManager—定义算法骨架

AbstractCacheManagerCacheManager的子类。定义了管理Cache的骨架算法,自定义的CacheManager继承org.springframework.cache.support.AbstractCacheManager类后,只需要实现其中的钩子方法。AbstractCacheManager方法如图4所示。

SpringBoot2.x—SpringCache(3) CacheManager源码_第4张图片
图4-CacheManager对象.png
属性 作用
cacheMap ConcurrentMap类型,用于缓存Cache对象。
cacheNames Set类型,用于缓存CacheNames
方法 作用
getCache 模板方法(已定义算法逻辑),子类需实现getMissingCachedecorateCache钩子方法。目的:将Cache放入cacheMap中,获取Cache对象。
getCacheNames 获取CacheNames的集合。
afterPropertiesSet bean对象初始化方法,实际调用initializeCaches()方法。
decorateCache 钩子方法(需要子类实现),装饰Cache对象。
getMissingCache 钩子方法(需要子类实现),若CacheManager不存在Cache对象时的处理策略。
initializeCaches 模板方法,包含loadCaches方法,将Caches集合读取到缓存中。
loadCaches 抽象钩子方法(需要子类实现),加载配置中参数,创建Caches集合。
lookupCache 根据key获取Cache对象。
updateCacheNames 私有方法,更新CacheNames集合。

2.2 AbstractTransactionSupportingCacheManager—实现事务支持

AbstractTransactionSupportingCacheManager类重写了AbstractCacheManager#decorateCache的方法,对Cache对象的功能进行加强,使其支持事务。

SpringBoot2.x—SpringCache(3) CacheManager源码_第5张图片
图5-AbstractTransactionSupportingCacheManager类方法.png

将Cache对象保存到CacheManager中时,调用子类实现的decorateCache方法对Cache对象功能进行加强。

例如:org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager#decorateCachetransactionAware==true,返回支持事务的Cache对象,否则返回普通的Cache对象。

image.png

org.springframework.cache.transaction.TransactionAwareCacheDecorator装饰Cache对象,重写put、evict和clear方法。只有事务真正提交,才会保存到缓存中。

SpringBoot2.x—SpringCache(3) CacheManager源码_第6张图片
image.png

2.3 RedisCacheManager—自定义的CacheManager

RedisCacheManager虽继承自CacheManager接口,但在AbstractCacheManager中重写了getCache(String)等方法逻辑。而子类只需要实现图4红圈中的方法。

SpringBoot2.x—SpringCache(3) CacheManager源码_第7张图片
图4-RedisCacheManager实现的方法.png
2.3.1 钩子方法

1. 抽象钩子方法(强制实现)—loadCaches(加载配置中Cache对象集合)
在项目启动时,读取配置文件中的参数,来初始化自定义的CacheManager对象。

AbstractCacheManager#afterPropertiesSet方式是在构造方法之后,init方法之前执行,完成类的初始化操作。

SpringBoot2.x—SpringCache(3) CacheManager源码_第8张图片
image.png

子类必须重写AbstractCacheManager#loadCaches方法,读取配置文件的参数,构建对应的XxxCache对象集合,在AbstractCacheManager#initializeCaches方法中将Cache集合保存到cacheMap中。

子类的loadCaches方法可以返回空集合但是不能返回null。

在RedisCacheManager中,我们可以在配置文件中加载(不同配置的)Cache对象(例如:Cache1设置60s的超时时间,Cache2设置30s超时时间),从而解决Spring Cache无法设置过期时间的缺陷!

SpringBoot2.x—SpringCache(3) CacheManager源码_第9张图片
image.png

2. 具体钩子方法(选择性实现)—decorateCache(装饰Cache对象)
AbstractCacheManager#decorateCache作用就是装饰Cache对象,加强功能。实际上Cache对象中定义了对缓存的增改删查等操作。

3. 具体钩子方法(必须实现)—getMissingCache(处理Miss缓存)
在CacheManager增加缓存的方法实际上有两种,一种是读取配置文件中的Cache配置列表;另一种是在获取Cache对象时,若不存在便创建Cache对象,并将其放入到cacheMap中。

SpringBoot2.x—SpringCache(3) CacheManager源码_第10张图片
image.png

AbstractCacheManager#getMissingCache方法是一个具体的钩子方法,默认返回null。子类RedisCacheManager#getMissingCache中重写了该方法。根据allowInFlightCacheCreation属性来决定是否构建Cache对象。

image.png

如果getMissingCache方法返回null,即CacheManager中不存在对应的Cache对象,SpringCache会抛出异常。

2.3.2 创建自定义Cache

实际上RedisCacheManager中存储的是RedisCache对象。根据我们的分析。缓存Cache对象的方法主要有两种,一种是在初始化中读取配置文件配置;一种是发现不存在时创建。但是都是调用了RedisCacheManager#createRedisCache方法。

image.png
2.3.3 RedisCache的配置

可以在配置文件中对org.springframework.data.redis.cache.RedisCacheConfiguration属性进行配置,也就是对Redis进行配置。

SpringBoot2.x—SpringCache(3) CacheManager源码_第11张图片
image.png

第四篇:SpringBoot中Cache缓存的使用

你可能感兴趣的:(SpringBoot2.x—SpringCache(3) CacheManager源码)