org.springframework.data.redis.core.DefaultReactiveHashOperations Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-redis Show documentation
Show all versions of spring-data-redis Show documentation
Spring Data module for Redis
/*
* Copyright 2017-2024 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.core;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import org.reactivestreams.Publisher;
import org.springframework.dao.InvalidDataAccessApiUsageException;
import org.springframework.data.redis.connection.ReactiveHashCommands;
import org.springframework.data.redis.connection.convert.Converters;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Default implementation of {@link ReactiveHashOperations}.
*
* @author Mark Paluch
* @author Christoph Strobl
* @author John Blum
* @since 2.0
*/
class DefaultReactiveHashOperations implements ReactiveHashOperations {
private final ReactiveRedisTemplate template;
private final RedisSerializationContext serializationContext;
DefaultReactiveHashOperations(ReactiveRedisTemplate template,
RedisSerializationContext serializationContext) {
this.template = template;
this.serializationContext = serializationContext;
}
@Override
@SuppressWarnings("unchecked")
public Mono remove(H key, Object... hashKeys) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKeys, "Hash keys must not be null");
Assert.notEmpty(hashKeys, "Hash keys must not be empty");
Assert.noNullElements(hashKeys, "Hash keys must not contain null elements");
return createMono(hashCommands -> Flux.fromArray(hashKeys) //
.map(hashKey -> (HK) hashKey)
.map(this::rawHashKey) //
.collectList() //
.flatMap(hks -> hashCommands.hDel(rawKey(key), hks)));
}
@Override
@SuppressWarnings("unchecked")
public Mono hasKey(H key, Object hashKey) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKey, "Hash key must not be null");
return createMono(hashCommands -> hashCommands.hExists(rawKey(key), rawHashKey((HK) hashKey)));
}
@Override
@SuppressWarnings("unchecked")
public Mono get(H key, Object hashKey) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKey, "Hash key must not be null");
return createMono(hashCommands -> hashCommands.hGet(rawKey(key), rawHashKey((HK) hashKey))
.map(this::readHashValue));
}
@Override
public Mono> multiGet(H key, Collection hashKeys) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKeys, "Hash keys must not be null");
Assert.notEmpty(hashKeys, "Hash keys must not be empty");
return createMono(hashCommands -> Flux.fromIterable(hashKeys) //
.map(this::rawHashKey) //
.collectList() //
.flatMap(hks -> hashCommands.hMGet(rawKey(key), hks)).map(this::deserializeHashValues));
}
@Override
public Mono increment(H key, HK hashKey, long delta) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKey, "Hash key must not be null");
return template.doCreateMono(connection -> connection.numberCommands()
.hIncrBy(rawKey(key), rawHashKey(hashKey), delta));
}
@Override
public Mono increment(H key, HK hashKey, double delta) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKey, "Hash key must not be null");
return template.doCreateMono(connection -> connection.numberCommands()
.hIncrBy(rawKey(key), rawHashKey(hashKey), delta));
}
@Override
public Mono randomKey(H key) {
Assert.notNull(key, "Key must not be null");
return template.doCreateMono(connection -> connection.hashCommands().hRandField(rawKey(key)))
.map(this::readRequiredHashKey);
}
@Override
public Mono> randomEntry(H key) {
Assert.notNull(key, "Key must not be null");
return createMono(hashCommands -> hashCommands.hRandFieldWithValues(rawKey(key)))
.map(this::deserializeHashEntry);
}
@Override
public Flux randomKeys(H key, long count) {
Assert.notNull(key, "Key must not be null");
return template.doCreateFlux(connection -> connection.hashCommands().hRandField(rawKey(key), count))
.map(this::readRequiredHashKey);
}
@Override
public Flux> randomEntries(H key, long count) {
Assert.notNull(key, "Key must not be null");
return template.doCreateFlux(connection -> connection.hashCommands().hRandFieldWithValues(rawKey(key), count))
.map(this::deserializeHashEntry);
}
@Override
public Flux keys(H key) {
Assert.notNull(key, "Key must not be null");
return createFlux(connection -> connection.hKeys(rawKey(key)) //
.map(this::readRequiredHashKey));
}
@Override
public Mono size(H key) {
Assert.notNull(key, "Key must not be null");
return createMono(hashCommands -> hashCommands.hLen(rawKey(key)));
}
@Override
public Mono putAll(H key, Map map) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(map, "Map must not be null");
return createMono(hashCommands -> Flux.fromIterable(() -> map.entrySet().iterator()) //
.collectMap(entry -> rawHashKey(entry.getKey()), entry -> rawHashValue(entry.getValue())) //
.flatMap(serialized -> hashCommands.hMSet(rawKey(key), serialized)));
}
@Override
public Mono put(H key, HK hashKey, HV value) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKey, "Hash key must not be null");
Assert.notNull(value, "Hash value must not be null");
return createMono(hashCommands -> hashCommands.hSet(rawKey(key), rawHashKey(hashKey), rawHashValue(value)));
}
@Override
public Mono putIfAbsent(H key, HK hashKey, HV value) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(hashKey, "Hash key must not be null");
Assert.notNull(value, "Hash value must not be null");
return createMono(hashCommands -> hashCommands.hSetNX(rawKey(key), rawHashKey(hashKey), rawHashValue(value)));
}
@Override
public Flux values(H key) {
Assert.notNull(key, "Key must not be null");
return createFlux(hashCommands -> hashCommands.hVals(rawKey(key)) //
.map(this::readRequiredHashValue));
}
@Override
public Flux> entries(H key) {
Assert.notNull(key, "Key must not be null");
return createFlux(hashCommands -> hashCommands.hGetAll(rawKey(key)) //
.map(this::deserializeHashEntry));
}
@Override
public Flux> scan(H key, ScanOptions options) {
Assert.notNull(key, "Key must not be null");
Assert.notNull(key, "ScanOptions must not be null");
return createFlux(hashCommands -> hashCommands.hScan(rawKey(key), options) //
.map(this::deserializeHashEntry));
}
@Override
public Mono delete(H key) {
Assert.notNull(key, "Key must not be null");
return template.doCreateMono(connection -> connection.keyCommands().del(rawKey(key))).map(l -> l != 0);
}
private Mono createMono(Function> function) {
Assert.notNull(function, "Function must not be null");
return template.doCreateMono(connection -> function.apply(connection.hashCommands()));
}
private Flux createFlux(Function> function) {
Assert.notNull(function, "Function must not be null");
return template.doCreateFlux(connection -> function.apply(connection.hashCommands()));
}
private ByteBuffer rawKey(H key) {
return serializationContext.getKeySerializationPair().write(key);
}
private ByteBuffer rawHashKey(HK key) {
return serializationContext.getHashKeySerializationPair().write(key);
}
private ByteBuffer rawHashValue(HV key) {
return serializationContext.getHashValueSerializationPair().write(key);
}
@SuppressWarnings("unchecked")
@Nullable
private HK readHashKey(ByteBuffer value) {
return (HK) serializationContext.getHashKeySerializationPair().read(value);
}
private HK readRequiredHashKey(ByteBuffer buffer) {
HK hashKey = readHashKey(buffer);
if (hashKey != null) {
return hashKey;
}
throw new InvalidDataAccessApiUsageException("Deserialized hash key is null");
}
@SuppressWarnings("unchecked")
@Nullable
private HV readHashValue(@Nullable ByteBuffer value) {
return value != null ? (HV) serializationContext.getHashValueSerializationPair().read(value) : null;
}
private HV readRequiredHashValue(ByteBuffer buffer) {
HV hashValue = readHashValue(buffer);
if (hashValue != null) {
return hashValue;
}
throw new InvalidDataAccessApiUsageException("Deserialized hash value is null");
}
private Map.Entry deserializeHashEntry(Map.Entry source) {
return Converters.entryOf(readHashKey(source.getKey()), readHashValue(source.getValue()));
}
private List deserializeHashValues(List source) {
List values = new ArrayList<>(source.size());
for (ByteBuffer byteBuffer : source) {
values.add(readHashValue(byteBuffer));
}
return values;
}
}