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

DATAREDIS-1122 - Add support for MAXLEN attribute of XADD.

Browse Source 
Original pull request: #523.
This commit is contained in:
Christoph Strobl
2020-04-08 11:12:48 +02:00
committed by Mark Paluch
parent 3568f300f6
commit 43ef4700c1
10 changed files with 199 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/main/java/org/springframework/data/redis/connection/DefaultStringRedisConnection.java
View File

@@ -3644,11 +3644,11 @@ public class DefaultStringRedisConnection implements StringRedisConnection, Deco
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.StringRedisConnection#xAdd(StringRecord)
* @see org.springframework.data.redis.connection.StringRedisConnection#xAdd(StringRecord, XAddOptions)
*/
@Override
public RecordId xAdd(StringRecord record) {
return convertAndReturn(delegate.xAdd(record.serialize(serializer)), identityConverter);
public RecordId xAdd(StringRecord record, XAddOptions options) {
return convertAndReturn(delegate.xAdd(record.serialize(serializer), options), identityConverter);
}
/*
@@ -3814,11 +3814,11 @@ public class DefaultStringRedisConnection implements StringRedisConnection, Deco
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisStreamCommands#xAdd(byte[], MapRecord)
* @see org.springframework.data.redis.connection.RedisStreamCommands#xAdd(MapRecord, XAddOptions)
*/
@Override
public RecordId xAdd(MapRecord<byte[], byte[], byte[]> record) {
return delegate.xAdd(record);
public RecordId xAdd(MapRecord<byte[], byte[], byte[]> record, XAddOptions options) {
return delegate.xAdd(record, options);
}
/*

4
src/main/java/org/springframework/data/redis/connection/DefaultedRedisConnection.java
View File

@@ -449,8 +449,8 @@ public interface DefaultedRedisConnection extends RedisConnection {
/** @deprecated in favor of {@link RedisConnection#streamCommands()}}. */
@Override
@Deprecated
default RecordId xAdd(MapRecord<byte[], byte[], byte[]> record) {
return streamCommands().xAdd(record);
default RecordId xAdd(MapRecord<byte[], byte[], byte[]> record, XAddOptions options) {
return streamCommands().xAdd(record, options);
}
/** @deprecated in favor of {@link RedisConnection#streamCommands()}}. */

36
src/main/java/org/springframework/data/redis/connection/ReactiveStreamCommands.java
View File

@@ -193,11 +193,13 @@ public interface ReactiveStreamCommands {
class AddStreamRecord extends KeyCommand {
private final ByteBufferRecord record;
private final @Nullable Long maxlen;
private AddStreamRecord(ByteBufferRecord record) {
private AddStreamRecord(ByteBufferRecord record, @Nullable Long maxlen) {
super(record.getStream());
this.record = record;
this.maxlen = maxlen;
}
/**
@@ -210,7 +212,7 @@ public interface ReactiveStreamCommands {
Assert.notNull(record, "Record must not be null!");
return new AddStreamRecord(record);
return new AddStreamRecord(record, null);
}
/**
@@ -223,7 +225,7 @@ public interface ReactiveStreamCommands {
Assert.notNull(body, "Body must not be null!");
return new AddStreamRecord(StreamRecords.rawBuffer(body));
return new AddStreamRecord(StreamRecords.rawBuffer(body), null);
}
/**
@@ -233,7 +235,16 @@ public interface ReactiveStreamCommands {
* @return a new {@link ReactiveGeoCommands.GeoAddCommand} with {@literal key} applied.
*/
public AddStreamRecord to(ByteBuffer key) {
return new AddStreamRecord(record.withStreamKey(key));
return new AddStreamRecord(record.withStreamKey(key), maxlen);
}
/**
* Limit the size of the stream to the given maximum number of elements.
*
* @return new instance of {@link AddStreamRecord}.
*/
public AddStreamRecord maxlen(long maxlen) {
return new AddStreamRecord(record, maxlen);
}
/**
@@ -246,6 +257,23 @@ public interface ReactiveStreamCommands {
public ByteBufferRecord getRecord() {
return record;
}
/**
* Limit the size of the stream to the given maximum number of elements.
*
* @return can be {@literal null}.
*/
@Nullable
public Long getMaxlen() {
return maxlen;
}
/**
* @return {@literal true} if {@literal MAXLEN} is set.
*/
public boolean hasMaxLen() {
return maxlen != null && maxlen > 0;
}
}
/**

84
src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java
View File

@@ -28,6 +28,7 @@ import org.springframework.data.redis.connection.RedisZSetCommands.Limit;
import org.springframework.data.redis.connection.stream.*;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
/**
@@ -87,7 +88,88 @@ public interface RedisStreamCommands {
* @param record the {@link MapRecord record} to append.
* @return the {@link RecordId id} after save. {@literal null} when used in pipeline / transaction.
*/
RecordId xAdd(MapRecord<byte[], byte[], byte[]> record);
default RecordId xAdd(MapRecord<byte[], byte[], byte[]> record) {
return xAdd(record, XAddOptions.none());
}
/**
* Append the given {@link MapRecord record} to the stream stored at {@link Record#getStream()}. <br />
* If you prefer manual id assignment over server generated ones make sure to provide an id via
* {@link Record#withId(RecordId)}.
*
* @param record the {@link MapRecord record} to append.
* @param options additional options (eg. {@literal MAXLEN}). Must not be {@literal null}, use
* {@link XAddOptions#none()} instead.
* @return the {@link RecordId id} after save. {@literal null} when used in pipeline / transaction.
* @since 2.3
*/
RecordId xAdd(MapRecord<byte[], byte[], byte[]> record, XAddOptions options);
/**
* Additional options applicable for {@literal XADD} command.
*
* @author Christoph Strobl
* @since 2.3
*/
class XAddOptions {
private @Nullable Long maxlen;
private XAddOptions(@Nullable Long maxlen) {
this.maxlen = maxlen;
}
/**
* @return
*/
public static XAddOptions none() {
return new XAddOptions(null);
}
/**
* Limit the size of the stream to the given maximum number of elements.
*
* @return new instance of {@link XAddOptions}.
*/
public static XAddOptions maxlen(long maxlen) {
return new XAddOptions(maxlen);
}
/**
* Limit the size of the stream to the given maximum number of elements.
*
* @return can be {@literal null}.
*/
@Nullable
public Long getMaxlen() {
return maxlen;
}
/**
* @return {@literal true} if {@literal MAXLEN} is set.
*/
public boolean hasMaxLen() {
return maxlen != null && maxlen > 0;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
XAddOptions that = (XAddOptions) o;
return ObjectUtils.nullSafeEquals(this.maxlen, that.maxlen);
}
@Override
public int hashCode() {
return ObjectUtils.nullSafeHashCode(this.maxlen);
}
}
/**
* Change the ownership of a pending message to the given new {@literal consumer} without increasing the delivered

23
src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java
View File

@@ -2010,7 +2010,28 @@ public interface StringRedisConnection extends RedisConnection {
return xAdd(StreamRecords.newRecord().in(key).ofStrings(body));
}
RecordId xAdd(StringRecord record);
/**
* Append the given {@link StringRecord} to the stream stored at {@link StringRecord#getStream()}.
*
* @param record must not be {@literal null}.
* @return the record Id. {@literal null} when used in pipeline / transaction.
* @since 2.2
*/
@Nullable
default RecordId xAdd(StringRecord record) {
return xAdd(record, XAddOptions.none());
}
/**
* Append the given {@link StringRecord} to the stream stored at {@link StringRecord#getStream()}.
*
* @param record must not be {@literal null}.
* @param options must not be {@literal null}, use {@link XAddOptions#none()} instead.
* @return the record Id. {@literal null} when used in pipeline / transaction.
* @since 2.3
*/
@Nullable
RecordId xAdd(StringRecord record, XAddOptions options);
/**
* Change the ownership of a pending message to the given new {@literal consumer} without increasing the delivered

3
src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveStreamCommands.java
View File

@@ -100,6 +100,9 @@ class LettuceReactiveStreamCommands implements ReactiveStreamCommands {
if (!command.getRecord().getId().shouldBeAutoGenerated()) {
args.id(command.getRecord().getId().getValue());
}
if(command.hasMaxLen()) {
args.maxlen(command.getMaxlen());
}
return cmd.xadd(command.getKey(), args, command.getBody())
.map(value -> new CommandResponse<>(command, RecordId.of(value)));

7
src/main/java/org/springframework/data/redis/connection/lettuce/LettuceStreamCommands.java
View File

@@ -81,16 +81,19 @@ class LettuceStreamCommands implements RedisStreamCommands {
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisStreamCommands#xAdd(byte[], MapRecord)
* @see org.springframework.data.redis.connection.RedisStreamCommands#xAdd(byte[], MapRecord, XAddOptions)
*/
@Override
public RecordId xAdd(MapRecord<byte[], byte[], byte[]> record) {
public RecordId xAdd(MapRecord<byte[], byte[], byte[]> record, XAddOptions options) {
Assert.notNull(record.getStream(), "Stream must not be null!");
Assert.notNull(record, "Record must not be null!");
XAddArgs args = new XAddArgs();
args.id(record.getId().getValue());
if(options.hasMaxLen()) {
args.maxlen(options.getMaxlen());
}
try {
if (isPipelined()) {