Prevent cache from consuming too much memory

Change the cache in `CachingOperationInvoker` to be a reference based
map and also clean stale entries when a specific threshold is met.

Fixes gh-28313
This commit is contained in:
Phillip Webb
2021-10-14 11:17:54 -07:00
parent adb9226dec
commit 4dc5142128
2 changed files with 50 additions and 3 deletions

View File

@@ -18,9 +18,10 @@ package org.springframework.boot.actuate.endpoint.invoker.cache;
import java.security.Principal;
import java.time.Duration;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
@@ -30,6 +31,7 @@ import org.springframework.boot.actuate.endpoint.http.ApiVersion;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.ConcurrentReferenceHashMap;
import org.springframework.util.ObjectUtils;
/**
@@ -45,6 +47,8 @@ public class CachingOperationInvoker implements OperationInvoker {
private static final boolean IS_REACTOR_PRESENT = ClassUtils.isPresent("reactor.core.publisher.Mono", null);
private static final int CACHE_CLEANUP_THRESHOLD = 40;
private final OperationInvoker invoker;
private final long timeToLive;
@@ -61,7 +65,7 @@ public class CachingOperationInvoker implements OperationInvoker {
Assert.isTrue(timeToLive > 0, "TimeToLive must be strictly positive");
this.invoker = invoker;
this.timeToLive = timeToLive;
this.cachedResponses = new ConcurrentHashMap<>();
this.cachedResponses = new ConcurrentReferenceHashMap<>();
}
/**
@@ -78,6 +82,9 @@ public class CachingOperationInvoker implements OperationInvoker {
return this.invoker.invoke(context);
}
long accessTime = System.currentTimeMillis();
if (this.cachedResponses.size() > CACHE_CLEANUP_THRESHOLD) {
cleanExpiredCachedResponses(accessTime);
}
ApiVersion contextApiVersion = context.getApiVersion();
CacheKey cacheKey = new CacheKey(contextApiVersion, context.getSecurityContext().getPrincipal());
CachedResponse cached = this.cachedResponses.get(cacheKey);
@@ -89,6 +96,20 @@ public class CachingOperationInvoker implements OperationInvoker {
return cached.getResponse();
}
private void cleanExpiredCachedResponses(long accessTime) {
try {
Iterator<Entry<CacheKey, CachedResponse>> iterator = this.cachedResponses.entrySet().iterator();
while (iterator.hasNext()) {
Entry<CacheKey, CachedResponse> entry = iterator.next();
if (entry.getValue().isStale(accessTime, this.timeToLive)) {
iterator.remove();
}
}
}
catch (Exception ex) {
}
}
private boolean hasInput(InvocationContext context) {
Map<String, Object> arguments = context.getArguments();
if (!ObjectUtils.isEmpty(arguments)) {