DATAREDIS-694 - Add support for TOUCH.

We now support TOUCH for both Lettuce and Jedis in imperative and reactive (Lettuce only) KeyCommands.

Author: christophstrobl

src/main/java/org/springframework/data/redis/connection/DefaultStringRedisConnection.java

@@ -1205,6 +1205,15 @@ public DataType type(byte[] key) {
 		return convertAndReturn(delegate.type(key), identityConverter);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#touch(byte[][])
+	 */
+	@Override
+	public Long touch(byte[]... keys) {
+		return convertAndReturn(delegate.touch(keys), identityConverter);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisTxCommands#unwatch()
@@ -2496,6 +2505,16 @@ public DataType type(String key) {
 		return type(serialize(key));
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#touch(java.lang.String[])
+	 */
+	@Nullable
+	@Override
+	public Long touch(String... keys) {
+		return touch(serializeMulti(keys));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.StringRedisConnection#zAdd(java.lang.String, double, java.lang.String)

src/main/java/org/springframework/data/redis/connection/DefaultedRedisConnection.java

@@ -75,6 +75,13 @@ default DataType type(byte[] pattern) {
 		return keyCommands().type(pattern);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#keyCommands()}. */
+	@Override
+	@Deprecated
+	default Long touch(byte[]... keys) {
+		return keyCommands().touch(keys);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#keyCommands()}. */
 	@Override
 	@Deprecated

src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java

@@ -21,6 +21,7 @@
 import java.nio.ByteBuffer;
 import java.time.Duration;
 import java.time.Instant;
+import java.util.Collection;
 import java.util.List;
 
 import org.reactivestreams.Publisher;
@@ -87,6 +88,28 @@ default Mono<DataType> type(ByteBuffer key) {
 	 */
 	Flux<CommandResponse<KeyCommand, DataType>> type(Publisher<KeyCommand> keys);
 
+	/**
+	 * Alter the last access time of given {@code key(s)}.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return {@link Mono} emitting the number of keys touched.
+	 * @see <a href="http://redis.io/commands/touch">Redis Documentation: TOUCH</a>
+	 * @since 2.1
+	 */
+	default Mono<Long> touch(Collection<ByteBuffer> keys) {
+		return touch(Mono.just(keys)).next().map(NumericResponse::getOutput);
+	}
+
+	/**
+	 * Alter the last access time of given {@code key(s)}.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return
+	 * @see <a href="http://redis.io/commands/touch">Redis Documentation: TOUCH</a>
+	 * @since 2.1
+	 */
+	Flux<NumericResponse<Collection<ByteBuffer>, Long>> touch(Publisher<Collection<ByteBuffer>> keys);
+
 	/**
 	 * Find all keys matching the given {@literal pattern}.
 	 *

src/main/java/org/springframework/data/redis/connection/RedisKeyCommands.java

@@ -80,6 +80,17 @@ default Boolean exists(byte[] key) {
 	@Nullable
 	DataType type(byte[] key);
 
+	/**
+	 * Alter the last access time of given {@code key(s)}.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @see <a href="http://redis.io/commands/touch">Redis Documentation: TOUCH</a>
+	 * @since 2.1
+	 */
+	@Nullable
+	Long touch(byte[]... keys);
+
 	/**
 	 * Find all keys matching the given {@code pattern}.
 	 *

src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java

@@ -123,6 +123,17 @@ interface StringTuple extends Tuple {
 	 */
 	DataType type(String key);
 
+	/**
+	 * Alter the last access time of given {@code key(s)}.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @see <a href="http://redis.io/commands/touch">Redis Documentation: TOUCH</a>
+	 * @since 2.1
+	 */
+	@Nullable
+	Long touch(String... keys);
+
 	/**
 	 * Find all keys matching the given {@code pattern}.
 	 *

src/main/java/org/springframework/data/redis/connection/jedis/JedisClusterConnection.java

@@ -176,6 +176,37 @@ private static byte[][] getCommandArguments(byte[] key, Collection<byte[]> args)
 		return commandArgs;
 	}
 
+	/**
+	 * Execute the given command for the {@code key} provided potentially appending args. <br />
+	 * This method, other than {@link #execute(String, byte[]...)}, dispatches the command to the {@code key} serving
+	 * master node.
+	 *
+	 * <pre>
+	 * <code>
+	 * // SET foo bar EX 10 NX
+	 * execute("SET", "foo".getBytes(), asBinaryList("bar", "EX", 10, "NX")
+	 * </code>
+	 * </pre>
+	 *
+	 * @param command must not be {@literal null}.
+	 * @param keys must not be {@literal null}.
+	 * @param args must not be {@literal null}.
+	 * @return command result as delivered by the underlying Redis driver. Can be {@literal null}.
+	 * @since 2.1
+	 */
+	@Nullable
+	public <T> List<T> execute(String command, Collection<byte[]> keys, Collection<byte[]> args) {
+
+		Assert.notNull(command, "Command must not be null!");
+		Assert.notNull(keys, "Key must not be null!");
+		Assert.notNull(args, "Args must not be null!");
+
+		return clusterCommandExecutor.executeMultiKeyCommand((JedisMultiKeyClusterCommandCallback<T>) (client, key) -> {
+			return JedisClientUtils.execute(command, new byte[][] { key }, args.toArray(new byte[args.size()][]),
+					() -> client);
+		}, keys).resultsAsList();
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisConnection#geoCommands()
@@ -829,8 +860,7 @@ static class JedisClusterNodeResourceProvider implements ClusterNodeResourceProv
 
 				PropertyAccessor accessor = new DirectFieldAccessFallbackBeanWrapper(cluster);
 				this.connectionHandler = accessor.isReadableProperty("connectionHandler")
-						? (JedisClusterConnectionHandler) accessor.getPropertyValue("connectionHandler")
-						: null;
+						? (JedisClusterConnectionHandler) accessor.getPropertyValue("connectionHandler") : null;
 			} else {
 				this.connectionHandler = null;
 			}

src/main/java/org/springframework/data/redis/connection/jedis/JedisClusterKeyCommands.java

@@ -20,6 +20,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -97,6 +98,20 @@ public DataType type(byte[] key) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#touch(byte[][])
+	 */
+	@Nullable
+	@Override
+	public Long touch(byte[]... keys) {
+
+		Assert.notNull(keys, "Keys must not be null!");
+
+		return connection.<Long> execute("TOUCH", Arrays.asList(keys), Collections.emptyList()).stream()
+				.mapToLong(val -> val).sum();
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisKeyCommands#keys(byte[])

src/main/java/org/springframework/data/redis/connection/jedis/JedisKeyCommands.java

@@ -149,6 +149,19 @@ public DataType type(byte[] key) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#touch(byte[][])
+	 */
+	@Nullable
+	@Override
+	public Long touch(byte[]... keys) {
+
+		Assert.notNull(keys, "Keys must not be null!");
+
+		return Long.class.cast(connection.execute("TOUCH", keys));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisKeyCommands#keys(byte[])

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceKeyCommands.java

@@ -152,6 +152,30 @@ public DataType type(byte[] key) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisKeyCommands#touch(byte[][])
+	 */
+	@Override
+	public Long touch(byte[]... keys) {
+
+		Assert.notNull(keys, "Keys must not be null!");
+
+		try {
+			if (isPipelined()) {
+				pipeline(connection.newLettuceResult(getAsyncConnection().touch(keys)));
+				return null;
+			}
+			if (isQueueing()) {
+				transaction(connection.newLettuceTxResult(getConnection().touch(keys)));
+				return null;
+			}
+			return getConnection().touch(keys);
+		} catch (Exception ex) {
+			throw convertLettuceAccessException(ex);
+		}
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisKeyCommands#keys(byte[])

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveKeyCommands.java

@@ -20,6 +20,7 @@
 import reactor.core.publisher.Mono;
 
 import java.nio.ByteBuffer;
+import java.util.Collection;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -86,6 +87,22 @@ public Flux<CommandResponse<KeyCommand, DataType>> type(Publisher<KeyCommand> co
 		}));
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.ReactiveRedisConnection.ReactiveKeyCommands#touch(org.reactivestreams.Publisher)
+	 */
+	@Override
+	public Flux<NumericResponse<Collection<ByteBuffer>, Long>> touch(Publisher<Collection<ByteBuffer>> keysCollection) {
+
+		return connection.execute(cmd -> Flux.from(keysCollection).concatMap((keys) -> {
+
+			Assert.notEmpty(keys, "Keys must not be null!");
+
+			return cmd.touch(keys.toArray(new ByteBuffer[keys.size()]))
+					.map((value) -> new NumericResponse<>(keys, value));
+		}));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.ReactiveRedisConnection.ReactiveKeyCommands#keys(org.reactivestreams.Publisher)

src/test/java/org/springframework/data/redis/connection/AbstractConnectionIntegrationTests.java

@@ -2685,8 +2685,7 @@ public void hStrLenReturnsFieldLength() {
 		actual.add(connection.hSet("hash-hstrlen", "key-2", "value-2"));
 		actual.add(connection.hStrLen("hash-hstrlen", "key-2"));
 
-		verifyResults(
-				Arrays.asList(new Object[] { Boolean.TRUE, Boolean.TRUE, Long.valueOf("value-2".length()) }));
+		verifyResults(Arrays.asList(new Object[] { Boolean.TRUE, Boolean.TRUE, Long.valueOf("value-2".length()) }));
 	}
 
 	@Test // DATAREDIS-698
@@ -2695,17 +2694,33 @@ public void hStrLenReturnsZeroWhenFieldDoesNotExist() {
 		actual.add(connection.hSet("hash-hstrlen", "key-1", "value-1"));
 		actual.add(connection.hStrLen("hash-hstrlen", "key-2"));
 
-		verifyResults(
-				Arrays.asList(new Object[] { Boolean.TRUE, 0L }));
+		verifyResults(Arrays.asList(new Object[] { Boolean.TRUE, 0L }));
 	}
 
 	@Test // DATAREDIS-698
 	public void hStrLenReturnsZeroWhenKeyDoesNotExist() {
 
 		actual.add(connection.hStrLen("hash-no-exist", "key-2"));
 
-		verifyResults(
-				Arrays.asList(new Object[] { 0L }));
+		verifyResults(Arrays.asList(new Object[] { 0L }));
+	}
+
+	@Test // DATAREDIS-694
+	public void touchReturnsNrOfKeysTouched() {
+
+		connection.set("touch.this", "Can't touch this! - oh-oh oh oh oh-oh-oh");
+
+		actual.add(connection.touch("touch.this", "touch.that"));
+
+		verifyResults(Arrays.asList(new Object[] { 1L }));
+	}
+
+	@Test // DATAREDIS-694
+	public void touchReturnsZeroIfNoKeysTouched() {
+
+		actual.add(connection.touch("touch.this", "touch.that"));
+
+		verifyResults(Arrays.asList(new Object[] { 0L }));
 	}
 
 	protected void verifyResults(List<Object> expected) {

src/test/java/org/springframework/data/redis/connection/jedis/JedisClusterConnectionTests.java

@@ -28,7 +28,16 @@
 
 import java.io.IOException;
 import java.nio.charset.Charset;
-import java.util.*;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+import java.util.Set;
 import java.util.concurrent.TimeUnit;
 
 import org.junit.After;
@@ -375,7 +384,7 @@ public void executeWithKeyAndArgs() {
 
 	@Test(expected = IllegalArgumentException.class) // DATAREDIS-689
 	public void executeWithNoKeyAndArgsThrowsException() {
-		clusterConnection.execute("KEYS", null, Collections.singletonList("*".getBytes()));
+		clusterConnection.execute("KEYS", (byte[]) null, Collections.singletonList("*".getBytes()));
 	}
 
 	@Test // DATAREDIS-529
@@ -2195,4 +2204,19 @@ public void zUnionStoreShouldWorkForSameSlotKeys() {
 		assertThat(nativeConnection.zrange(SAME_SLOT_KEY_3_BYTES, 0, -1),
 				hasItems(VALUE_1_BYTES, VALUE_2_BYTES, VALUE_3_BYTES));
 	}
+
+	@Test // DATAREDIS-694
+	public void touchReturnsNrOfKeysTouched() {
+
+		nativeConnection.set(KEY_1, VALUE_1);
+		nativeConnection.set(KEY_2, VALUE_1);
+
+		assertThat(clusterConnection.keyCommands().touch(KEY_1_BYTES, KEY_2_BYTES, KEY_3_BYTES), is(2L));
+	}
+
+	@Test // DATAREDIS-694
+	public void touchReturnsZeroIfNoKeysTouched() {
+		assertThat(clusterConnection.keyCommands().touch(KEY_1_BYTES), is(0L));
+	}
+
 }

src/test/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveKeyCommandsTests.java

@@ -287,4 +287,23 @@ public void shouldMoveToDatabase() {
 				.verify();
 		assertThat(nativeCommands.exists(KEY_1), is(0L));
 	}
+
+	@Test // DATAREDIS-694
+	public void touchReturnsNrOfKeysTouched() {
+
+		nativeCommands.set(KEY_1, VALUE_1);
+		nativeCommands.set(KEY_2, VALUE_2);
+
+		StepVerifier.create(connection.keyCommands().touch(Arrays.asList(KEY_1_BBUFFER, KEY_2_BBUFFER, KEY_3_BBUFFER)))
+				.expectNext(2L) //
+				.verifyComplete();
+	}
+
+	@Test // DATAREDIS-694
+	public void touchReturnsZeroIfNoKeysTouched() {
+
+		StepVerifier.create(connection.keyCommands().touch(Arrays.asList(KEY_1_BBUFFER))) //
+				.expectNext(0L) //
+				.verifyComplete();
+	}
 }