Add support for ZMSCORE through score(key, values).

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

Closes #2038

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`, `COPY`).
+* Support Redis 6.2 commands (`LPOP`/`RPOP` with `count`, `COPY`, `ZMSCORE`).
 
 [[new-in-2.5.0]]
 == New in Spring Data Redis 2.5

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

@@ -1682,6 +1682,15 @@ public Double zScore(byte[] key, byte[] value) {
 		return convertAndReturn(delegate.zScore(key, value), Converters.identityConverter());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zMScore(byte[], byte[][])
+	 */
+	@Override
+	public List<Double> zMScore(byte[] key, byte[]... values) {
+		return convertAndReturn(delegate.zMScore(key, values), Converters.identityConverter());
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zUnionStore(byte[], org.springframework.data.redis.connection.RedisZSetCommands.Aggregate, org.springframework.data.redis.connection.RedisZSetCommands.Weights, byte[][])
@@ -3012,6 +3021,15 @@ public Double zScore(String key, String value) {
 		return zScore(serialize(key), serialize(value));
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#zMScore(java.lang.String, java.lang.String[])
+	 */
+	@Override
+	public List<Double> zMScore(String key, String... values) {
+		return zMScore(serialize(key), serializeMulti(values));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.StringRedisConnection#zUnionStore(java.lang.String, org.springframework.data.redis.connection.RedisZSetCommands.Aggregate, int[], java.lang.String[])

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

@@ -1089,6 +1089,13 @@ default Double zScore(byte[] key, byte[] value) {
 		return zSetCommands().zScore(key, value);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#zSetCommands()}}. */
+	@Override
+	@Deprecated
+	default List<Double> zMScore(byte[] key, byte[]... values) {
+		return zSetCommands().zMScore(key, values);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#zSetCommands()}}. */
 	@Override
 	@Deprecated

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

@@ -31,6 +31,7 @@
 import org.springframework.data.redis.connection.ReactiveRedisConnection.CommandResponse;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyScanCommand;
+import org.springframework.data.redis.connection.ReactiveRedisConnection.MultiValueResponse;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
 import org.springframework.data.redis.connection.RedisZSetCommands.Aggregate;
 import org.springframework.data.redis.connection.RedisZSetCommands.Limit;
@@ -292,7 +293,7 @@ private ZRemCommand(@Nullable ByteBuffer key, List<ByteBuffer> values) {
 		 * Creates a new {@link ZRemCommand} given a {@link Tuple}.
 		 *
 		 * @param value must not be {@literal null}.
-		 * @return a new {@link ZAddCommand} for {@link Tuple}.
+		 * @return a new {@link ZRemCommand} for {@link Tuple}.
 		 */
 		public static ZRemCommand values(ByteBuffer value) {
 
@@ -305,7 +306,7 @@ public static ZRemCommand values(ByteBuffer value) {
 		 * Creates a new {@link ZRemCommand} given a {@link Collection} of {@link Tuple}.
 		 *
 		 * @param values must not be {@literal null}.
-		 * @return a new {@link ZAddCommand} for {@link Tuple}.
+		 * @return a new {@link ZRemCommand} for {@link Tuple}.
 		 */
 		public static ZRemCommand values(Collection<ByteBuffer> values) {
 
@@ -1283,7 +1284,7 @@ private ZScoreCommand(@Nullable ByteBuffer key, ByteBuffer value) {
 		 * Creates a new {@link ZScoreCommand} given a {@link ByteBuffer member}.
 		 *
 		 * @param member must not be {@literal null}.
-		 * @return a new {@link ZScoreCommand} for {@link Range}.
+		 * @return a new {@link ZScoreCommand} for {@link ByteBuffer member}.
 		 */
 		public static ZScoreCommand scoreOf(ByteBuffer member) {
 
@@ -1339,6 +1340,99 @@ default Mono<Double> zScore(ByteBuffer key, ByteBuffer value) {
 	 */
 	Flux<NumericResponse<ZScoreCommand, Double>> zScore(Publisher<ZScoreCommand> commands);
 
+	/**
+	 * {@code ZMSCORE} command parameters.
+	 *
+	 * @author Mark Paluch
+	 * @see <a href="https://redis.io/commands/zmscore">Redis Documentation: ZMSCORE</a>
+	 * @since 2.6
+	 */
+	class ZMScoreCommand extends KeyCommand {
+
+		private final Collection<ByteBuffer> values;
+
+		private ZMScoreCommand(@Nullable ByteBuffer key, Collection<ByteBuffer> values) {
+
+			super(key);
+
+			this.values = values;
+		}
+
+		/**
+		 * Creates a new {@link ZMScoreCommand} given a {@link ByteBuffer member}.
+		 *
+		 * @param member must not be {@literal null}.
+		 * @return a new {@link ZMScoreCommand} for {@link ByteBuffer}.
+		 */
+		public static ZMScoreCommand scoreOf(ByteBuffer member) {
+
+			Assert.notNull(member, "Member must not be null!");
+
+			return new ZMScoreCommand(null, Collections.singletonList(member));
+		}
+
+		/**
+		 * Creates a new {@link ZMScoreCommand} given a {@link List members}.
+		 *
+		 * @param member must not be {@literal null}.
+		 * @return a new {@link ZMScoreCommand} for {@link List} of members.
+		 */
+		public static ZMScoreCommand scoreOf(Collection<ByteBuffer> members) {
+
+			Assert.notNull(members, "Members must not be null!");
+
+			return new ZMScoreCommand(null, members);
+		}
+
+		/**
+		 * Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
+		 *
+		 * @param key must not be {@literal null}.
+		 * @return a new {@link ZMScoreCommand} with {@literal key} applied.
+		 */
+		public ZMScoreCommand forKey(ByteBuffer key) {
+
+			Assert.notNull(key, "Key must not be null!");
+
+			return new ZMScoreCommand(key, values);
+		}
+
+		/**
+		 * @return
+		 */
+		public Collection<ByteBuffer> getValues() {
+			return values;
+		}
+	}
+
+	/**
+	 * Get the scores of elements with {@literal values} from sorted set with key {@literal key}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param values must not be {@literal null}.
+	 * @return
+	 * @see <a href="https://redis.io/commands/zmscore">Redis Documentation: ZMSCORE</a>
+	 * @since 2.6
+	 */
+	default Mono<List<Double>> zMScore(ByteBuffer key, Collection<ByteBuffer> values) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(values, "Values must not be null!");
+
+		return zMScore(Mono.just(ZMScoreCommand.scoreOf(values).forKey(key))).next().map(MultiValueResponse::getOutput);
+	}
+
+	/**
+	 * Get the scores of elements with {@link ZMScoreCommand#getValues()} from sorted set with key
+	 * {@link ZMScoreCommand#getKey()}
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return
+	 * @see <a href="https://redis.io/commands/zmscore">Redis Documentation: ZMSCORE</a>
+	 * @since 2.6
+	 */
+	Flux<MultiValueResponse<ZMScoreCommand, Double>> zMScore(Publisher<ZMScoreCommand> commands);
+
 	/**
 	 * {@code ZREMRANGEBYRANK} command parameters.
 	 *
@@ -1787,7 +1881,7 @@ private ZInterStoreCommand(ByteBuffer key, List<ByteBuffer> sourceKeys, List<Dou
 		 * Creates a new {@link ZInterStoreCommand} given a {@link List} of keys.
 		 *
 		 * @param keys must not be {@literal null}.
-		 * @return a new {@link ZInterStoreCommand} for {@link Range}.
+		 * @return a new {@link ZInterStoreCommand} for {@link List} of keys.
 		 */
 		public static ZInterStoreCommand sets(List<ByteBuffer> keys) {
 

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

@@ -993,6 +993,18 @@ default Long zCount(byte[] key, double min, double max) {
 	@Nullable
 	Double zScore(byte[] key, byte[] value);
 
+	/**
+	 * Get the scores of elements with {@code values} from sorted set with key {@code key}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param values the values.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/zmscore">Redis Documentation: ZMSCORE</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	List<Double> zMScore(byte[] key, byte[]... values);
+
 	/**
 	 * Remove elements in range between {@code start} and {@code end} from sorted set with {@code key}.
 	 *

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

@@ -1432,6 +1432,18 @@ default Long lPos(String key, String element) {
 	 */
 	Double zScore(String key, String value);
 
+	/**
+	 * Get the scores of elements with {@code values} from sorted set with key {@code key}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param values the values.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/zmscore">Redis Documentation: ZMSCORE</a>
+	 * @see RedisZSetCommands#zMScore(byte[], byte[][])
+	 * @since 2.6
+	 */
+	List<Double> zMScore(String key, String... values);
+
 	/**
 	 * Remove elements in range between {@code start} and {@code end} from sorted set with {@code key}.
 	 *

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

@@ -18,6 +18,7 @@
 import redis.clients.jedis.ScanParams;
 import redis.clients.jedis.ZParams;
 
+import java.util.List;
 import java.util.Set;
 
 import org.springframework.dao.DataAccessException;
@@ -637,6 +638,23 @@ public Double zScore(byte[] key, byte[] value) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zMScore(byte[], byte[][])
+	 */
+	@Override
+	public List<Double> zMScore(byte[] key, byte[][] values) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(values, "Values must not be null!");
+
+		try {
+			return connection.getCluster().zmscore(key, values);
+		} catch (Exception ex) {
+			throw convertJedisAccessException(ex);
+		}
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zRemRange(byte[], long, long)

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

@@ -21,14 +21,13 @@
 import redis.clients.jedis.ScanParams;
 import redis.clients.jedis.ScanResult;
 import redis.clients.jedis.ZParams;
-import redis.clients.jedis.params.ZAddParams;
 
 import java.nio.charset.StandardCharsets;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Set;
 
 import org.springframework.data.redis.connection.RedisZSetCommands;
-import org.springframework.data.redis.connection.RedisZSetCommands.ZAddArgs.Flag;
 import org.springframework.data.redis.core.Cursor;
 import org.springframework.data.redis.core.KeyBoundCursor;
 import org.springframework.data.redis.core.ScanIteration;
@@ -323,6 +322,19 @@ public Double zScore(byte[] key, byte[] value) {
 		return connection.invoke().just(BinaryJedis::zscore, MultiKeyPipelineBase::zscore, key, value);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zScore(byte[], byte[][])
+	 */
+	@Override
+	public List<Double> zMScore(byte[] key, byte[][] values) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(values, "Value must not be null!");
+
+		return connection.invoke().just(BinaryJedis::zmscore, MultiKeyPipelineBase::zmscore, key, values);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zRemRange(byte[], long, long)

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

@@ -1209,6 +1209,9 @@ static class TypeHints {
 			COMMAND_OUTPUT_TYPE_MAPPING.put(ZINCRBY, DoubleOutput.class);
 			COMMAND_OUTPUT_TYPE_MAPPING.put(ZSCORE, DoubleOutput.class);
 
+			// DOUBLE LIST
+			COMMAND_OUTPUT_TYPE_MAPPING.put(ZMSCORE, DoubleListOutput.class);
+
 			// MAP
 			COMMAND_OUTPUT_TYPE_MAPPING.put(HGETALL, MapOutput.class);
 
@@ -1281,6 +1284,7 @@ static class TypeHints {
 			COMMAND_OUTPUT_TYPE_MAPPING.put(HSET, BooleanOutput.class);
 			COMMAND_OUTPUT_TYPE_MAPPING.put(HSETNX, BooleanOutput.class);
 			COMMAND_OUTPUT_TYPE_MAPPING.put(MOVE, BooleanOutput.class);
+			COMMAND_OUTPUT_TYPE_MAPPING.put(COPY, BooleanOutput.class);
 			COMMAND_OUTPUT_TYPE_MAPPING.put(MSETNX, BooleanOutput.class);
 			COMMAND_OUTPUT_TYPE_MAPPING.put(PERSIST, BooleanOutput.class);
 			COMMAND_OUTPUT_TYPE_MAPPING.put(PEXPIRE, BooleanOutput.class);

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

@@ -27,11 +27,13 @@
 import java.util.List;
 
 import org.reactivestreams.Publisher;
+
 import org.springframework.data.domain.Sort.Direction;
 import org.springframework.data.redis.connection.DefaultTuple;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.CommandResponse;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyScanCommand;
+import org.springframework.data.redis.connection.ReactiveRedisConnection.MultiValueResponse;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
 import org.springframework.data.redis.connection.ReactiveZSetCommands;
 import org.springframework.data.redis.connection.RedisZSetCommands.Aggregate;
@@ -381,6 +383,23 @@ public Flux<NumericResponse<ZScoreCommand, Double>> zScore(Publisher<ZScoreComma
 		}));
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.ReactiveZSetCommands#zMScore(org.reactivestreams.Publisher)
+	 */
+	@Override
+	public Flux<MultiValueResponse<ZMScoreCommand, Double>> zMScore(Publisher<ZMScoreCommand> commands) {
+
+		return connection.execute(cmd -> Flux.from(commands).concatMap(command -> {
+
+			Assert.notNull(command.getKey(), "Key must not be null!");
+			Assert.notNull(command.getValues(), "Values must not be null!");
+
+			return cmd.zmscore(command.getKey(), command.getValues().toArray(new ByteBuffer[0]))
+					.map(value -> new MultiValueResponse<>(command, value));
+		}));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.ReactiveZSetCommands#zRemRangeByRank(org.reactivestreams.Publisher)

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

@@ -302,6 +302,19 @@ public Double zScore(byte[] key, byte[] value) {
 		return connection.invoke().just(RedisSortedSetAsyncCommands::zscore, key, value);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zMScore(byte[], byte[][])
+	 */
+	@Override
+	public List<Double> zMScore(byte[] key, byte[][] values) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(values, "Value must not be null!");
+
+		return connection.invoke().just(RedisSortedSetAsyncCommands::zmscore, key, values);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zRemRange(byte[], long, long)