Skip to content

gh-36043 - configureMessageConvertersList #36049

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

Open
haydenrear wants to merge 2 commits into
base: main
Choose a base branch
from
+85 −0
Open

gh-36043 - configureMessageConvertersList #36049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7be318d
Closes gh-36043
haydenrear Dec 19, 2025
aeae7b9
Closes gh-36043
haydenrear Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions ...ng-web/src/main/java/org/springframework/http/converter/DefaultHttpMessageConverters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ abstract static class DefaultBuilder {

@Nullable Consumer<HttpMessageConverter<?>> configurer;

@Nullable Consumer<List<HttpMessageConverter<?>>> convertersListConfigurer;

@Nullable HttpMessageConverter<?> kotlinJsonConverter;

@Nullable HttpMessageConverter<?> jsonConverter;
Expand Down Expand Up @@ -226,6 +228,10 @@ void addMessageConverterConfigurer(Consumer<HttpMessageConverter<?>> configurer)
this.configurer = (this.configurer != null) ? configurer.andThen(this.configurer) : configurer;
}

void addMessageConvertersListConfigurer(Consumer<List<HttpMessageConverter<?>>> configurer) {
this.convertersListConfigurer = (this.convertersListConfigurer != null) ? convertersListConfigurer.andThen(this.convertersListConfigurer) : configurer;
}

List<HttpMessageConverter<?>> getBaseConverters() {
List<HttpMessageConverter<?>> converters = new ArrayList<>();
if (this.byteArrayConverter != null) {
Expand Down Expand Up @@ -442,6 +448,12 @@ public ClientBuilder configureMessageConverters(Consumer<HttpMessageConverter<?>
return this;
}

@Override
public ClientBuilder configureMessageConvertersList(Consumer<List<HttpMessageConverter<?>>> configurer) {
addMessageConvertersListConfigurer(configurer);
return this;
}

@Override
public HttpMessageConverters build() {
if (this.registerDefaults) {
Expand All @@ -466,6 +478,10 @@ public HttpMessageConverters build() {
if (this.configurer != null) {
allConverters.forEach(this.configurer);
}
if (this.convertersListConfigurer != null) {
this.convertersListConfigurer.accept(allConverters);
}

return new DefaultHttpMessageConverters(allConverters);
}
}
Expand Down Expand Up @@ -539,6 +555,12 @@ public ServerBuilder configureMessageConverters(Consumer<HttpMessageConverter<?>
return this;
}

@Override
public ServerBuilder configureMessageConvertersList(Consumer<List<HttpMessageConverter<?>>> configurer) {
addMessageConvertersListConfigurer(configurer);
return this;
}

@Override
public HttpMessageConverters build() {
if (this.registerDefaults) {
Expand Down Expand Up @@ -567,6 +589,10 @@ public HttpMessageConverters build() {
if (this.configurer != null) {
allConverters.forEach(this.configurer);
}
if (this.convertersListConfigurer != null) {
this.convertersListConfigurer.accept(allConverters);
}

return new DefaultHttpMessageConverters(allConverters);
}
}
Expand Down
7 changes: 7 additions & 0 deletions spring-web/src/main/java/org/springframework/http/converter/HttpMessageConverters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.http.converter;

import java.util.List;
import java.util.function.Consumer;

/**
Expand Down Expand Up @@ -172,6 +173,12 @@ interface Builder<T extends Builder<T>> {
*/
T configureMessageConverters(Consumer<HttpMessageConverter<?>> configurer);

/**
* Add a consumer for configuring the message converters list just before it's returned.
* @param configurer the configurer to use
*/
T configureMessageConvertersList(Consumer<List<HttpMessageConverter<?>>> configurer);

/**
* Build and return the {@link HttpMessageConverters} instance configured by this builder.
*/
Expand Down
52 changes: 52 additions & 0 deletions ...b/src/test/java/org/springframework/http/converter/DefaultHttpMessageConvertersTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
package org.springframework.http.converter;

import java.io.IOException;
import java.util.Comparator;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

import org.assertj.core.util.Lists;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
Expand Down Expand Up @@ -211,6 +213,31 @@ void shouldConfigureConverter() {
assertThat(customConverter.processed).isTrue();
}

@Test
void shouldConfigureConverterOrder() {
var customConverter = new CustomHttpMessageConverter();
var converted = HttpMessageConverters.forClient()
.addCustomConverter(customConverter)
.configureMessageConvertersList(converter -> {
converter.sort(Comparator.comparing(s -> s.getClass().equals(CustomHttpMessageConverter.class) ? 1 : -1));
}).build();

var messageConvertersBack = Lists.newArrayList(converted);
assertThat(messageConvertersBack.size()).isGreaterThan(1);
assertThat(messageConvertersBack.get(messageConvertersBack.size() - 1).getClass()).isEqualTo(CustomHttpMessageConverter.class);

var convertedFront = HttpMessageConverters.forClient()
.addCustomConverter(customConverter)
.configureMessageConvertersList(converter -> {
converter.sort(Comparator.comparing(s -> s.getClass().equals(CustomHttpMessageConverter.class) ? -1 : 1));
}).build();

var messageConvertersFront = Lists.newArrayList(convertedFront);
assertThat(messageConvertersFront.get(0).getClass()).isEqualTo(CustomHttpMessageConverter.class);
assertThat(messageConvertersFront.size()).isGreaterThan(1);

}

}


Expand Down Expand Up @@ -319,6 +346,31 @@ void shouldConfigureConverter() {

assertThat(customConverter.processed).isTrue();
}

@Test
void shouldConfigureConverterOrder() {
var customConverter = new CustomHttpMessageConverter();
var converted = HttpMessageConverters.forServer()
.addCustomConverter(customConverter)
.configureMessageConvertersList(converter -> {
converter.sort(Comparator.comparing(s -> s.getClass().equals(CustomHttpMessageConverter.class) ? 1 : -1));
}).build();

var messageConvertersBack = Lists.newArrayList(converted);
assertThat(messageConvertersBack.size()).isGreaterThan(1);
assertThat(messageConvertersBack.get(messageConvertersBack.size() - 1).getClass()).isEqualTo(CustomHttpMessageConverter.class);

var convertedFront = HttpMessageConverters.forServer()
.addCustomConverter(customConverter)
.configureMessageConvertersList(converter -> {
converter.sort(Comparator.comparing(s -> s.getClass().equals(CustomHttpMessageConverter.class) ? -1 : 1));
}).build();

var messageConvertersFront = Lists.newArrayList(convertedFront);
assertThat(messageConvertersFront.size()).isGreaterThan(1);
assertThat(messageConvertersFront.get(0).getClass()).isEqualTo(CustomHttpMessageConverter.class);

}
}

@SuppressWarnings("unchecked")
Expand Down