Align naming of RedisCache and RedisCacheWriter

Author: christophstrobl

src/main/java/org/springframework/data/redis/cache/DefaultRedisCacheWriter.java

@@ -416,20 +416,20 @@ public byte[] putIfAbsent(String name, byte[] key, byte[] value, @Nullable Durat
 	}
 
 	@Override
-	public void remove(String name, byte[] key) {
+	public void evict(String name, byte[] key) {
 
 		Assert.notNull(name, "Name must not be null");
 		Assert.notNull(key, "Key must not be null");
 
 		if (writeAsynchronously()) {
 			asyncCacheWriter.remove(name, key).thenRun(() -> statistics.incDeletes(name));
 		} else {
-			removeIfPresent(name, key);
+			evictIfPresent(name, key);
 		}
 	}
 
 	@Override
-	public boolean removeIfPresent(String name, byte[] key) {
+	public boolean evictIfPresent(String name, byte[] key) {
 
 		Long removals = execute(name, connection -> connection.keyCommands().del(key));
 		statistics.incDeletes(name);

src/main/java/org/springframework/data/redis/cache/RedisCache.java

@@ -265,12 +265,12 @@ public void clearStatistics() {
 
 	@Override
 	public void evict(Object key) {
-		getCacheWriter().remove(getName(), createAndConvertCacheKey(key));
+		getCacheWriter().evict(getName(), createAndConvertCacheKey(key));
 	}
 
 	@Override
 	public boolean evictIfPresent(Object key) {
-		return getCacheWriter().removeIfPresent(getName(), createAndConvertCacheKey(key));
+		return getCacheWriter().evictIfPresent(getName(), createAndConvertCacheKey(key));
 	}
 
 	@Override

src/main/java/org/springframework/data/redis/cache/RedisCacheWriter.java

@@ -260,8 +260,24 @@ default CompletableFuture<byte[]> retrieve(String name, byte[] key) {
 	 *
 	 * @param name cache name must not be {@literal null}.
 	 * @param key key for the cache entry. Must not be {@literal null}.
+	 * @deprecated since 4.0 in favor of {@link #evict(String, byte[])}
 	 */
-	void remove(String name, byte[] key);
+	@Deprecated(since = "4.0", forRemoval = true)
+	default void remove(String name, byte[] key) {
+		evict(name, key);
+	}
+
+	/**
+	 * Remove the given key from Redis.
+	 * <p>
+	 * Actual eviction may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly still
+	 * seeing the entry.
+	 *
+	 * @param name cache name must not be {@literal null}.
+	 * @param key key for the cache entry. Must not be {@literal null}.
+	 * @since 4.0
+	 */
+	void evict(String name, byte[] key);
 
 	/**
 	 * Remove the given key from Redis if it is present, expecting the key to be immediately invisible for subsequent
@@ -271,9 +287,10 @@ default CompletableFuture<byte[]> retrieve(String name, byte[] key) {
 	 * @param key key for the cache entry. Must not be {@literal null}.
 	 * @return {@code true} if the cache was known to have a mapping for this key before, {@code false} if it did not (or
 	 *         if prior presence could not be determined).
+	 * @since 4.0
 	 */
-	default boolean removeIfPresent(String name, byte[] key) {
-		remove(name, key);
+	default boolean evictIfPresent(String name, byte[] key) {
+		evict(name, key);
 		return false;
 	}
 

src/test/java/org/springframework/data/redis/cache/DefaultRedisCacheWriterTests.java

@@ -286,27 +286,27 @@ void getWithValueLoaderShouldStoreCacheValue() {
 	}
 
 	@Test // DATAREDIS-481, DATAREDIS-1082
-	void removeShouldDeleteEntry() {
+	void evictShouldDeleteEntry() {
 
 		doWithConnection(connection -> connection.set(binaryCacheKey, binaryCacheValue));
 
 		RedisCacheWriter writer = RedisCacheWriter.create(connectionFactory,
 				config -> config.collectStatistics().immediateWrites());
 
-		writer.remove(CACHE_NAME, binaryCacheKey);
+		writer.evict(CACHE_NAME, binaryCacheKey);
 
 		doWithConnection(connection -> assertThat(connection.exists(binaryCacheKey)).isFalse());
 
 		assertThat(writer.getCacheStatistics(CACHE_NAME).getDeletes()).isOne();
 	}
 
 	@Test // GH-3236
-	void removeShouldNonblockingDeleteEntry() {
+	void evictShouldNonblockingDeleteEntry() {
 
 		RedisCacheWriter writer = RedisCacheWriter.create(connectionFactory, RedisCacheWriterConfigurer::collectStatistics);
 		assumeTrue(writer.supportsAsyncRetrieve());
 
-		writer.remove(CACHE_NAME, binaryCacheKey);
+		writer.evict(CACHE_NAME, binaryCacheKey);
 
 		doWithConnection(connection -> {
 			Awaitility.await().pollInSameThread().pollDelay(Duration.ZERO).until(() -> !connection.exists(binaryCacheKey));
@@ -317,21 +317,21 @@ void removeShouldNonblockingDeleteEntry() {
 	}
 
 	@Test // GH-3236
-	void removeShouldDeleteEntryIfExists() {
+	void evictIfPresentShouldDeleteEntryIfExists() {
 
 		doWithConnection(connection -> connection.set(binaryCacheKey, binaryCacheValue));
 
 		RedisCacheWriter writer = RedisCacheWriter.create(connectionFactory, RedisCacheWriterConfigurer::collectStatistics);
 
-		assertThat(writer.removeIfPresent(CACHE_NAME, binaryCacheKey)).isTrue();
+		assertThat(writer.evictIfPresent(CACHE_NAME, binaryCacheKey)).isTrue();
 
 		doWithConnection(connection -> assertThat(connection.exists(binaryCacheKey)).isFalse());
 
 		assertThat(writer.getCacheStatistics(CACHE_NAME).getDeletes()).isOne();
 	}
 
 	@Test // DATAREDIS-418, DATAREDIS-1082
-	void cleanShouldRemoveAllKeysByPattern() {
+	void clearShouldRemoveAllKeysByPattern() {
 
 		doWithConnection(connection -> {
 			connection.set(binaryCacheKey, binaryCacheValue);
@@ -341,7 +341,7 @@ void cleanShouldRemoveAllKeysByPattern() {
 		RedisCacheWriter writer = RedisCacheWriter.create(connectionFactory,
 				config -> config.collectStatistics().immediateWrites());
 
-		writer.clean(CACHE_NAME, (CACHE_NAME + "::*").getBytes(StandardCharsets.UTF_8));
+		writer.clear(CACHE_NAME, (CACHE_NAME + "::*").getBytes(StandardCharsets.UTF_8));
 
 		doWithConnection(connection -> {
 			assertThat(connection.exists(binaryCacheKey)).isFalse();
@@ -352,7 +352,7 @@ void cleanShouldRemoveAllKeysByPattern() {
 	}
 
 	@Test // GH-3236
-	void nonBlockingCleanShouldRemoveAllKeysByPattern() {
+	void nonBlockingClearShouldRemoveAllKeysByPattern() {
 
 		RedisCacheWriter writer = RedisCacheWriter.create(connectionFactory, RedisCacheWriterConfigurer::collectStatistics);
 		assumeTrue(writer.supportsAsyncRetrieve());
@@ -362,7 +362,7 @@ void nonBlockingCleanShouldRemoveAllKeysByPattern() {
 			connection.set("foo".getBytes(), "bar".getBytes());
 		});
 
-		writer.clean(CACHE_NAME, (CACHE_NAME + "::*").getBytes(StandardCharsets.UTF_8));
+		writer.clear(CACHE_NAME, (CACHE_NAME + "::*").getBytes(StandardCharsets.UTF_8));
 
 		doWithConnection(connection -> {
 			Awaitility.await().pollInSameThread().pollDelay(Duration.ZERO).until(() -> !connection.exists(binaryCacheKey));