Allow to disable defaults in HttpMessageConverters

bclozel · bclozel · commit 5ef997252871 · 2026-02-11T18:37:12.000+01:00
The builder for `HttpMessageConverters` allows for auto-detection of message converters on the classpath and their default registration when `registerDefaults()` is called. Once called, there is no way to undo this. This commit adds a new `disableDefaults()` method to disable the default registration and take full control over the list of message converters. Closes gh-36303
diff --git a/spring-web/src/main/java/org/springframework/http/converter/DefaultHttpMessageConverters.java b/spring-web/src/main/java/org/springframework/http/converter/DefaultHttpMessageConverters.java
@@ -389,6 +389,12 @@ public DefaultClientBuilder registerDefaults() {
 			return this;
 		}
 
+		@Override
+		public ClientBuilder disableDefaults() {
+			this.registerDefaults = false;
+			return this;
+		}
+
 		@Override
 		public ClientBuilder withStringConverter(HttpMessageConverter<?> stringConverter) {
 			setStringConverter(stringConverter);
@@ -495,6 +501,12 @@ public ServerBuilder registerDefaults() {
 			return this;
 		}
 
+		@Override
+		public ServerBuilder disableDefaults() {
+			this.registerDefaults = false;
+			return this;
+		}
+
 		@Override
 		public ServerBuilder withStringConverter(HttpMessageConverter<?> stringConverter) {
 			setStringConverter(stringConverter);
diff --git a/spring-web/src/main/java/org/springframework/http/converter/HttpMessageConverters.java b/spring-web/src/main/java/org/springframework/http/converter/HttpMessageConverters.java
@@ -97,6 +97,15 @@ interface Builder<T extends Builder<T>> {
 		 */
 		T registerDefaults();
 
+		/**
+		 * Prevent the registration of default converters using classpath detection.
+		 * Manual registrations like {@link #withJsonConverter(HttpMessageConverter)} are
+		 * still allowed. If both {@link #registerDefaults()} and this method are called,
+		 * the latest call wins.
+		 * @since 7.0.4
+		 */
+		T disableDefaults();
+
 		/**
 		 * Override the default String {@code HttpMessageConverter}
 		 * with any converter supporting String conversion.
diff --git a/spring-web/src/test/java/org/springframework/http/converter/DefaultHttpMessageConvertersTests.java b/spring-web/src/test/java/org/springframework/http/converter/DefaultHttpMessageConvertersTests.java
@@ -125,6 +125,12 @@ void defaultConverters() {
 					RssChannelHttpMessageConverter.class);
 		}
 
+		@Test
+		void disableDefaults() {
+			var converters = HttpMessageConverters.forClient().registerDefaults().disableDefaults().build();
+			assertThat(converters).isEmpty();
+		}
+
 		@Test
 		void multipartConverterContainsOtherConverters() {
 			var converters = HttpMessageConverters.forClient().registerDefaults().build();
@@ -242,6 +248,12 @@ void defaultConverters() {
 					RssChannelHttpMessageConverter.class);
 		}
 
+		@Test
+		void disableDefaults() {
+			var converters = HttpMessageConverters.forServer().registerDefaults().disableDefaults().build();
+			assertThat(converters).isEmpty();
+		}
+
 		@Test
 		void multipartConverterContainsOtherConverters() {
 			var converters = HttpMessageConverters.forServer().registerDefaults().build();
