Align naming change for Jackson components

snicoll · snicoll · commit 30a6b50e82d7 · 2025-10-29T16:58:16.000+01:00
This commit polishes the renaming of JsonComponent to JacksonComponent and the use of JacksonModule instead of Module in Jackson 2. This also adds integration tests that use a JacksonComponent with WebMvcTest and WebFluxTest. Closes gh-47864
diff --git a/core/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/json/JsonTest.java b/core/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/json/JsonTest.java
@@ -44,12 +44,12 @@
  * Using this annotation only enables auto-configuration that is relevant to JSON tests.
  * Similarly, component scanning is limited to beans annotated with:
  * <ul>
- * <li>{@code @JsonComponent}</li>
+ * <li>{@code @JacksonComponent}</li>
  * </ul>
  * <p>
  * as well as beans that implement:
  * <ul>
- * <li>{@code Module}, if Jackson is available</li>
+ * <li>{@code JacksonModule}, if Jackson is available</li>
  * </ul>
  * <p>
  * By default, tests annotated with {@code JsonTest} will also initialize
@@ -88,8 +88,8 @@
 
 	/**
 	 * Determines if default filtering should be used with
-	 * {@link SpringBootApplication @SpringBootApplication}. By default only
-	 * {@code @JsonComponent} and {@code Module} beans are included.
+	 * {@link SpringBootApplication @SpringBootApplication}. By default, only
+	 * {@code @JacksonComponent} and {@code JacksonModule} beans are included.
 	 * @see #includeFilters()
 	 * @see #excludeFilters()
 	 * @return if default filters should be used
diff --git a/module/spring-boot-graphql-test/src/main/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.java b/module/spring-boot-graphql-test/src/main/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.java
@@ -47,7 +47,7 @@
  * <ul>
  * <li>{@code @Controller}
  * <li>{@code RuntimeWiringConfigurer}
- * <li>{@code @JsonComponent}
+ * <li>{@code @JacksonComponent}
  * <li>{@code Converter}
  * <li>{@code GenericConverter}
  * <li>{@code DataFetcherExceptionResolver}
@@ -121,7 +121,7 @@
 	 * Determines if default filtering should be used with
 	 * {@link SpringBootApplication @SpringBootApplication}. By default, only
 	 * {@code @Controller} (when no explicit {@link #controllers() controllers} are
-	 * defined), {@code RuntimeWiringConfigurer}, {@code @JsonComponent},
+	 * defined), {@code RuntimeWiringConfigurer}, {@code @JacksonComponent},
 	 * {@code Converter}, {@code GenericConverter}, {@code DataFetcherExceptionResolver},
 	 * {@code Instrumentation} and {@code GraphQlSourceBuilderCustomizer} beans are
 	 * included.
diff --git a/module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/JacksonAutoConfigurationTests.java b/module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/JacksonAutoConfigurationTests.java
@@ -609,7 +609,7 @@ void cborMapperBuilderIsNotSharedAcrossMultipleInjectionPoints() {
 	}
 
 	@Test
-	void jsonComponentThatInjectsJsonMapperCausesBeanCurrentlyInCreationException() {
+	void jacksonComponentThatInjectsJsonMapperCausesBeanCurrentlyInCreationException() {
 		this.contextRunner.withUserConfiguration(CircularDependencySerializerConfiguration.class).run((context) -> {
 			assertThat(context).hasFailed();
 			assertThat(context).getFailure().hasRootCauseInstanceOf(BeanCurrentlyInCreationException.class);
diff --git a/module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/jsontest/app/ExampleCustomObject.java b/module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/jsontest/app/ExampleCustomObject.java
@@ -20,7 +20,7 @@
 import java.util.UUID;
 
 /**
- * Example object to read/write as JSON through {@link ExampleJsonComponent}.
+ * Example object to read/write as JSON through {@link ExampleJacksonComponent}.
  *
  * @author Phillip Webb
  * @param value the value
diff --git a/module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/jsontest/app/ExampleJacksonComponent.java b/module/spring-boot-jackson/src/test/java/org/springframework/boot/jackson/autoconfigure/jsontest/app/ExampleJacksonComponent.java
@@ -31,13 +31,13 @@
 import org.springframework.boot.test.autoconfigure.json.JsonTest;
 
 /**
- * Example {@link JacksonComponent @JsonComponent} for use with {@link JsonTest @JsonTest}
- * tests.
+ * Example {@link JacksonComponent @JacksonComponent} for use with
+ * {@link JsonTest @JsonTest} tests.
  *
  * @author Phillip Webb
  */
 @JacksonComponent
-public class ExampleJsonComponent {
+public class ExampleJacksonComponent {
 
 	static class Serializer extends ObjectValueSerializer<ExampleCustomObject> {
 
diff --git a/module/spring-boot-restclient-test/src/main/java/org/springframework/boot/restclient/test/autoconfigure/RestClientTest.java b/module/spring-boot-restclient-test/src/main/java/org/springframework/boot/restclient/test/autoconfigure/RestClientTest.java
@@ -45,12 +45,12 @@
  * Using this annotation only enables auto-configuration that is relevant to rest client
  * tests. Similarly, component scanning is limited to beans annotated with:
  * <ul>
- * <li>{@code @JsonComponent}</li>
+ * <li>{@code @JacksonComponent}</li>
  * </ul>
  * <p>
  * as well as beans that implement:
  * <ul>
- * <li>{@code Module}, if Jackson is available</li>
+ * <li>{@code JacksonModule}, if Jackson is available</li>
  * </ul>
  * <p>
  * By default, tests annotated with {@code RestClientTest} will also auto-configure a
@@ -107,8 +107,8 @@
 
 	/**
 	 * Determines if default filtering should be used with
-	 * {@link SpringBootApplication @SpringBootApplication}. By default only
-	 * {@code @JsonComponent} and {@code Module} beans are included.
+	 * {@link SpringBootApplication @SpringBootApplication}. By default, only
+	 * {@code @JacksonComponent} and {@code JacksonModule} beans are included.
 	 * @see #includeFilters()
 	 * @see #excludeFilters()
 	 * @return if default filters should be used
diff --git a/module/spring-boot-webclient-test/src/main/java/org/springframework/boot/webclient/test/autoconfigure/WebClientTest.java b/module/spring-boot-webclient-test/src/main/java/org/springframework/boot/webclient/test/autoconfigure/WebClientTest.java
@@ -43,7 +43,7 @@
  * Using this annotation only enables auto-configuration that is relevant to rest client
  * tests. Similarly, component scanning is limited to beans annotated with:
  * <ul>
- * <li>{@code @JsonComponent}</li>
+ * <li>{@code @JacksonComponent}</li>
  * </ul>
  * <p>
  * as well as beans that implement:
@@ -97,8 +97,8 @@
 
 	/**
 	 * Determines if default filtering should be used with
-	 * {@link SpringBootApplication @SpringBootApplication}. By default only
-	 * {@code @JsonComponent} and {@code Module} beans are included.
+	 * {@link SpringBootApplication @SpringBootApplication}. By default, only
+	 * {@code @JacksonComponent} and {@code JacksonModule} beans are included.
 	 * @see #includeFilters()
 	 * @see #excludeFilters()
 	 * @return if default filters should be used
diff --git a/module/spring-boot-webflux-test/src/main/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.java b/module/spring-boot-webflux-test/src/main/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.java
@@ -49,15 +49,15 @@
  * <ul>
  * <li>{@code @Controller}</li>
  * <li>{@code @ControllerAdvice}</li>
- * <li>{@code @JsonComponent}</li>
+ * <li>{@code @JacksonComponent}</li>
  * </ul>
  * <p>
  * as well as beans that implement:
  * <ul>
  * <li>{@code Converter}</li>
  * <li>{@code GenericConverter}</li>
  * <li>{@code IDialect}, if Thymeleaf is available</li>
- * <li>{@code Module}, if Jackson is available</li>
+ * <li>{@code JacksonModule}, if Jackson is available</li>
  * <li>{@code WebExceptionHandler}</li>
  * <li>{@code WebFluxConfigurer}</li>
  * <li>{@code WebFilter}</li>
diff --git a/module/spring-boot-webflux-test/src/main/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTypeExcludeFilter.java b/module/spring-boot-webflux-test/src/main/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTypeExcludeFilter.java
@@ -43,7 +43,7 @@ class WebFluxTypeExcludeFilter extends StandardAnnotationCustomizableTypeExclude
 	private static final Class<?>[] NO_CONTROLLERS = {};
 
 	private static final String[] OPTIONAL_INCLUDES = { "tools.jackson.databind.JacksonModule",
-			"org.springframework.boot.jackson.JsonComponent" };
+			"org.springframework.boot.jackson.JacksonComponent" };
 
 	private static final Set<Class<?>> KNOWN_INCLUDES;
 
diff --git a/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/ExampleController2.java b/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/ExampleController2.java
@@ -21,6 +21,8 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
@@ -42,4 +44,10 @@ public Mono<String> two(@PathVariable ExampleId id) {
 		return Mono.just(id.getId() + "two");
 	}
 
+	@PostMapping("/two/{id}")
+	@ResponseBody
+	public Mono<ExampleResult> twoUpdate(@PathVariable String id) {
+		return Mono.just(new ExampleResult(id));
+	}
+
 }
diff --git a/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/ExampleResult.java b/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/ExampleResult.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2012-present 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.webflux.test.autoconfigure;
+
+import org.springframework.boot.jackson.JacksonComponent;
+
+/**
+ * Example result that requires a {@link JacksonComponent}.
+ *
+ * @param id sample data
+ * @author Stephane Nicoll
+ */
+public record ExampleResult(String id) {
+}
diff --git a/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/ExampleResultSerializer.java b/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/ExampleResultSerializer.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2012-present 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.webflux.test.autoconfigure;
+
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.SerializationContext;
+
+import org.springframework.boot.jackson.JacksonComponent;
+import org.springframework.boot.jackson.ObjectValueSerializer;
+
+/**
+ * {@link ObjectValueSerializer} for {@link ExampleResult}.
+ *
+ * @author Stephane Nicoll
+ */
+@JacksonComponent
+public class ExampleResultSerializer extends ObjectValueSerializer<ExampleResult> {
+
+	@Override
+	protected void serializeObject(ExampleResult item, JsonGenerator jsonWriter, SerializationContext context) {
+		jsonWriter.writeStringProperty("identifier", item.id());
+	}
+
+}
diff --git a/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTestJacksonComponentIntegrationTests.java b/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTestJacksonComponentIntegrationTests.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2012-present 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.webflux.test.autoconfigure;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.jackson.JacksonComponent;
+import org.springframework.test.json.JsonCompareMode;
+import org.springframework.test.web.reactive.server.WebTestClient;
+
+/**
+ * Tests for {@link WebFluxTest @WebFluxTest} to validate {@link JacksonComponent} beans
+ * are discovered.
+ *
+ * @author Stephane Nicoll
+ */
+@WebFluxTest(controllers = ExampleController2.class)
+class WebFluxTestJacksonComponentIntegrationTests {
+
+	@Autowired
+	private WebTestClient webClient;
+
+	@Test
+	void shouldFindConverter() {
+
+		this.webClient.post()
+			.uri("/two/" + "1234abcd")
+			.exchange()
+			.expectStatus()
+			.isOk()
+			.expectBody()
+			.json("{ \"identifier\": \"1234abcd\" }", JsonCompareMode.LENIENT);
+	}
+
+}
diff --git a/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTypeExcludeFilterTests.java b/module/spring-boot-webflux-test/src/test/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTypeExcludeFilterTests.java
@@ -22,6 +22,7 @@
 import reactor.core.publisher.Mono;
 import tools.jackson.databind.module.SimpleModule;
 
+import org.springframework.boot.jackson.JacksonComponent;
 import org.springframework.context.annotation.ComponentScan.Filter;
 import org.springframework.context.annotation.FilterType;
 import org.springframework.core.type.classreading.MetadataReader;
@@ -59,6 +60,7 @@ void matchWhenHasNoControllers() throws Exception {
 		assertThat(excludes(filter, ExampleRepository.class)).isTrue();
 		assertThat(excludes(filter, ExampleWebFilter.class)).isFalse();
 		assertThat(excludes(filter, ExampleModule.class)).isFalse();
+		assertThat(excludes(filter, ExampleJacksonComponent.class)).isFalse();
 	}
 
 	@Test
@@ -72,6 +74,7 @@ void matchWhenHasController() throws Exception {
 		assertThat(excludes(filter, ExampleRepository.class)).isTrue();
 		assertThat(excludes(filter, ExampleWebFilter.class)).isFalse();
 		assertThat(excludes(filter, ExampleModule.class)).isFalse();
+		assertThat(excludes(filter, ExampleJacksonComponent.class)).isFalse();
 	}
 
 	@Test
@@ -85,6 +88,7 @@ void matchNotUsingDefaultFilters() throws Exception {
 		assertThat(excludes(filter, ExampleRepository.class)).isTrue();
 		assertThat(excludes(filter, ExampleWebFilter.class)).isTrue();
 		assertThat(excludes(filter, ExampleModule.class)).isTrue();
+		assertThat(excludes(filter, ExampleJacksonComponent.class)).isTrue();
 	}
 
 	@Test
@@ -98,6 +102,7 @@ void matchWithIncludeFilter() throws Exception {
 		assertThat(excludes(filter, ExampleRepository.class)).isFalse();
 		assertThat(excludes(filter, ExampleWebFilter.class)).isFalse();
 		assertThat(excludes(filter, ExampleModule.class)).isFalse();
+		assertThat(excludes(filter, ExampleJacksonComponent.class)).isFalse();
 	}
 
 	@Test
@@ -111,6 +116,7 @@ void matchWithExcludeFilter() throws Exception {
 		assertThat(excludes(filter, ExampleRepository.class)).isTrue();
 		assertThat(excludes(filter, ExampleWebFilter.class)).isFalse();
 		assertThat(excludes(filter, ExampleModule.class)).isFalse();
+		assertThat(excludes(filter, ExampleJacksonComponent.class)).isFalse();
 	}
 
 	private boolean excludes(WebFluxTypeExcludeFilter filter, Class<?> type) throws IOException {
@@ -185,4 +191,9 @@ static class ExampleModule extends SimpleModule {
 
 	}
 
+	@JacksonComponent
+	static class ExampleJacksonComponent {
+
+	}
+
 }
diff --git a/module/spring-boot-webmvc-test/src/main/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.java b/module/spring-boot-webmvc-test/src/main/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.java
@@ -47,7 +47,7 @@
  * <ul>
  * <li>{@code @Controller}</li>
  * <li>{@code @ControllerAdvice}</li>
- * <li>{@code @JsonComponent}</li>
+ * <li>{@code @JacksonComponent}</li>
  * </ul>
  * <p>
  * as well as beans that implement:
@@ -62,7 +62,7 @@
  * <li>{@code HandlerMethodArgumentResolver}</li>
  * <li>{@code HttpMessageConverter}</li>
  * <li>{@code IDialect}, if Thymeleaf is available</li>
- * <li>{@code Module}, if Jackson is available</li>
+ * <li>{@code JacksonModule}, if Jackson is available</li>
  * <li>{@code SecurityFilterChain}</li>
  * <li>{@code WebMvcConfigurer}</li>
  * <li>{@code WebMvcRegistrations}</li>
diff --git a/module/spring-boot-webmvc-test/src/main/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTypeExcludeFilter.java b/module/spring-boot-webmvc-test/src/main/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTypeExcludeFilter.java
@@ -49,10 +49,10 @@ class WebMvcTypeExcludeFilter extends StandardAnnotationCustomizableTypeExcludeF
 
 	private static final Class<?>[] NO_CONTROLLERS = {};
 
-	private static final String[] OPTIONAL_INCLUDES = { "org.springframework.boot.jackson.JsonComponent",
+	private static final String[] OPTIONAL_INCLUDES = { "tools.jackson.databind.JacksonModule",
+			"org.springframework.boot.jackson.JacksonComponent",
 			"org.springframework.security.config.annotation.web.WebSecurityConfigurer",
-			"org.springframework.security.web.SecurityFilterChain", "org.thymeleaf.dialect.IDialect",
-			"tools.jackson.databind.JacksonModule" };
+			"org.springframework.security.web.SecurityFilterChain", "org.thymeleaf.dialect.IDialect", };
 
 	private static final Set<Class<?>> KNOWN_INCLUDES;
 
diff --git a/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTypeExcludeFilterTests.java b/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTypeExcludeFilterTests.java
diff --git a/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/ExampleController2.java b/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/ExampleController2.java
diff --git a/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/ExampleResult.java b/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/ExampleResult.java
diff --git a/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/ExampleResultSerializer.java b/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/ExampleResultSerializer.java
diff --git a/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/WebMvcTestJacksonComponentIntegrationTests.java b/module/spring-boot-webmvc-test/src/test/java/org/springframework/boot/webmvc/test/autoconfigure/mockmvc/WebMvcTestJacksonComponentIntegrationTests.java
diff --git a/module/spring-boot-webservices-test/src/main/java/org/springframework/boot/webservices/test/autoconfigure/client/WebServiceClientTest.java b/module/spring-boot-webservices-test/src/main/java/org/springframework/boot/webservices/test/autoconfigure/client/WebServiceClientTest.java

Original file line number	Diff line number	Diff line change
`@@ -609,7 +609,7 @@ void cborMapperBuilderIsNotSharedAcrossMultipleInjectionPoints() {`
`609`	`609`	`}`
`610`	`610`
`611`	`611`	`@Test`
`612`		`- void jsonComponentThatInjectsJsonMapperCausesBeanCurrentlyInCreationException() {`
	`612`	`+ void jacksonComponentThatInjectsJsonMapperCausesBeanCurrentlyInCreationException() {`
`613`	`613`	`this.contextRunner.withUserConfiguration(CircularDependencySerializerConfiguration.class).run((context) -> {`
`614`	`614`	`assertThat(context).hasFailed();`
`615`	`615`	`assertThat(context).getFailure().hasRootCauseInstanceOf(BeanCurrentlyInCreationException.class);`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`import java.util.UUID;`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * Example object to read/write as JSON through {@link ExampleJsonComponent}.`
	`23`	`+ * Example object to read/write as JSON through {@link ExampleJacksonComponent}.`
`24`	`24`	`*`
`25`	`25`	`* @author Phillip Webb`
`26`	`26`	`* @param value the value`