SpringBoot整合Caffeine缓存时如何获取对象从缓存返回的通知
针对你的需求,Spring Boot 2.2.x + Caffeine 2.8.0 没有直接内置名为objectServedFromCacheListener的回调接口,但可以通过扩展Spring Cache的内置组件实现100%准确的缓存命中监听,不需要依赖时长判断这类不可靠的方案,具体实现方案如下:
方案1:自定义CaffeineCache装饰器(最精准,无侵入业务代码)
该方案通过扩展Spring原生的CaffeineCache类,重写缓存查询逻辑,命中时触发自定义回调,完全适配Spring缓存的注解体系,不需要修改任何业务代码:
- 自定义可监听命中的缓存实现类
import com.github.benmanes.caffeine.cache.Cache; import org.springframework.cache.caffeine.CaffeineCache; import java.util.concurrent.Callable; public class ListenableCaffeineCache extends CaffeineCache { public ListenableCaffeineCache(String name, Cache<Object, Object> cache) { super(name, cache); } @Override public ValueWrapper get(Object key) { ValueWrapper valueWrapper = super.get(key); // 非空即缓存命中 if (valueWrapper != null) { doOnCacheHit(key, valueWrapper.get()); } return valueWrapper; } @Override public <T> T get(Object key, Callable<T> valueLoader) { Cache<Object, Object> nativeCache = getNativeCache(); // 先判断是否已存在缓存 Object existVal = nativeCache.getIfPresent(key); if (existVal != null) { doOnCacheHit(key, existVal); return (T) existVal; } // 缓存未命中,调用业务方法加载数据 try { T newValue = valueLoader.call(); put(key, newValue); return newValue; } catch (Exception e) { throw new RuntimeException(e); } } // 自定义缓存命中后的处理逻辑 private void doOnCacheHit(Object key, Object value) { // 此处可写日志记录、指标上报、业务监听等逻辑 System.out.printf("缓存命中,key:%s,返回值:%s%n", key, value); } }
- 替换默认的CacheManager实现
import com.github.benmanes.caffeine.cache.Caffeine; import org.springframework.cache.CacheManager; import org.springframework.cache.caffeine.CaffeineCacheManager; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import java.util.concurrent.TimeUnit; @Configuration public class CacheConfig { @Bean public Caffeine caffeineConfig() { return Caffeine.newBuilder() .maximumSize(1000) .expireAfterWrite(4, TimeUnit.HOURS); } @Bean public CacheManager cacheManager(Caffeine caffeine) { CaffeineCacheManager cacheManager = new CaffeineCacheManager() { @Override protected CaffeineCache createCaffeineCache(String name) { return new ListenableCaffeineCache(name, caffeine.build()); } }; cacheManager.setCaffeine(caffeine); return cacheManager; } }
方案2:利用Caffeine原生统计功能(适合仅需统计无需实时触发回调的场景)
如果你不需要每次命中都执行业务逻辑,仅需要统计命中率、命中次数这类指标,直接开启Caffeine的内置统计即可:
- 修改Caffeine配置开启统计
@Bean public Caffeine caffeineConfig() { return Caffeine.newBuilder() .maximumSize(1000) .expireAfterWrite(4, TimeUnit.HOURS) .recordStats(); // 开启命中、未命中、加载耗时等统计 }
- 任意位置获取统计数据
import com.github.benmanes.caffeine.cache.stats.CacheStats; import org.springframework.cache.CacheManager; import org.springframework.cache.caffeine.CaffeineCache; import org.springframework.beans.factory.annotation.Autowired; public class CacheStatsService { @Autowired private CacheManager cacheManager; public void getCacheMetrics(String cacheName) { CaffeineCache cache = (CaffeineCache) cacheManager.getCache(cacheName); if (cache != null) { CacheStats stats = cache.getNativeCache().stats(); long hitCount = stats.hitCount(); // 累计命中次数 long missCount = stats.missCount(); // 累计未命中次数 double hitRate = stats.hitRate(); // 缓存命中率 } } }
注意事项
- 上述两种方案都完全适配你使用的Spring Boot 2.2.2、Caffeine 2.8.0版本,不需要额外引入依赖
- 不要采用调用时长判断的方案,业务逻辑执行速度波动、缓存查询耗时高等极端场景都会导致误判,准确性无法保证
- 如果需要区分「缓存命中返回」和「首次加载后返回」,方案1中通过
getIfPresent判断的逻辑已经做了明确区分,不会出现误判
内容的提问来源于stack exchange,提问作者Jacobs2000
相关产品推荐
相关产品推荐

