Introduce evictIfPresent/invalidate operations on Cache abstraction

@CacheEvict.beforeInvocation suggests immediate execution even in case of transactional caches. The cache interceptor delegates to the new evictIfPresent/invalidate operations now which imply immediate execution semantics (and also provide an indication for whether any corresponding entries where present when programmatically called).

Closes gh-23192

Author: jhoeller

spring-context-support/src/main/java/org/springframework/cache/caffeine/CaffeineCache.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -123,11 +123,23 @@ public void evict(Object key) {
 		this.cache.invalidate(key);
 	}
 
+	@Override
+	public boolean evictIfPresent(Object key) {
+		return (this.cache.asMap().remove(key) != null);
+	}
+
 	@Override
 	public void clear() {
 		this.cache.invalidateAll();
 	}
 
+	@Override
+	public boolean invalidate() {
+		boolean notEmpty = !this.cache.asMap().isEmpty();
+		this.cache.invalidateAll();
+		return notEmpty;
+	}
+
 
 	private class PutIfAbsentFunction implements Function<Object, Object> {
 

spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheCache.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,6 +72,19 @@ public ValueWrapper get(Object key) {
 		return toValueWrapper(element);
 	}
 
+	@SuppressWarnings("unchecked")
+	@Override
+	@Nullable
+	public <T> T get(Object key, @Nullable Class<T> type) {
+		Element element = this.cache.get(key);
+		Object value = (element != null ? element.getObjectValue() : null);
+		if (value != null && type != null && !type.isInstance(value)) {
+			throw new IllegalStateException(
+					"Cached value is not of required type [" + type.getName() + "]: " + value);
+		}
+		return (T) value;
+	}
+
 	@SuppressWarnings("unchecked")
 	@Override
 	@Nullable
@@ -95,7 +108,6 @@ public <T> T get(Object key, Callable<T> valueLoader) {
 				this.cache.releaseWriteLockOnKey(key);
 			}
 		}
-
 	}
 
 	private <T> T loadValue(Object key, Callable<T> valueLoader) {
@@ -110,19 +122,6 @@ private <T> T loadValue(Object key, Callable<T> valueLoader) {
 		return value;
 	}
 
-	@Override
-	@SuppressWarnings("unchecked")
-	@Nullable
-	public <T> T get(Object key, @Nullable Class<T> type) {
-		Element element = this.cache.get(key);
-		Object value = (element != null ? element.getObjectValue() : null);
-		if (value != null && type != null && !type.isInstance(value)) {
-			throw new IllegalStateException(
-					"Cached value is not of required type [" + type.getName() + "]: " + value);
-		}
-		return (T) value;
-	}
-
 	@Override
 	public void put(Object key, @Nullable Object value) {
 		this.cache.put(new Element(key, value));
@@ -140,11 +139,23 @@ public void evict(Object key) {
 		this.cache.remove(key);
 	}
 
+	@Override
+	public boolean evictIfPresent(Object key) {
+		return this.cache.remove(key);
+	}
+
 	@Override
 	public void clear() {
 		this.cache.removeAll();
 	}
 
+	@Override
+	public boolean invalidate() {
+		boolean notEmpty = (this.cache.getSize() > 0);
+		this.cache.removeAll();
+		return notEmpty;
+	}
+
 
 	@Nullable
 	private Element lookup(Object key) {

spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCache.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -105,11 +105,23 @@ public void evict(Object key) {
 		this.cache.remove(key);
 	}
 
+	@Override
+	public boolean evictIfPresent(Object key) {
+		return this.cache.remove(key);
+	}
+
 	@Override
 	public void clear() {
 		this.cache.removeAll();
 	}
 
+	@Override
+	public boolean invalidate() {
+		boolean notEmpty = this.cache.iterator().hasNext();
+		this.cache.removeAll();
+		return notEmpty;
+	}
+
 
 	private class ValueLoaderEntryProcessor<T> implements EntryProcessor<Object, Object, T> {
 

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/AbstractCacheInterceptor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -59,7 +59,7 @@ protected abstract Object invoke(CacheOperationInvocationContext<O> context, Cac
 	/**
 	 * Resolve the cache to use.
 	 * @param context the invocation context
-	 * @return the cache to use (never null)
+	 * @return the cache to use (never {@code null})
 	 */
 	protected Cache resolveCache(CacheOperationInvocationContext<O> context) {
 		Collection<? extends Cache> caches = context.getOperation().getCacheResolver().resolveCaches(context);
@@ -73,7 +73,7 @@ protected Cache resolveCache(CacheOperationInvocationContext<O> context) {
 	/**
 	 * Convert the collection of caches in a single expected element.
 	 * <p>Throw an {@link IllegalStateException} if the collection holds more than one element
-	 * @return the single element or {@code null} if the collection is empty
+	 * @return the single element, or {@code null} if the collection is empty
 	 */
 	@Nullable
 	static Cache extractFrom(Collection<? extends Cache> caches) {

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/CacheRemoveAllInterceptor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,7 +42,6 @@ protected Object invoke(
 			CacheOperationInvocationContext<CacheRemoveAllOperation> context, CacheOperationInvoker invoker) {
 
 		CacheRemoveAllOperation operation = context.getOperation();
-
 		boolean earlyRemove = operation.isEarlyRemove();
 		if (earlyRemove) {
 			removeAll(context);
@@ -67,10 +66,10 @@ protected Object invoke(
 	protected void removeAll(CacheOperationInvocationContext<CacheRemoveAllOperation> context) {
 		Cache cache = resolveCache(context);
 		if (logger.isTraceEnabled()) {
-			logger.trace("Invalidating entire cache '" + cache.getName() + "' for operation "
-					+ context.getOperation());
+			logger.trace("Invalidating entire cache '" + cache.getName() + "' for operation " +
+					context.getOperation());
 		}
-		doClear(cache);
+		doClear(cache, context.getOperation().isEarlyRemove());
 	}
 
 }

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/CacheRemoveEntryInterceptor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,7 +42,6 @@ protected Object invoke(
 			CacheOperationInvocationContext<CacheRemoveOperation> context, CacheOperationInvoker invoker) {
 
 		CacheRemoveOperation operation = context.getOperation();
-
 		boolean earlyRemove = operation.isEarlyRemove();
 		if (earlyRemove) {
 			removeValue(context);
@@ -68,10 +67,10 @@ private void removeValue(CacheOperationInvocationContext<CacheRemoveOperation> c
 		Object key = generateKey(context);
 		Cache cache = resolveCache(context);
 		if (logger.isTraceEnabled()) {
-			logger.trace("Invalidating key [" + key + "] on cache '" + cache.getName()
-					+ "' for operation " + context.getOperation());
+			logger.trace("Invalidating key [" + key + "] on cache '" + cache.getName() +
+					"' for operation " + context.getOperation());
 		}
-		doEvict(cache, key);
+		doEvict(cache, key, context.getOperation().isEarlyRemove());
 	}
 
 }

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/CacheRemoveOperation.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -50,8 +50,8 @@ public ExceptionTypeFilter getExceptionTypeFilter() {
 	}
 
 	/**
-	 * Specify if the cache entry should be remove before invoking the method. By default, the
-	 * cache entry is removed after the method invocation.
+	 * Specify if the cache entry should be removed before invoking the method.
+	 * <p>By default, the cache entry is removed after the method invocation.
 	 * @see javax.cache.annotation.CacheRemove#afterInvocation()
 	 */
 	public boolean isEarlyRemove() {

spring-context-support/src/main/java/org/springframework/cache/transaction/TransactionAwareCacheDecorator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,14 +25,16 @@
 import org.springframework.util.Assert;
 
 /**
- * Cache decorator which synchronizes its {@link #put}, {@link #evict} and {@link #clear}
- * operations with Spring-managed transactions (through Spring's {@link TransactionSynchronizationManager},
- * performing the actual cache put/evict/clear operation only in the after-commit phase of a
- * successful transaction. If no transaction is active, {@link #put}, {@link #evict} and
+ * Cache decorator which synchronizes its {@link #put}, {@link #evict} and
+ * {@link #clear} operations with Spring-managed transactions (through Spring's
+ * {@link TransactionSynchronizationManager}, performing the actual cache
+ * put/evict/clear operation only in the after-commit phase of a successful
+ * transaction. If no transaction is active, {@link #put}, {@link #evict} and
  * {@link #clear} operations will be performed immediately, as usual.
  *
- * <p>Use of more aggressive operations such as {@link #putIfAbsent} cannot be deferred
- * to the after-commit phase of a running transaction. Use these with care.
+ * <p><b>Note:</b> Use of immediate operations such as {@link #putIfAbsent} and
+ * {@link #evictIfPresent} cannot be deferred to the after-commit phase of a
+ * running transaction. Use these with care in a transactional environment.
  *
  * @author Juergen Hoeller
  * @author Stephane Nicoll
@@ -54,6 +56,7 @@ public TransactionAwareCacheDecorator(Cache targetCache) {
 		this.targetCache = targetCache;
 	}
 
+
 	/**
 	 * Return the target Cache that this Cache should delegate to.
 	 */
@@ -124,6 +127,11 @@ public void afterCommit() {
 		}
 	}
 
+	@Override
+	public boolean evictIfPresent(Object key) {
+		return this.targetCache.evictIfPresent(key);
+	}
+
 	@Override
 	public void clear() {
 		if (TransactionSynchronizationManager.isSynchronizationActive()) {
@@ -139,4 +147,9 @@ public void afterCommit() {
 		}
 	}
 
+	@Override
+	public boolean invalidate() {
+		return this.targetCache.invalidate();
+	}
+
 }