Create spring-boot-http-codec module
This commit is contained in:
Andy Wilkinson
committed by
Phillip Webb
Phillip Webb
parent
4ce8b591e0
commit
2e52a3ebef
@@ -0,0 +1,114 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.http.codec.autoconfigure;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
|
||||
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.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.context.properties.PropertyMapper;
|
||||
import org.springframework.boot.web.codec.CodecCustomizer;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.Order;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.http.codec.CodecConfigurer;
|
||||
import org.springframework.util.MimeType;
|
||||
import org.springframework.util.unit.DataSize;
|
||||
import org.springframework.web.reactive.function.client.WebClient;
|
||||
|
||||
/**
|
||||
* {@link EnableAutoConfiguration Auto-configuration} for
|
||||
* {@link org.springframework.core.codec.Encoder Encoders} and
|
||||
* {@link org.springframework.core.codec.Decoder Decoders}.
|
||||
*
|
||||
* @author Brian Clozel
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@AutoConfiguration(afterName = "org.springframework.boot.jackson.autoconfigure.JacksonAutoConfiguration")
|
||||
@ConditionalOnClass({ CodecConfigurer.class, WebClient.class })
|
||||
public class CodecsAutoConfiguration {
|
||||
|
||||
private static final MimeType[] EMPTY_MIME_TYPES = {};
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@ConditionalOnClass(ObjectMapper.class)
|
||||
@SuppressWarnings({ "removal", "deprecation" })
|
||||
static class JacksonCodecConfiguration {
|
||||
|
||||
@Bean
|
||||
@Order(0)
|
||||
@ConditionalOnBean(ObjectMapper.class)
|
||||
CodecCustomizer jacksonCodecCustomizer(ObjectMapper objectMapper) {
|
||||
return (configurer) -> {
|
||||
CodecConfigurer.DefaultCodecs defaults = configurer.defaultCodecs();
|
||||
defaults.jackson2JsonDecoder(
|
||||
new org.springframework.http.codec.json.Jackson2JsonDecoder(objectMapper, EMPTY_MIME_TYPES));
|
||||
defaults.jackson2JsonEncoder(
|
||||
new org.springframework.http.codec.json.Jackson2JsonEncoder(objectMapper, EMPTY_MIME_TYPES));
|
||||
};
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@EnableConfigurationProperties(HttpCodecsProperties.class)
|
||||
static class DefaultCodecsConfiguration {
|
||||
|
||||
@Bean
|
||||
DefaultCodecCustomizer defaultCodecCustomizer(HttpCodecsProperties httpCodecProperties,
|
||||
Environment environment) {
|
||||
return new DefaultCodecCustomizer(httpCodecProperties.isLogRequestDetails(),
|
||||
httpCodecProperties.getMaxInMemorySize());
|
||||
}
|
||||
|
||||
static final class DefaultCodecCustomizer implements CodecCustomizer, Ordered {
|
||||
|
||||
private final boolean logRequestDetails;
|
||||
|
||||
private final DataSize maxInMemorySize;
|
||||
|
||||
DefaultCodecCustomizer(boolean logRequestDetails, DataSize maxInMemorySize) {
|
||||
this.logRequestDetails = logRequestDetails;
|
||||
this.maxInMemorySize = maxInMemorySize;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void customize(CodecConfigurer configurer) {
|
||||
PropertyMapper map = PropertyMapper.get();
|
||||
CodecConfigurer.DefaultCodecs defaultCodecs = configurer.defaultCodecs();
|
||||
defaultCodecs.enableLoggingRequestDetails(this.logRequestDetails);
|
||||
map.from(this.maxInMemorySize)
|
||||
.whenNonNull()
|
||||
.asInt(DataSize::toBytes)
|
||||
.to(defaultCodecs::maxInMemorySize);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getOrder() {
|
||||
return 0;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.http.codec.autoconfigure;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.util.unit.DataSize;
|
||||
|
||||
/**
|
||||
* {@link ConfigurationProperties Properties} for reactive HTTP codecs.
|
||||
*
|
||||
* @author Brian Clozel
|
||||
* @author Andy Wilkinson
|
||||
* @since 3.5.0
|
||||
*/
|
||||
@ConfigurationProperties("spring.http.codecs")
|
||||
public class HttpCodecsProperties {
|
||||
|
||||
/**
|
||||
* Whether to log form data at DEBUG level, and headers at TRACE level.
|
||||
*/
|
||||
private boolean logRequestDetails;
|
||||
|
||||
/**
|
||||
* Limit on the number of bytes that can be buffered whenever the input stream needs
|
||||
* to be aggregated. This applies only to the auto-configured WebFlux server and
|
||||
* WebClient instances. By default this is not set, in which case individual codec
|
||||
* defaults apply. Most codecs are limited to 256K by default.
|
||||
*/
|
||||
private DataSize maxInMemorySize;
|
||||
|
||||
public boolean isLogRequestDetails() {
|
||||
return this.logRequestDetails;
|
||||
}
|
||||
|
||||
public void setLogRequestDetails(boolean logRequestDetails) {
|
||||
this.logRequestDetails = logRequestDetails;
|
||||
}
|
||||
|
||||
public DataSize getMaxInMemorySize() {
|
||||
return this.maxInMemorySize;
|
||||
}
|
||||
|
||||
public void setMaxInMemorySize(DataSize maxInMemorySize) {
|
||||
this.maxInMemorySize = maxInMemorySize;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Auto-configuration for HTTP codecs.
|
||||
*/
|
||||
package org.springframework.boot.http.codec.autoconfigure;
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"groups": [],
|
||||
"properties": []
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
org.springframework.boot.http.codec.autoconfigure.CodecsAutoConfiguration
|
||||
@@ -0,0 +1,152 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.http.codec.autoconfigure;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
|
||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||
import org.springframework.boot.web.codec.CodecCustomizer;
|
||||
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;
|
||||
import org.springframework.http.codec.support.DefaultClientCodecConfigurer;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link CodecsAutoConfiguration}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
class CodecsAutoConfigurationTests {
|
||||
|
||||
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withConfiguration(AutoConfigurations.of(CodecsAutoConfiguration.class));
|
||||
|
||||
@Test
|
||||
void autoConfigShouldProvideALoggingRequestDetailsCustomizer() {
|
||||
this.contextRunner.run((context) -> assertThat(defaultCodecs(context))
|
||||
.hasFieldOrPropertyWithValue("enableLoggingRequestDetails", false));
|
||||
}
|
||||
|
||||
@Test
|
||||
void loggingRequestDetailsCustomizerShouldUseHttpCodecsProperties() {
|
||||
this.contextRunner.withPropertyValues("spring.http.codecs.log-request-details=true")
|
||||
.run((context) -> assertThat(defaultCodecs(context))
|
||||
.hasFieldOrPropertyWithValue("enableLoggingRequestDetails", true));
|
||||
}
|
||||
|
||||
@Test
|
||||
void maxInMemorySizeShouldUseHttpCodecProperties() {
|
||||
this.contextRunner.withPropertyValues("spring.http.codecs.max-in-memory-size=64KB")
|
||||
.run((context) -> assertThat(defaultCodecs(context)).hasFieldOrPropertyWithValue("maxInMemorySize",
|
||||
64 * 1024));
|
||||
}
|
||||
|
||||
@Test
|
||||
void defaultCodecCustomizerBeanShouldHaveOrderZero() {
|
||||
this.contextRunner
|
||||
.run((context) -> assertThat(context.getBean("defaultCodecCustomizer", Ordered.class).getOrder()).isZero());
|
||||
}
|
||||
|
||||
@Test
|
||||
void jacksonCodecCustomizerBacksOffWhenThereIsNoObjectMapper() {
|
||||
this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean("jacksonCodecCustomizer"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void jacksonCodecCustomizerIsAutoConfiguredWhenObjectMapperIsPresent() {
|
||||
this.contextRunner.withUserConfiguration(ObjectMapperConfiguration.class)
|
||||
.run((context) -> assertThat(context).hasBean("jacksonCodecCustomizer"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void userProvidedCustomizerCanOverrideJacksonCodecCustomizer() {
|
||||
this.contextRunner.withUserConfiguration(ObjectMapperConfiguration.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")
|
||||
.run((context) -> assertThat(defaultCodecs(context)).hasFieldOrPropertyWithValue("maxInMemorySize",
|
||||
1048576));
|
||||
}
|
||||
|
||||
private DefaultCodecs defaultCodecs(AssertableApplicationContext context) {
|
||||
CodecCustomizer customizer = context.getBean(CodecCustomizer.class);
|
||||
CodecConfigurer configurer = new DefaultClientCodecConfigurer();
|
||||
customizer.customize(configurer);
|
||||
return configurer.defaultCodecs();
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class ObjectMapperConfiguration {
|
||||
|
||||
@Bean
|
||||
ObjectMapper objectMapper() {
|
||||
return new ObjectMapper();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@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;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user