Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support decoding empty DataBuffers for Decoders that support it #29903

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+134 −4
Open

Support decoding empty DataBuffers for Decoders that support it #29903

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a40b549
Support decoding empty DataBuffers for Decoders that support it
spheenik Jan 30, 2023
dd06e77
fix checkstyle complaint
spheenik Jan 30, 2023
c808ba7
mark Decoders capable of decoding empty DataBuffers as such
spheenik Feb 6, 2023
4482ea1
add tests for Decoders that can decode empty DataBuffers
spheenik Feb 6, 2023
c29c515
fix checkstyle
spheenik Feb 6, 2023
a29f557
Fix failing test in spring-messaging
spheenik Feb 6, 2023
4ece71d
rename canDecodeEmptyDataBuffer to canDecodeEmptyMessage, to better r…
spheenik Feb 8, 2023
0d03e2c
improve testDecodeToMonoEmptyMessage() to use 2 empty source buffers,…
spheenik Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions spring-core/src/main/java/org/springframework/core/codec/Decoder.java
View file
Open in desktop
Expand Up @@ -53,6 +53,15 @@ public interface Decoder<T> {
*/
boolean canDecode(ResolvableType elementType, @Nullable MimeType mimeType);

/**
* Whether the decoder supports decoding messages from empty data buffers.
* @return {@code true} if supported, {@code false} otherwise
* @since 6.0.5
*/
default boolean canDecodeEmptyDataBuffer() {
return false;
}

/**
* Decode a {@link DataBuffer} input stream into a Flux of {@code T}.
* @param inputStream the {@code DataBuffer} input stream to decode
Expand Down
9 changes: 6 additions & 3 deletions .../springframework/messaging/handler/annotation/reactive/PayloadMethodArgumentResolver.java
View file
Open in desktop
Expand Up @@ -231,7 +231,7 @@ private Mono<Object> decodeContent(MethodParameter parameter, Message<?> message
if (decoder.canDecode(elementType, mimeType)) {
if (adapter != null && adapter.isMultiValue()) {
Flux<?> flux = content
.filter(this::nonEmptyDataBuffer)
.filter(dataBuffer -> nonEmptyDataBuffer(dataBuffer, decoder))
.map(buffer -> decoder.decode(buffer, elementType, mimeType, hints))
.onErrorResume(ex -> Flux.error(handleReadError(parameter, message, ex)));
if (isContentRequired) {
Expand All @@ -245,7 +245,7 @@ private Mono<Object> decodeContent(MethodParameter parameter, Message<?> message
else {
// Single-value (with or without reactive type wrapper)
Mono<?> mono = content.next()
.filter(this::nonEmptyDataBuffer)
.filter(dataBuffer -> nonEmptyDataBuffer(dataBuffer, decoder))
.map(buffer -> decoder.decode(buffer, elementType, mimeType, hints))
.onErrorResume(ex -> Mono.error(handleReadError(parameter, message, ex)));
if (isContentRequired) {
Expand All @@ -263,7 +263,10 @@ private Mono<Object> decodeContent(MethodParameter parameter, Message<?> message
message, parameter, "Cannot decode to [" + targetType + "]" + message));
}

private boolean nonEmptyDataBuffer(DataBuffer buffer) {
private boolean nonEmptyDataBuffer(DataBuffer buffer, Decoder<?> decoder) {
if (decoder.canDecodeEmptyDataBuffer()) {
return true;
}
if (buffer.readableByteCount() > 0) {
return true;
}
Expand Down
5 changes: 5 additions & 0 deletions spring-web/src/main/java/org/springframework/http/codec/protobuf/ProtobufDecoder.java
View file
Open in desktop
Expand Up @@ -125,6 +125,11 @@ public boolean canDecode(ResolvableType elementType, @Nullable MimeType mimeType
return Message.class.isAssignableFrom(elementType.toClass()) && supportsMimeType(mimeType);
}

@Override
public boolean canDecodeEmptyDataBuffer() {
return true;
}

@Override
public Flux<Message> decode(Publisher<DataBuffer> inputStream, ResolvableType elementType,
@Nullable MimeType mimeType, @Nullable Map<String, Object> hints) {
Expand Down