📋 目录
一、工具类功能
给热点数据一份「容量上限 + 可选存活时间」的本地缓存,命中就把条目挪到最新一侧,容量满时丢掉最久没用的那条,读写都会给 TTL 续期,几行代码就能接上。
二、所需环境
JDK 17或以上
三、方法与调用示例(按需调用)
🔢 方法序号:1
🎯 方法用途:
- 造一份只有容量上限的 LRU 缓存,不启用 TTL,条目靠容量淘汰管理
- 字典、配置项、模板编译结果这类不会失效的热点数据用它
🧩 方法定义:public static <K, V> LruCache<K, V> create(int maxCapacity)
🗣️ 入参解释:public static <K, V> LruCache<K, V> create(最大容量)
📤 返回值解释:LruCache<K, V>,独立的缓存实例,等效于把存活时间设为 0
💡 边界口径:
- 上限必须大于 0,否则抛
IllegalArgumentException - 每次 create 得到独立实例,实例之间不共享条目
- 同一实例的读写方法都落在同一把锁上串行,适合单机小容量;要分段并发、权重上限或回源去重请换 Caffeine
🧪 方法示例:
create(3).maxCapacity()拿到3create(0)抛最大容量必须大于0,当前为0create(-3)抛最大容量必须大于0,当前为-3
🔢 方法序号:2
🎯 方法用途:
- 造一份带存活时间的 LRU 缓存,条目从最后一次读写起计时过期
- 汇率快照、费率这类过一会儿就得重取的缓存用这一版
🧩 方法定义:public static <K, V> LruCache<K, V> create(int maxCapacity, long ttlMillis)
🗣️ 入参解释:public static <K, V> LruCache<K, V> create(最大容量, 存活毫秒)
📤 返回值解释:LruCache<K, V>,带 TTL 的缓存实例
💡 边界口径:
- TTL 按 expireAfterAccess 计算,读写命中都续期,与 LRU 的最近使用同口径
- 存活毫秒小于等于 0 等同不启用 TTL
- 容量上限的校验与单参入口一致
- 没有后台清理线程,过期条目要在被读到或调用
purgeExpired时才真正移除
🧪 方法示例:
- 上限 4、存活 200 毫秒的缓存,每 80 毫秒读一次共读 4 次,累计已超 200 毫秒却仍一直命中,拿到
true - 同一份缓存放着不动 300 毫秒后已判过期,读取结果拿到
null
🔢 方法序号:3
🎯 方法用途:
- 写入一条缓存:新键可能触发容量淘汰,已有键覆盖值并续期
- 算完一份数据顺手缓存、或者把外部查询结果回填时用
🧩 方法定义:public synchronized void put(K key, V value)
🗣️ 入参解释:public synchronized void put(键, 值)
📤 返回值解释:void,写入即生效,不返回被淘汰的条目
💡 边界口径:
- 超出上限时从最久未访问的一端开始丢,每丢一条累计一次淘汰
- 值可以是 null,读的时候要靠
containsKey才分得清 - 键为 null 抛
NullPointerException,与其他方法把 null 键当未命中的口径不同 - 并发写同一实例时容量约束始终成立,条目数不会越过上限
🧪 方法示例:
- 容量 3 的缓存写满后先读一次 rate 再写 invoice,
containsKey("city")拿到false,最久未使用的被丢掉 - 被读过一次的 rate 躲过淘汰,
containsKey("rate")拿到true - 写入后条目数
size()拿到3 - 4 个线程各写 500 条到容量 64 的同一实例,全部跑完拿到
true - 并发过程中捕获到的异常数拿到
0 - 跑完后的条目数拿到
64,没有越过上限 - 这一轮累计的淘汰条数拿到
1940 - 键传 null 时抛
NullPointerException,消息是缓存key不能为null
🔢 方法序号:4
🎯 方法用途:
- 读一条缓存,命中会把条目挪到最新一侧并续期
- 只想要值、未命中就自己走后续逻辑时用
🧩 方法定义:public synchronized V get(K key)
🗣️ 入参解释:public synchronized V get(键)
📤 返回值解释:V,命中的值(可能是缓存进去的 null);未命中或已过期返回 null
💡 边界口径:
- 读写都算最近使用,被 get 命中的条目更晚被淘汰
- 过期条目按未命中处理,同时顺手把这条从表里移除
- 键为 null 直接返回 null,不抛异常
- 缓存了 null 时返回 null 分不出「没有」和「值是 null」,要区分用
containsKey
🧪 方法示例:
goods.get("sku:1001")拿到128goods.get("sku:9999")没写过这个键,拿到nullgoods.get(null)也按未命中处理,拿到null- 存活 200 毫秒的缓存停手 300 毫秒后再读,拿到
null
🔢 方法序号:5
🎯 方法用途:
- 读缓存,未命中时用回源函数取一次并写回缓存
- 「有就用缓存、没有就算一次」的取值场景,省掉先 get 再 put 的样板
🧩 方法定义:public synchronized V get(K key, Function<? super K, ? extends V> mappingFunction)
🗣️ 入参解释:public synchronized V get(键, 回源函数)
📤 返回值解释:V,命中值或回源值
💡 边界口径:
- 回源在锁内执行:并发未命中会被串行化,代价是等待,收益是不会重复回源,回源耗时较长时改用带加载去重的方案
- 回源返回 null 表示「无值可缓存」,不写入条目,下次还会再回源,与
Map.computeIfAbsent一致;要缓存 null 就显式put - 键或回源函数为 null 抛
NullPointerException - 回源写入同样可能触发容量淘汰
🧪 方法示例:
rateCache.get("USD", loader)第一次回源拿到rate(USD)- 同一个键第二次调用直接命中,拿到的还是
rate(USD) - 两次调用加起来回源次数拿到
1 - 回源函数返回 null 时本次拿到
null - 这次回源没有落进缓存,
containsKey("UNKNOWN")拿到false - 回源失败后累计回源次数仍是
1 - 键传 null 时抛
NullPointerException,消息是缓存key不能为null - 回源函数传 null 时抛
NullPointerException,消息是mappingFunction 不能为null
🔢 方法序号:6
🎯 方法用途:
- 读缓存,未命中或已过期时返回给定默认值
- 希望调用方永远拿到一个可用值、不用自己判 null 时用
🧩 方法定义:public synchronized V getOrDefault(K key, V defaultValue)
🗣️ 入参解释:public synchronized V getOrDefault(键, 默认值)
📤 返回值解释:V,命中值或默认值
💡 边界口径:
- 内部就是 get 之后再兜默认值,读写续期口径与 get 一致
- 缓存了 null 时同样返回默认值,分不出「没有」与「值为 null」
- 键为 null 不抛异常,直接走默认值
🧪 方法示例:
goods.getOrDefault("sku:9999", 0)未命中拿到0goods.getOrDefault("sku:1001", 0)命中拿到128- 缓存了 null 的键走默认值分支,
getOrDefault("sku:1002", -1)拿到-1
🔢 方法序号:7
🎯 方法用途:
- 判一个键是否还在缓存里,判定包含过期检查
- 缓存了 null 值、或者要确认「这条到底还在不在」时用
🧩 方法定义:public synchronized boolean containsKey(K key)
🗣️ 入参解释:public synchronized boolean containsKey(键)
📤 返回值解释:boolean,存在且未过期才为 true
💡 边界口径:
- 已过期的键不会被报成存在
- 检查时会顺带把过期条目移除
- 它能区分「没缓存」与「缓存了 null」,get 与 getOrDefault 都不能
- 命中判定同样算一次访问,会给条目续期
🧪 方法示例:
- 写进 null 的
sku:1002,containsKey拿到true - 条目被
purgeExpired清掉之后再查,拿到false
🔢 方法序号:8
🎯 方法用途:
- 移除一个键,并把原来存着的值交还给调用方
- 主动失效某条缓存(配置改了、数据更新)时用
🧩 方法定义:public synchronized V remove(K key)
🗣️ 入参解释:public synchronized V remove(键)
📤 返回值解释:V,被移除的值;键不存在或已过期返回 null
💡 边界口径:
- 过期条目照样从表里清掉,但不会把这份过期的值当有效值交出去
- 键为 null 是空操作,返回 null 不抛异常
- 移除不影响容量淘汰的累计数
🧪 方法示例:
- 早已过期、没人碰过的条目
stale.remove("a")拿到null - 移除之后条目数降到
1,这条确实被清掉了
🔢 方法序号:9
🎯 方法用途:
- 清空全部条目,回到空缓存
- 配置热更新后整份作废、或者测试用例之间复位时用
🧩 方法定义:public synchronized void clear()
🗣️ 入参解释:public synchronized void clear()(无入参)
📤 返回值解释:void,只清条目,不动统计
💡 边界口径:
- 淘汰累计数是历史值,清空不会归零
- 清空后容量上限、TTL 设置都保持原样,实例可以继续用
🧪 方法示例:
cache.clear()之后size()拿到0- 清空后
evictionCount()仍是历史累计值,拿到1
🔢 方法序号:10
🎯 方法用途:
- 取当前条目数
- 判断缓存是否已经预热、或者在压测里核对是否被容量约束兜住时用
🧩 方法定义:public synchronized int size()
🗣️ 入参解释:public synchronized int size()(无入参)
📤 返回值解释:int,条目数
💡 边界口径:
- 启用 TTL 时这个数可能暂时包含已过期但没被读到、也没被清理的条目
- 条目的真实可用性以 get、containsKey 的判定为准
🧪 方法示例:
- 两条都早已过期且没人碰过的缓存,
size()拿到2 - 写满并淘汰过一次的缓存,
size()停在3
🔢 方法序号:11
🎯 方法用途:
- 取创建时定下的容量上限
- 核对配置、或者把条目数与淘汰数放在一起看时用
🧩 方法定义:public int maxCapacity()
🗣️ 入参解释:public int maxCapacity()(无入参)
📤 返回值解释:int,容量上限
💡 边界口径:
- 上限不可动态调整,要改容量只能新建实例
- 实例内部按上限反推初始桶容量,避免写满时反复扩容
🧪 方法示例:
cache.maxCapacity()拿到3
🔢 方法序号:12
🎯 方法用途:
- 取因容量上限被淘汰的条目累计数
- 观察缓存是不是偏小:淘汰一直涨就说明上限该调大
🧩 方法定义:public synchronized long evictionCount()
🗣️ 入参解释:public synchronized long evictionCount()(无入参)
📤 返回值解释:long,累计淘汰条数
💡 边界口径:
- 只统计容量淘汰,不含 TTL 过期
- 是历史累计值,
clear之后不归零
🧪 方法示例:
- 写满四条只留三条的一轮之后,
evictionCount()拿到1 - 清空缓存后它仍是
1,不受清空影响
🔢 方法序号:13
🎯 方法用途:
- 主动扫一遍并清掉全部已过期条目,返回清掉的条数
- 交给定时任务周期性清理,别让过期条目一直占着条目数
🧩 方法定义:public synchronized int purgeExpired()
🗣️ 入参解释:public synchronized int purgeExpired()(无入参)
📤 返回值解释:int,本次清掉的条目数
💡 边界口径:
- 没启用 TTL 的缓存恒返回 0,直接跳过扫描
- 清掉之后这些键的
containsKey就会判不存在 - 只清过期条目,未过期的与容量淘汰计数都不受影响
🧪 方法示例:
remove之后还剩一条过期条目,purgeExpired()把它清掉拿到1- 清理之后条目数
size()拿到0 - 紧接着再清一次拿到
0条 - 没启 TTL 的缓存调用它恒拿到
0
🔢 方法序号:14
🎯 方法用途:
- 输出容量、TTL、条目数与淘汰数拼成的概览串
- 把缓存状态直接打进日志或者监控快照,不用自己拼字段
🧩 方法定义:public synchronized String toString()
🗣️ 入参解释:public synchronized String toString()(无入参)
📤 返回值解释:String,形如 LruCache{maxCapacity=3, ttlMillis=0, size=3, evictions=1} 的一行概览
💡 边界口径:
- 字段顺序固定:maxCapacity、ttlMillis、size、evictions
- ttlMillis 为 0 表示这份缓存没启 TTL
- evictions 是累计值,与
evictionCount()同源
🧪 方法示例:
- 把容量 3、写满并淘汰过一条的缓存直接打进日志,概览串拿到
LruCache{maxCapacity=3, ttlMillis=0, size=3, evictions=1}
四、工具类源码(可直接复制)
📦 源码文件