Add support for GETEX and GETDEL through getAndExpire(…), getAndPersist(…) and getAndDelete(…) methods.

We now support Redis 6.2 GETEX and GETDEL commands through the Template API and on the connection level for all drivers.

Author: mp911de

src/main/asciidoc/new-features.adoc

@@ -7,7 +7,7 @@ This section briefly covers items that are new and noteworthy in the latest rele
 == New in Spring Data Redis 2.6
 
 * Support for `SubscriptionListener` when using `MessageListener` for subscription confirmation callbacks. `ReactiveRedisMessageListenerContainer` and `ReactiveRedisOperations` provide `receiveLater(…)` and `listenToLater(…)` methods to await until Redis acknowledges the subscription.
-* Support Redis 6.2 commands (`LPOP`/`RPOP` with `count`).
+* Support Redis 6.2 commands (`LPOP`/`RPOP` with `count`, `GETEX`, `GETDEL`).
 
 [[new-in-2.5.0]]
 == New in Spring Data Redis 2.5

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

@@ -399,6 +399,46 @@ public byte[] get(byte[] key) {
 		return convertAndReturn(delegate.get(key), Converters.identityConverter());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	 */
+	@Nullable
+	@Override
+	public byte[] getDel(byte[] key) {
+		return convertAndReturn(delegate.getDel(key), Converters.identityConverter());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	 */
+	@Nullable
+	@Override
+	public String getDel(String key) {
+		return convertAndReturn(delegate.getDel(serialize(key)), bytesToString);
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#get(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public byte[] getEx(byte[] key, Expiration expiration) {
+		return convertAndReturn(delegate.getEx(key, expiration), Converters.identityConverter());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#get(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public String getEx(String key, Expiration expiration) {
+		return convertAndReturn(delegate.getEx(serialize(key), expiration), bytesToString);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisStringCommands#getBit(byte[], long)

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

@@ -268,6 +268,20 @@ default byte[] get(byte[] key) {
 		return stringCommands().get(key);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#stringCommands()}}. */
+	@Override
+	@Deprecated
+	default byte[] getEx(byte[] key, Expiration expiration) {
+		return stringCommands().getEx(key, expiration);
+	}
+
+	/** @deprecated in favor of {@link RedisConnection#stringCommands()}}. */
+	@Override
+	@Deprecated
+	default byte[] getDel(byte[] key) {
+		return stringCommands().getDel(key);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#stringCommands()}}. */
 	@Override
 	@Deprecated

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

@@ -218,6 +218,109 @@ default Mono<ByteBuffer> get(ByteBuffer key) {
 	 */
 	Flux<ByteBufferResponse<KeyCommand>> get(Publisher<KeyCommand> keys);
 
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @return {@link Mono#empty()} in case {@literal key} does not exist.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	default Mono<ByteBuffer> getDel(ByteBuffer key) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		return getDel(Mono.just(new KeyCommand(key))).next().filter(CommandResponse::isPresent)
+				.map(CommandResponse::getOutput);
+	}
+
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return {@link Flux} of {@link ByteBufferResponse} holding the {@literal key} to get along with the value
+	 *         retrieved.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	Flux<ByteBufferResponse<KeyCommand>> getDel(Publisher<KeyCommand> commands);
+
+	/**
+	 * {@link Command} for {@code GETEX}.
+	 *
+	 * @author Mark Paluch
+	 * @since 2.6
+	 */
+	class GetExCommand extends KeyCommand {
+
+		private final Expiration expiration;
+
+		private GetExCommand(@Nullable ByteBuffer key, Expiration expiration) {
+
+			super(key);
+
+			Assert.notNull(expiration, "Expiration must not be null!");
+			this.expiration = expiration;
+		}
+
+		/**
+		 * Creates a new {@link GetExCommand} given a {@code key}.
+		 *
+		 * @param key must not be {@literal null}.
+		 * @return a new {@link GetExCommand} for {@code key}.
+		 */
+		public static GetExCommand key(ByteBuffer key) {
+			return new GetExCommand(key, Expiration.persistent());
+		}
+
+		/**
+		 * Applies {@link Expiration}. Constructs a new command instance with all previously configured properties.
+		 *
+		 * @param options must not be {@literal null}.
+		 * @return a new {@link GetExCommand} with {@link Expiration} applied.
+		 */
+		public GetExCommand withExpiration(Expiration expiration) {
+			return new GetExCommand(getKey(), expiration);
+		}
+
+		/**
+		 * Get the {@link Expiration} to apply.
+		 *
+		 * @return never {@literal null}.
+		 */
+		public Expiration getExpiration() {
+			return expiration;
+		}
+	}
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param expiration must not be {@literal null}.
+	 * @return {@link Mono#empty()} in case {@literal key} does not exist.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	default Mono<ByteBuffer> getEx(ByteBuffer key, Expiration expiration) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		return getEx(Mono.just(GetExCommand.key(key).withExpiration(expiration))).next().filter(CommandResponse::isPresent)
+				.map(CommandResponse::getOutput);
+	}
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return {@link Flux} of {@link ByteBufferResponse} holding the {@literal key} to get along with the value
+	 *         retrieved.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	Flux<ByteBufferResponse<GetExCommand>> getEx(Publisher<GetExCommand> commands);
+
 	/**
 	 * Set {@literal value} for {@literal key} and return the existing value.
 	 *

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

@@ -45,6 +45,30 @@ enum BitOperation {
 	@Nullable
 	byte[] get(byte[] key);
 
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	byte[] getDel(byte[] key);
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param expiration must not be {@literal null}.
+	 * @param unit must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	byte[] getEx(byte[] key, Expiration expiration);
+
 	/**
 	 * Set {@code value} of {@code key} and return its old value.
 	 *
@@ -403,4 +427,5 @@ public static SetOption ifAbsent() {
 			return SET_IF_ABSENT;
 		}
 	}
+
 }

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

@@ -383,6 +383,29 @@ interface StringTuple extends Tuple {
 	 */
 	String get(String key);
 
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	String getDel(String key);
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param expiration must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	String getEx(String key, Expiration expiration);
+
 	/**
 	 * Set {@code value} of {@code key} and return its old value.
 	 *

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

@@ -35,6 +35,7 @@
 import org.springframework.data.redis.connection.lettuce.LettuceConverters;
 import org.springframework.data.redis.core.types.Expiration;
 import org.springframework.data.redis.util.ByteUtils;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -68,6 +69,41 @@ public byte[] get(byte[] key) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	 */
+	@Nullable
+	@Override
+	public byte[] getDel(byte[] key) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		try {
+			return connection.getCluster().getDel(key);
+		} catch (Exception ex) {
+			throw convertJedisAccessException(ex);
+		}
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getEx(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public byte[] getEx(byte[] key, Expiration expiration) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(expiration, "Expiration must not be null!");
+
+		try {
+			return connection.getCluster().getEx(key, JedisConverters.toGetExParams(expiration));
+		} catch (Exception ex) {
+			throw convertJedisAccessException(ex);
+		}
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisStringCommands#getSet(byte[], byte[])

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

@@ -23,6 +23,7 @@
 import redis.clients.jedis.ScanParams;
 import redis.clients.jedis.SortingParams;
 import redis.clients.jedis.params.GeoRadiusParam;
+import redis.clients.jedis.params.GetExParams;
 import redis.clients.jedis.params.SetParams;
 import redis.clients.jedis.params.ZAddParams;
 import redis.clients.jedis.util.SafeEncoder;
@@ -441,6 +442,34 @@ public static SetParams toSetCommandExPxArgument(Expiration expiration, SetParam
 		return params;
 	}
 
+	/**
+	 * Converts a given {@link Expiration} to the according {@code GETEX} command argument.
+	 * <dl>
+	 * <dt>{@link TimeUnit#MILLISECONDS}</dt>
+	 * <dd>{@code PX}</dd>
+	 * <dt>{@link TimeUnit#SECONDS}</dt>
+	 * <dd>{@code EX}</dd>
+	 * </dl>
+	 *
+	 * @param expiration must not be {@literal null}.
+	 * @return
+	 * @since 2.6
+	 */
+	static GetExParams toGetExParams(Expiration expiration) {
+
+		GetExParams params = new GetExParams();
+
+		if (expiration.isPersistent()) {
+			return params.persist();
+		}
+
+		if (expiration.getTimeUnit() == TimeUnit.MILLISECONDS) {
+			return params.px(expiration.getExpirationTime());
+		}
+
+		return params.ex((int) expiration.getExpirationTime());
+	}
+
 	/**
 	 * Converts a given {@link SetOption} to the according {@code SET} command argument.<br />
 	 * <dl>

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

@@ -57,6 +57,34 @@ public byte[] get(byte[] key) {
 		return connection.invoke().just(BinaryJedis::get, MultiKeyPipelineBase::get, key);
 	}
 
+	/*
+	* (non-Javadoc)
+	* @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	*/
+	@Nullable
+	@Override
+	public byte[] getDel(byte[] key) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		return connection.invoke().just(BinaryJedis::getDel, MultiKeyPipelineBase::getDel, key);
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getEx(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public byte[] getEx(byte[] key, Expiration expiration) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(expiration, "Expiration must not be null!");
+
+		return connection.invoke().just(BinaryJedis::getEx, MultiKeyPipelineBase::getEx, key,
+				JedisConverters.toGetExParams(expiration));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisStringCommands#getSet(byte[], byte[])