Skip to content

Add configuration property for preferred json mapper in webflux #47419

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+297 −75
Open

Add configuration property for preferred json mapper in webflux #47419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions module/spring-boot-http-codec/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ dependencies {

optional(project(":core:spring-boot-autoconfigure"))
optional(project(":core:spring-boot-test"))
optional(project(":module:spring-boot-gson"))
optional(project(":module:spring-boot-jackson"))
optional(project(":module:spring-boot-kotlin-serialization"))
optional("org.springframework:spring-webflux")

testImplementation(project(":core:spring-boot-test"))
Expand Down
57 changes: 53 additions & 4 deletions .../main/java/org/springframework/boot/http/codec/autoconfigure/CodecsAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,17 @@

package org.springframework.boot.http.codec.autoconfigure;

import com.google.gson.Gson;
import kotlinx.serialization.Serializable;
import kotlinx.serialization.json.Json;
import org.jspecify.annotations.Nullable;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.json.JsonMapper;

import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.context.properties.PropertyMapper;
import org.springframework.boot.http.codec.CodecCustomizer;
Expand All @@ -32,8 +35,13 @@
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.codec.CodecConfigurer;
import org.springframework.http.codec.CodecConfigurer.CustomCodecs;
import org.springframework.http.codec.json.GsonDecoder;
import org.springframework.http.codec.json.GsonEncoder;
import org.springframework.http.codec.json.JacksonJsonDecoder;
import org.springframework.http.codec.json.JacksonJsonEncoder;
import org.springframework.http.codec.json.KotlinSerializationJsonDecoder;
import org.springframework.http.codec.json.KotlinSerializationJsonEncoder;
import org.springframework.util.unit.DataSize;
import org.springframework.web.reactive.function.client.WebClient;

Expand All @@ -43,19 +51,25 @@
* {@link org.springframework.core.codec.Decoder Decoders}.
*
* @author Brian Clozel
* @author Vasily Pelikh
* @since 2.0.0
*/
@AutoConfiguration(afterName = "org.springframework.boot.jackson.autoconfigure.JacksonAutoConfiguration")
@AutoConfiguration(afterName = { "org.springframework.boot.jackson.autoconfigure.JacksonAutoConfiguration",
"org.springframework.boot.gson.autoconfigure.GsonAutoConfiguration",
"org.springframework.boot.kotlin.serialization.autoconfigure.KotlinSerializationAutoConfiguration" })
@ConditionalOnClass({ CodecConfigurer.class, WebClient.class })
public final class CodecsAutoConfiguration {

private static final String PREFERRED_MAPPER_PROPERTY = "spring.http.codecs.preferred-json-mapper";

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ObjectMapper.class)
@ConditionalOnClass(JsonMapper.class)
@ConditionalOnBean(JsonMapper.class)
@ConditionalOnProperty(name = PREFERRED_MAPPER_PROPERTY, havingValue = "jackson", matchIfMissing = true)
static class JacksonJsonCodecConfiguration {

@Bean
@Order(0)
@ConditionalOnBean(JsonMapper.class)
CodecCustomizer jacksonCodecCustomizer(JsonMapper jsonMapper) {
return (configurer) -> {
CodecConfigurer.DefaultCodecs defaults = configurer.defaultCodecs();
Expand All @@ -66,6 +80,41 @@ CodecCustomizer jacksonCodecCustomizer(JsonMapper jsonMapper) {

}

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(Gson.class)
@ConditionalOnBean(Gson.class)
@ConditionalOnProperty(name = PREFERRED_MAPPER_PROPERTY, havingValue = "gson")
static class GsonJsonCodecConfiguration {

@Bean
CodecCustomizer gsonCodecCustomizer(Gson gson) {
return (configurer) -> {
CustomCodecs customCodecs = configurer.customCodecs();
customCodecs.registerWithDefaultConfig(new GsonDecoder(gson));
customCodecs.registerWithDefaultConfig(new GsonEncoder(gson));
};
}

}

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ Serializable.class, Json.class })
@ConditionalOnBean(Json.class)
@ConditionalOnProperty(name = PREFERRED_MAPPER_PROPERTY, havingValue = "kotlin-serialization")
static class KotlinSerializationJsonCodecConfiguration {

@Bean
@Order(-10) // configured ahead of JSON mappers
CodecCustomizer kotlinSerializationCodecCustomizer(Json json) {
return (configurer) -> {
CustomCodecs customCodecs = configurer.customCodecs();
customCodecs.registerWithDefaultConfig(new KotlinSerializationJsonDecoder(json));
customCodecs.registerWithDefaultConfig(new KotlinSerializationJsonEncoder(json));
};
}

}

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(HttpCodecsProperties.class)
static class DefaultCodecsConfiguration {
Expand Down
31 changes: 29 additions & 2 deletions ...boot-http-codec/src/main/resources/META-INF/additional-spring-configuration-metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
{
"groups": [],
"properties": []
"properties": [
{
"name": "spring.http.codecs.preferred-json-mapper",
"type": "java.lang.String",
"defaultValue": "jackson",
"description": "Preferred JSON mapper to use for JSON encoder and decoder. By default, auto-detected according to the environment. Supported values are 'jackson', 'gson' and 'kotlin-serialization'."
}
],
"hints": [
{
"name": "spring.http.codecs.preferred-json-mapper",
"values": [
{
"value": "jackson"
},
{
"value": "gson"
},
{
"value": "kotlin-serialization"
}
],
"providers": [
{
"name": "any"
}
]
}
]
}
69 changes: 0 additions & 69 deletions .../java/org/springframework/boot/http/codec/autoconfigure/CodecsAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,12 @@

package org.springframework.boot.http.codec.autoconfigure;

import java.util.List;

import org.junit.jupiter.api.Test;
import tools.jackson.databind.json.JsonMapper;

import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.http.codec.CodecCustomizer;
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.http.codec.CodecConfigurer;
import org.springframework.http.codec.CodecConfigurer.DefaultCodecs;
Expand Down Expand Up @@ -71,27 +66,6 @@ void defaultCodecCustomizerBeanShouldHaveOrderZero() {
.run((context) -> assertThat(context.getBean("defaultCodecCustomizer", Ordered.class).getOrder()).isZero());
}

@Test
void jacksonCodecCustomizerBacksOffWhenThereIsNoObjectMapper() {
this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean("jacksonCodecCustomizer"));
}

@Test
void jacksonCodecCustomizerIsAutoConfiguredWhenJsonMapperIsPresent() {
this.contextRunner.withUserConfiguration(JsonMapperConfiguration.class)
.run((context) -> assertThat(context).hasBean("jacksonCodecCustomizer"));
}

@Test
void userProvidedCustomizerCanOverrideJacksonCodecCustomizer() {
this.contextRunner.withUserConfiguration(JsonMapperConfiguration.class, CodecCustomizerConfiguration.class)
.run((context) -> {
List<CodecCustomizer> codecCustomizers = context.getBean(CodecCustomizers.class).codecCustomizers;
assertThat(codecCustomizers).hasSize(3);
assertThat(codecCustomizers.get(2)).isInstanceOf(TestCodecCustomizer.class);
});
}

@Test
void maxInMemorySizeEnforcedInDefaultCodecs() {
this.contextRunner.withPropertyValues("spring.http.codecs.max-in-memory-size=1MB")
Expand All @@ -106,47 +80,4 @@ private DefaultCodecs defaultCodecs(AssertableApplicationContext context) {
return configurer.defaultCodecs();
}

@Configuration(proxyBeanMethods = false)
static class JsonMapperConfiguration {

@Bean
JsonMapper jsonMapper() {
return new JsonMapper();
}

}

@Configuration(proxyBeanMethods = false)
static class CodecCustomizerConfiguration {

@Bean
CodecCustomizer codecCustomizer() {
return new TestCodecCustomizer();
}

@Bean
CodecCustomizers codecCustomizers(List<CodecCustomizer> customizers) {
return new CodecCustomizers(customizers);
}

}

private static final class TestCodecCustomizer implements CodecCustomizer {

@Override
public void customize(CodecConfigurer configurer) {
}

}

private static final class CodecCustomizers {

private final List<CodecCustomizer> codecCustomizers;

private CodecCustomizers(List<CodecCustomizer> codecCustomizers) {
this.codecCustomizers = codecCustomizers;
}

}

}
Loading