Spring/spring-data-redis
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refactor Redis secondary-index key formatting.

Browse Source 
Redis secondary-index keys are now formatted using helper methods instead of using chains of concatAll(toBytes(…)) sequences for more readability.

Original pull request: #2795
Closes: #2794
This commit is contained in:
Junghoon Ban
2024-09-10 09:35:14 +02:00
committed by Mark Paluch
parent 0f45851190
commit 803fd7101e
3 changed files with 67 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
src/main/java/org/springframework/data/redis/core/IndexWriter.java
View File

@@ -33,23 +33,26 @@ import org.springframework.util.ObjectUtils;
/**
* {@link IndexWriter} takes care of writing <a href="https://redis.io/topics/indexes">secondary index</a> structures to
* Redis. Depending on the type of {@link IndexedData} it uses eg. Sets with specific names to add actually referenced
* keys to. While doing so {@link IndexWriter} also keeps track of all indexes associated with the root types key, which
* Redis. Depending on the type of {@link IndexedData}, it uses Sets with specific names to add actually referenced keys
* to. While doing so {@link IndexWriter} also keeps track of all indexes associated with the root types key, which
* allows to remove the root key from all indexes in case of deletion.
*
* @author Christoph Strobl
* @author Rob Winch
* @author Mark Paluch
* @since 1.7
*/
class IndexWriter {
private static final byte[] SEPARATOR = ":".getBytes();
private static final byte[] IDX = "idx".getBytes();
private final RedisConnection connection;
private final RedisConverter converter;
/**
* Creates new {@link IndexWriter}.
*
* @param keyspace The key space to write index values to. Must not be {@literal null}.
* @param connection must not be {@literal null}.
* @param converter must not be {@literal null}.
*/
@@ -127,7 +130,7 @@ class IndexWriter {
Assert.notNull(key, "Key must not be null");
byte[] binKey = toBytes(key);
byte[] indexHelperKey = ByteUtils.concatAll(toBytes(keyspace + ":"), binKey, toBytes(":idx"));
byte[] indexHelperKey = createIndexKey(keyspace, binKey);
for (byte[] indexKey : connection.sMembers(indexHelperKey)) {
@@ -147,10 +150,10 @@ class IndexWriter {
*/
public void removeAllIndexes(String keyspace) {
Set<byte[]> potentialIndex = connection.keys(toBytes(keyspace + ":*"));
Set<byte[]> potentialIndex = connection.keys(createIndexKey(keyspace, "*"));
if (!potentialIndex.isEmpty()) {
connection.del(potentialIndex.toArray(new byte[potentialIndex.size()][]));
connection.del(potentialIndex.toArray(new byte[0][]));
}
}
@@ -162,7 +165,7 @@ class IndexWriter {
}
/**
* Remove given key from all indexes matching {@link IndexedData#getIndexName()}:
* Remove given key from all indexes matching {@link IndexedData#getIndexName()}.
*
* @param key
* @param indexedData
@@ -171,8 +174,7 @@ class IndexWriter {
Assert.notNull(indexedData, "IndexedData must not be null");
Set<byte[]> existingKeys = connection
.keys(toBytes(indexedData.getKeyspace() + ":" + indexedData.getIndexName() + ":*"));
Set<byte[]> existingKeys = connection.keys(createIndexKey(indexedData.getKeyPrefix(), "*"));
if (!CollectionUtils.isEmpty(existingKeys)) {
for (byte[] existingKey : existingKeys) {
@@ -216,12 +218,12 @@ class IndexWriter {
return;
}
byte[] indexKey = toBytes(indexedData.getKeyspace() + ":" + indexedData.getIndexName() + ":");
byte[] indexKey = toBytes(indexedData.getKeyPrefix(), SEPARATOR);
indexKey = ByteUtils.concat(indexKey, toBytes(value));
connection.sAdd(indexKey, key);
// keep track of indexes used for the object
connection.sAdd(ByteUtils.concatAll(toBytes(indexedData.getKeyspace() + ":"), key, toBytes(":idx")), indexKey);
connection.sAdd(createIndexKey(indexedData.getKeyspace(), key), indexKey);
} else if (indexedData instanceof GeoIndexedPropertyValue propertyValue) {
Object value = propertyValue.getValue();
@@ -229,17 +231,53 @@ class IndexWriter {
return;
}
byte[] indexKey = toBytes(indexedData.getKeyspace() + ":" + indexedData.getIndexName());
byte[] indexKey = toBytes(indexedData.getKeyPrefix());
connection.geoAdd(indexKey, propertyValue.getPoint(), key);
// keep track of indexes used for the object
connection.sAdd(ByteUtils.concatAll(toBytes(indexedData.getKeyspace() + ":"), key, toBytes(":idx")), indexKey);
connection.sAdd(createIndexKey(indexedData.getKeyspace(), key), indexKey);
} else {
throw new IllegalArgumentException(
String.format("Cannot write index data for unknown index type %s", indexedData.getClass()));
}
}
private byte[] createIndexKey(String keyspace, byte[] key) {
return createIndexKey(keyspace, key, IDX);
}
private byte[] createIndexKey(Object... items) {
Object[] elements = new Object[items.length + (items.length - 1)];
int j = 0;
for (int i = 0; i < items.length; i++) {
elements[j++] = items[i];
if (items.length - 1 > i) {
elements[j++] = SEPARATOR;
}
}
return toBytes(elements);
}
private byte[] toBytes(Object... values) {
byte[][] arrays = new byte[values.length][];
for (int i = 0; i < values.length; i++) {
if (values[i] instanceof byte[] bb) {
arrays[i] = bb;
} else {
arrays[i] = toBytes(values[i]);
}
}
return ByteUtils.concatAll(arrays);
}
private byte[] toBytes(@Nullable Object source) {
if (source == null) {

15
src/main/java/org/springframework/data/redis/core/RedisQueryEngine.java
View File

@@ -25,6 +25,7 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
import org.springframework.core.convert.ConversionService;
import org.springframework.data.geo.Circle;
import org.springframework.data.geo.GeoResult;
import org.springframework.data.geo.GeoResults;
@@ -81,8 +82,8 @@ class RedisQueryEngine extends QueryEngine<RedisKeyValueAdapter, RedisOperationC
@Override
@SuppressWarnings("unchecked")
public <T> List<T> execute(RedisOperationChain criteria, Comparator<?> sort, long offset, int rows,
String keyspace, Class<T> type) {
public <T> List<T> execute(RedisOperationChain criteria, Comparator<?> sort, long offset, int rows, String keyspace,
Class<T> type) {
List<T> result = doFind(criteria, offset, rows, keyspace, type);
if (sort != null) {
@@ -199,8 +200,7 @@ class RedisQueryEngine extends QueryEngine<RedisKeyValueAdapter, RedisOperationC
}
@Override
public List<?> execute(RedisOperationChain criteria, Comparator<?> sort, long offset, int rows,
String keyspace) {
public List<?> execute(RedisOperationChain criteria, Comparator<?> sort, long offset, int rows, String keyspace) {
return execute(criteria, sort, offset, rows, keyspace, Object.class);
}
@@ -229,14 +229,13 @@ class RedisQueryEngine extends QueryEngine<RedisKeyValueAdapter, RedisOperationC
private byte[][] keys(String prefix, Collection<PathAndValue> source) {
ConversionService conversionService = getRequiredAdapter().getConverter().getConversionService();
byte[][] keys = new byte[source.size()][];
int i = 0;
for (PathAndValue pathAndValue : source) {
byte[] convertedValue = getRequiredAdapter().getConverter().getConversionService()
.convert(pathAndValue.getFirstValue(), byte[].class);
byte[] fullPath = getRequiredAdapter().getConverter().getConversionService()
.convert(prefix + pathAndValue.getPath() + ":", byte[].class);
byte[] convertedValue = conversionService.convert(pathAndValue.getFirstValue(), byte[].class);
byte[] fullPath = conversionService.convert(prefix + pathAndValue.getPath() + ":", byte[].class);
keys[i] = ByteUtils.concat(fullPath, convertedValue);
i++;

9
src/main/java/org/springframework/data/redis/core/convert/IndexedData.java
View File

@@ -38,4 +38,13 @@ public interface IndexedData {
*/
String getKeyspace();
/**
* Return the key prefix for usage in Redis.
*
* @return concatenated form of the keyspace and the index name.
* @since 3.3.4
*/
default String getKeyPrefix() {
return getKeyspace() + ":" + getIndexName();
}
}