GH-3151: Refine Jackson 3-based classes to accept only JsonMapper

artembilan · artembilan · commit b682cda0ef9c · 2025-08-13T13:20:57.000-04:00
Fixes: #3151 To avoid the problem when any other possible `ObjectMapper` extension ((`XmlMapper`, `SmileMapper`, `CBORMapper`) could be injected into just JSON-based components, it is better to concentrate only on specific implementation. * Fix `JacksonJsonMessageConverter` and `JacksonProjectingMessageConverter` to accept only `JsonMapper` * Fix `JacksonXmlMessageConverter` to disable `setUseProjectionForInterfaces()` since projection in Spring Data is implemented only for JSON views
diff --git a/spring-amqp/src/main/java/org/springframework/amqp/support/converter/AbstractJacksonMessageConverter.java b/spring-amqp/src/main/java/org/springframework/amqp/support/converter/AbstractJacksonMessageConverter.java
@@ -29,6 +29,7 @@
 import tools.jackson.core.JacksonException;
 import tools.jackson.databind.JavaType;
 import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
 
 import org.springframework.amqp.core.Message;
 import org.springframework.amqp.core.MessageProperties;
@@ -268,7 +269,7 @@ public void setUseProjectionForInterfaces(boolean useProjectionForInterfaces) {
 			if (!ClassUtils.isPresent("org.springframework.data.projection.ProjectionFactory", this.classLoader)) {
 				throw new IllegalStateException("'spring-data-commons' is required to use Projection Interfaces");
 			}
-			this.projectingConverter = new JacksonProjectingMessageConverter(this.objectMapper);
+			this.projectingConverter = new JacksonProjectingMessageConverter((JsonMapper) this.objectMapper);
 		}
 	}
 
diff --git a/spring-amqp/src/main/java/org/springframework/amqp/support/converter/JacksonJsonMessageConverter.java b/spring-amqp/src/main/java/org/springframework/amqp/support/converter/JacksonJsonMessageConverter.java
@@ -18,7 +18,6 @@
 
 import tools.jackson.databind.DeserializationFeature;
 import tools.jackson.databind.MapperFeature;
-import tools.jackson.databind.ObjectMapper;
 import tools.jackson.databind.json.JsonMapper;
 
 import org.springframework.amqp.core.MessageProperties;
@@ -34,16 +33,16 @@
 public class JacksonJsonMessageConverter extends AbstractJacksonMessageConverter {
 
 	/**
-	 * Construct with an internal {@link ObjectMapper} instance and trusted packed to all ({@code *}).
+	 * Construct with an internal {@link JsonMapper} instance and trusted packed to all ({@code *}).
 	 */
 	public JacksonJsonMessageConverter() {
 		this("*");
 	}
 
 	/**
-	 * Construct with an internal {@link ObjectMapper} instance.
+	 * Construct with an internal {@link JsonMapper} instance.
 	 * The {@link DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES}
-	 * and {@link MapperFeature#DEFAULT_VIEW_INCLUSION} are set to false on the {@link ObjectMapper}.
+	 * and {@link MapperFeature#DEFAULT_VIEW_INCLUSION} are set to false on the {@link JsonMapper}.
 	 * @param trustedPackages the trusted Java packages for deserialization
 	 * @see DefaultJacksonJavaTypeMapper#setTrustedPackages(String...)
 	 */
@@ -57,21 +56,21 @@ public JacksonJsonMessageConverter(String... trustedPackages) {
 	}
 
 	/**
-	 * Construct with the provided {@link ObjectMapper} instance and trusted packed to all ({@code *}).
-	 * @param jsonObjectMapper the {@link ObjectMapper} to use.
+	 * Construct with the provided {@link JsonMapper} instance and trusted packed to all ({@code *}).
+	 * @param jsonMapper the {@link JsonMapper} to use.
 	 */
-	public JacksonJsonMessageConverter(ObjectMapper jsonObjectMapper) {
-		this(jsonObjectMapper, "*");
+	public JacksonJsonMessageConverter(JsonMapper jsonMapper) {
+		this(jsonMapper, "*");
 	}
 
 	/**
-	 * Construct with the provided {@link ObjectMapper} instance.
-	 * @param jsonObjectMapper the {@link ObjectMapper} to use.
+	 * Construct with the provided {@link JsonMapper} instance.
+	 * @param jsonMapper the {@link JsonMapper} to use.
 	 * @param trustedPackages the trusted Java packages for deserialization
 	 * @see DefaultJacksonJavaTypeMapper#setTrustedPackages(String...)
 	 */
-	public JacksonJsonMessageConverter(ObjectMapper jsonObjectMapper, String... trustedPackages) {
-		super(jsonObjectMapper, MimeTypeUtils.parseMimeType(MessageProperties.CONTENT_TYPE_JSON), trustedPackages);
+	public JacksonJsonMessageConverter(JsonMapper jsonMapper, String... trustedPackages) {
+		super(jsonMapper, MimeTypeUtils.parseMimeType(MessageProperties.CONTENT_TYPE_JSON), trustedPackages);
 	}
 
 }
diff --git a/spring-amqp/src/main/java/org/springframework/amqp/support/converter/JacksonProjectingMessageConverter.java b/spring-amqp/src/main/java/org/springframework/amqp/support/converter/JacksonProjectingMessageConverter.java
@@ -25,7 +25,7 @@
 import com.jayway.jsonpath.spi.mapper.MappingProvider;
 import org.jspecify.annotations.Nullable;
 import tools.jackson.databind.JavaType;
-import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
 
 import org.springframework.amqp.core.Message;
 import org.springframework.core.ResolvableType;
@@ -49,7 +49,7 @@ public class JacksonProjectingMessageConverter {
 
 	private final ProjectionFactory projectionFactory;
 
-	public JacksonProjectingMessageConverter(ObjectMapper mapper) {
+	public JacksonProjectingMessageConverter(JsonMapper mapper) {
 		Assert.notNull(mapper, "'mapper' cannot be null");
 		MappingProvider provider = new Jackson3MappingProvider(mapper);
 		MethodInterceptorFactory interceptorFactory = new JsonProjectingMethodInterceptorFactory(provider);
@@ -68,17 +68,17 @@ public Object convert(Message message, Type type) {
 	/**
 	 * A {@link MappingProvider} implementation for Jackson 3.
 	 * Until respective implementation is there in json-path library.
-	 * @param objectMapper Jackson 3 {@link ObjectMapper}
+	 * @param jsonMapper Jackson 3 {@link JsonMapper}
 	 */
-	private record Jackson3MappingProvider(ObjectMapper objectMapper) implements MappingProvider {
+	private record Jackson3MappingProvider(JsonMapper jsonMapper) implements MappingProvider {
 
 		@Override
 		public <T> @Nullable T map(@Nullable Object source, Class<T> targetType, Configuration configuration) {
 			if (source == null) {
 				return null;
 			}
 			try {
-				return this.objectMapper.convertValue(source, targetType);
+				return this.jsonMapper.convertValue(source, targetType);
 			}
 			catch (Exception ex) {
 				throw new MappingException(ex);
@@ -90,10 +90,10 @@ private record Jackson3MappingProvider(ObjectMapper objectMapper) implements Map
 			if (source == null) {
 				return null;
 			}
-			JavaType type = this.objectMapper.constructType(targetType.getType());
+			JavaType type = this.jsonMapper.constructType(targetType.getType());
 
 			try {
-				return this.objectMapper.convertValue(source, type);
+				return this.jsonMapper.convertValue(source, type);
 			}
 			catch (Exception ex) {
 				throw new MappingException(ex);
diff --git a/spring-amqp/src/main/java/org/springframework/amqp/support/converter/JacksonXmlMessageConverter.java b/spring-amqp/src/main/java/org/springframework/amqp/support/converter/JacksonXmlMessageConverter.java
@@ -72,4 +72,9 @@ public JacksonXmlMessageConverter(XmlMapper xmlMapper, String... trustedPackages
 		super(xmlMapper, MimeTypeUtils.parseMimeType(MessageProperties.CONTENT_TYPE_XML), trustedPackages);
 	}
 
+	@Override
+	public void setUseProjectionForInterfaces(boolean useProjectionForInterfaces) {
+		throw new UnsupportedOperationException("This converter does not support useProjectionForInterfaces");
+	}
+
 }
diff --git a/spring-amqp/src/test/java/org/springframework/amqp/support/converter/JacksonJsonMessageConverterTests.java b/spring-amqp/src/test/java/org/springframework/amqp/support/converter/JacksonJsonMessageConverterTests.java
@@ -27,7 +27,6 @@
 import tools.jackson.core.JacksonException;
 import tools.jackson.core.JsonParser;
 import tools.jackson.databind.DeserializationContext;
-import tools.jackson.databind.ObjectMapper;
 import tools.jackson.databind.deser.std.StdDeserializer;
 import tools.jackson.databind.json.JsonMapper;
 import tools.jackson.databind.module.SimpleModule;
@@ -89,7 +88,7 @@ public void simpleTrade() {
 
 	@Test
 	public void simpleTradeOverrideMapper() {
-		ObjectMapper mapper =
+		JsonMapper mapper =
 				JsonMapper.builder()
 						.serializerFactory(BeanSerializerFactory.instance)
 						.build();
@@ -321,7 +320,7 @@ void customAbstractClass() {
 		messageProperties.setHeader("__TypeId__", String.class.getName());
 		messageProperties.setInferredArgumentType(Baz.class);
 		Message message = new Message(bytes, messageProperties);
-		ObjectMapper mapper = JsonMapper.builder().addModule(new BazModule()).build();
+		JsonMapper mapper = JsonMapper.builder().addModule(new BazModule()).build();
 		JacksonJsonMessageConverter messageConverter = new JacksonJsonMessageConverter(mapper);
 		messageConverter.setAlwaysConvertToInferredType(true);
 		Baz baz = (Baz) messageConverter.fromMessage(message);
@@ -347,7 +346,7 @@ void customAbstractClassList() throws Exception {
 		messageProperties.setHeader("__TypeId__", String.class.getName());
 		messageProperties.setInferredArgumentType(getClass().getDeclaredMethod("bazLister").getGenericReturnType());
 		Message message = new Message(bytes, messageProperties);
-		ObjectMapper mapper = JsonMapper.builder().addModule(new BazModule()).build();
+		JsonMapper mapper = JsonMapper.builder().addModule(new BazModule()).build();
 		JacksonJsonMessageConverter jsonMessageConverter = new JacksonJsonMessageConverter(mapper);
 		jsonMessageConverter.setAlwaysConvertToInferredType(true);
 		@SuppressWarnings("unchecked")
@@ -364,7 +363,7 @@ void cantDeserializeFizListUseHeaders() throws Exception {
 		messageProperties.setHeader("__TypeId__", List.class.getName());
 		messageProperties.setHeader("__ContentTypeId__", Buz.class.getName());
 		Message message = new Message(bytes, messageProperties);
-		ObjectMapper mapper = JsonMapper.builder().addModule(new BazModule()).build();
+		JsonMapper mapper = JsonMapper.builder().addModule(new BazModule()).build();
 		JacksonJsonMessageConverter jsonMessageConverter = new JacksonJsonMessageConverter(mapper);
 		@SuppressWarnings("unchecked")
 		List<Fiz> buzs = (List<Fiz>) jsonMessageConverter.fromMessage(message);

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@`
`29`	`29`	`import tools.jackson.core.JacksonException;`
`30`	`30`	`import tools.jackson.databind.JavaType;`
`31`	`31`	`import tools.jackson.databind.ObjectMapper;`
	`32`	`+import tools.jackson.databind.json.JsonMapper;`
`32`	`33`
`33`	`34`	`import org.springframework.amqp.core.Message;`
`34`	`35`	`import org.springframework.amqp.core.MessageProperties;`
`@@ -268,7 +269,7 @@ public void setUseProjectionForInterfaces(boolean useProjectionForInterfaces) {`
`268`	`269`	`if (!ClassUtils.isPresent("org.springframework.data.projection.ProjectionFactory", this.classLoader)) {`
`269`	`270`	`throw new IllegalStateException("'spring-data-commons' is required to use Projection Interfaces");`
`270`	`271`	`}`
`271`		`- this.projectingConverter = new JacksonProjectingMessageConverter(this.objectMapper);`
	`272`	`+ this.projectingConverter = new JacksonProjectingMessageConverter((JsonMapper) this.objectMapper);`
`272`	`273`	`}`
`273`	`274`	`}`
`274`	`275`
Original file line number	Diff line number	Diff line change
`@@ -72,4 +72,9 @@ public JacksonXmlMessageConverter(XmlMapper xmlMapper, String... trustedPackages`
`72`	`72`	`super(xmlMapper, MimeTypeUtils.parseMimeType(MessageProperties.CONTENT_TYPE_XML), trustedPackages);`
`73`	`73`	`}`
`74`	`74`
	`75`	`+ @Override`
	`76`	`+ public void setUseProjectionForInterfaces(boolean useProjectionForInterfaces) {`
	`77`	`+ throw new UnsupportedOperationException("This converter does not support useProjectionForInterfaces");`
	`78`	`+ }`
	`79`	`+`
`75`	`80`	`}`