Configure SQS to use existing ObjectMapper if present in application …

…context.

If ObjectMapper is not present, creates default Jackson ObjectMapper without the dependency to spring-web module.

Fixes gh-533
Fixes gh-522
Fixes gh-540
Closes gh-592

spring-cloud-aws-messaging/src/main/java/org/springframework/cloud/aws/messaging/config/QueueMessageHandlerFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 the original author or authors.
+ * Copyright 2013-2020 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.
@@ -21,6 +21,7 @@
 
 import com.amazonaws.services.sqs.AmazonSQS;
 import com.amazonaws.services.sqs.AmazonSQSAsync;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.cloud.aws.core.env.ResourceIdResolver;
@@ -55,6 +56,8 @@ public class QueueMessageHandlerFactory {
 
 	private List<MessageConverter> messageConverters;
 
+	private ObjectMapper objectMapper;
+
 	public void setArgumentResolvers(
 			List<HandlerMethodArgumentResolver> argumentResolvers) {
 		this.argumentResolvers = argumentResolvers;
@@ -123,10 +126,20 @@ public void setBeanFactory(BeanFactory beanFactory) {
 		this.beanFactory = beanFactory;
 	}
 
+	/**
+	 * Configures an {@link ObjectMapper} that is used by default
+	 * {@link MappingJackson2MessageConverter} created if no {@link #messageConverters}
+	 * are set.
+	 * @param objectMapper - object mapper, can be null
+	 */
+	public void setObjectMapper(ObjectMapper objectMapper) {
+		this.objectMapper = objectMapper;
+	}
+
 	public QueueMessageHandler createQueueMessageHandler() {
 		QueueMessageHandler queueMessageHandler = new QueueMessageHandler(
-				CollectionUtils.isEmpty(this.messageConverters)
-						? Arrays.asList(getDefaultMappingJackson2MessageConverter())
+				CollectionUtils.isEmpty(this.messageConverters) ? Arrays.asList(
+						getDefaultMappingJackson2MessageConverter(this.objectMapper))
 						: this.messageConverters);
 
 		if (!CollectionUtils.isEmpty(this.argumentResolvers)) {
@@ -159,7 +172,7 @@ public QueueMessageHandler createQueueMessageHandler() {
 	private QueueMessagingTemplate getDefaultSendToQueueMessagingTemplate(
 			AmazonSQSAsync amazonSqs, ResourceIdResolver resourceIdResolver) {
 		return new QueueMessagingTemplate(amazonSqs, resourceIdResolver,
-				getDefaultMappingJackson2MessageConverter());
+				getDefaultMappingJackson2MessageConverter(this.objectMapper));
 	}
 
 	public List<MessageConverter> getMessageConverters() {
@@ -176,10 +189,16 @@ public void setMessageConverters(List<MessageConverter> messageConverters) {
 		this.messageConverters = messageConverters;
 	}
 
-	private MappingJackson2MessageConverter getDefaultMappingJackson2MessageConverter() {
+	private MappingJackson2MessageConverter getDefaultMappingJackson2MessageConverter(
+			ObjectMapper objectMapper) {
 		MappingJackson2MessageConverter jacksonMessageConverter = new MappingJackson2MessageConverter();
 		jacksonMessageConverter.setSerializedPayloadClass(String.class);
 		jacksonMessageConverter.setStrictContentTypeMatch(true);
+
+		if (objectMapper != null) {
+			jacksonMessageConverter.setObjectMapper(objectMapper);
+		}
+
 		return jacksonMessageConverter;
 	}
 

spring-cloud-aws-messaging/src/main/java/org/springframework/cloud/aws/messaging/config/annotation/SqsConfiguration.java

@@ -19,6 +19,7 @@
 import java.util.Arrays;
 
 import com.amazonaws.services.sqs.AmazonSQSAsync;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.ObjectProvider;
@@ -54,12 +55,15 @@ public class SqsConfiguration {
 
 	private final MappingJackson2MessageConverter mappingJackson2MessageConverter;
 
+	private final ObjectMapper objectMapper;
+
 	public SqsConfiguration(
 			ObjectProvider<SimpleMessageListenerContainerFactory> simpleMessageListenerContainerFactory,
 			ObjectProvider<QueueMessageHandlerFactory> queueMessageHandlerFactory,
 			BeanFactory beanFactory,
 			ObjectProvider<ResourceIdResolver> resourceIdResolver,
-			ObjectProvider<MappingJackson2MessageConverter> mappingJackson2MessageConverter) {
+			ObjectProvider<MappingJackson2MessageConverter> mappingJackson2MessageConverter,
+			ObjectProvider<ObjectMapper> objectMapper) {
 		this.simpleMessageListenerContainerFactory = simpleMessageListenerContainerFactory
 				.getIfAvailable(SimpleMessageListenerContainerFactory::new);
 		this.queueMessageHandlerFactory = queueMessageHandlerFactory
@@ -68,6 +72,7 @@ public SqsConfiguration(
 		this.resourceIdResolver = resourceIdResolver.getIfAvailable();
 		this.mappingJackson2MessageConverter = mappingJackson2MessageConverter
 				.getIfAvailable();
+		this.objectMapper = objectMapper.getIfAvailable();
 	}
 
 	@Bean
@@ -111,6 +116,7 @@ private QueueMessageHandler getMessageHandler(AmazonSQSAsync amazonSqs) {
 		}
 
 		this.queueMessageHandlerFactory.setBeanFactory(this.beanFactory);
+		this.queueMessageHandlerFactory.setObjectMapper(this.objectMapper);
 
 		return this.queueMessageHandlerFactory.createQueueMessageHandler();
 	}

spring-cloud-aws-messaging/src/main/java/org/springframework/cloud/aws/messaging/core/support/AbstractMessageChannelMessagingSendingTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 the original author or authors.
+ * Copyright 2013-2020 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.
@@ -20,7 +20,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessagingException;
@@ -33,7 +32,6 @@
 import org.springframework.messaging.core.DestinationResolver;
 import org.springframework.messaging.core.DestinationResolvingMessageSendingOperations;
 import org.springframework.messaging.core.MessagePostProcessor;
-import org.springframework.util.ClassUtils;
 
 /**
  * @param <D> message channel type
@@ -45,10 +43,6 @@ public abstract class AbstractMessageChannelMessagingSendingTemplate<D extends M
 		extends AbstractMessageSendingTemplate<D>
 		implements DestinationResolvingMessageSendingOperations<D> {
 
-	private static final boolean JACKSON_2_PRESENT = ClassUtils.isPresent(
-			"com.fasterxml.jackson.databind.ObjectMapper",
-			AbstractMessageChannelMessagingSendingTemplate.class.getClassLoader());
-
 	private final DestinationResolver<String> destinationResolver;
 
 	protected AbstractMessageChannelMessagingSendingTemplate(
@@ -120,10 +114,8 @@ protected void initMessageConverter(MessageConverter messageConverter) {
 		if (messageConverter != null) {
 			messageConverters.add(messageConverter);
 		}
-		else if (JACKSON_2_PRESENT) {
+		else {
 			MappingJackson2MessageConverter mappingJackson2MessageConverter = new MappingJackson2MessageConverter();
-			mappingJackson2MessageConverter
-					.setObjectMapper(Jackson2ObjectMapperBuilder.json().build());
 			mappingJackson2MessageConverter.setSerializedPayloadClass(String.class);
 			messageConverters.add(mappingJackson2MessageConverter);
 		}

spring-cloud-aws-messaging/src/test/java/org/springframework/cloud/aws/messaging/config/annotation/SqsConfigurationTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 the original author or authors.
+ * Copyright 2013-2020 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.
@@ -17,6 +17,7 @@
 package org.springframework.cloud.aws.messaging.config.annotation;
 
 import java.util.Collections;
+import java.util.List;
 
 import com.amazonaws.auth.AWSCredentialsProvider;
 import com.amazonaws.auth.DefaultAWSCredentialsProviderChain;
@@ -25,6 +26,7 @@
 import com.amazonaws.services.sqs.AmazonSQSAsync;
 import com.amazonaws.services.sqs.AmazonSQSAsyncClient;
 import com.amazonaws.services.sqs.buffered.AmazonSQSBufferedAsyncClient;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.cloud.aws.context.config.annotation.EnableContextRegion;
@@ -40,6 +42,8 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.support.StaticApplicationContext;
 import org.springframework.core.task.SimpleAsyncTaskExecutor;
+import org.springframework.messaging.converter.MappingJackson2MessageConverter;
+import org.springframework.messaging.converter.MessageConverter;
 import org.springframework.messaging.core.DestinationResolver;
 import org.springframework.messaging.core.DestinationResolvingMessageSendingOperations;
 import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
@@ -52,6 +56,7 @@
 
 /**
  * @author Alain Sahli
+ * @author Maciej Walkowiak
  */
 class SqsConfigurationTest {
 
@@ -194,6 +199,25 @@ void queueMessageHandlerBeanMustBeSetOnContainer() throws Exception {
 				"messageHandler")).isEqualTo(queueMessageHandler);
 	}
 
+	@Test
+	void configuration_withObjectMapper_shouldSetObjectMapperOnQueueMessageHandler()
+			throws Exception {
+		// Arrange & Act
+		AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(
+				ConfigurationWithObjectMapper.class);
+		QueueMessageHandler queueMessageHandler = applicationContext
+				.getBean(QueueMessageHandler.class);
+		ObjectMapper objectMapper = applicationContext.getBean(ObjectMapper.class);
+		List<MessageConverter> converters = (List<MessageConverter>) ReflectionTestUtils
+				.getField(queueMessageHandler, "messageConverters");
+		MappingJackson2MessageConverter mappingJackson2MessageConverter = (MappingJackson2MessageConverter) converters
+				.get(0);
+
+		// Assert
+		assertThat(mappingJackson2MessageConverter.getObjectMapper())
+				.isEqualTo(objectMapper);
+	}
+
 	@Test
 	void configuration_withoutAwsCredentials_shouldCreateAClientWithDefaultCredentialsProvider()
 			throws Exception {
@@ -375,4 +399,16 @@ static class ConfigurationWithRegionProvider {
 
 	}
 
+	@EnableSqs
+	@EnableContextRegion(region = "eu-west-1")
+	@Configuration(proxyBeanMethods = false)
+	static class ConfigurationWithObjectMapper {
+
+		@Bean
+		ObjectMapper objectMapper() {
+			return new ObjectMapper();
+		}
+
+	}
+
 }

spring-cloud-aws-messaging/src/test/java/org/springframework/cloud/aws/messaging/core/QueueMessagingTemplateTest.java

@@ -16,7 +16,6 @@
 
 package org.springframework.cloud.aws.messaging.core;
 
-import java.io.IOException;
 import java.time.LocalDate;
 import java.util.Locale;
 
@@ -27,12 +26,10 @@
 import com.amazonaws.services.sqs.model.ReceiveMessageResult;
 import com.amazonaws.services.sqs.model.SendMessageRequest;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentCaptor;
 
 import org.springframework.cloud.aws.core.env.ResourceIdResolver;
-import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.converter.CompositeMessageConverter;
 import org.springframework.messaging.converter.MappingJackson2MessageConverter;
@@ -205,72 +202,26 @@ void instantiation_withConverter_shouldAddItToTheCompositeConverter() {
 		// Assert
 		assertThat(
 				((CompositeMessageConverter) queueMessagingTemplate.getMessageConverter())
-						.getConverters().size()).isEqualTo(2);
+						.getConverters()).hasSize(2);
 		assertThat(
 				((CompositeMessageConverter) queueMessagingTemplate.getMessageConverter())
 						.getConverters().get(1)).isEqualTo(simpleMessageConverter);
 	}
 
 	@Test
-	void instantiation_WithCustomJacksonConverterThatSupportsJava8Types_shouldConvertMessageToString()
-			throws IOException {
-
-		// Arrange
-		AmazonSQSAsync amazonSqs = createAmazonSqs();
-
-		ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json().build();
-
-		MappingJackson2MessageConverter simpleMessageConverter = new MappingJackson2MessageConverter();
-		simpleMessageConverter.setSerializedPayloadClass(String.class);
-		simpleMessageConverter.setObjectMapper(objectMapper);
-
-		QueueMessagingTemplate queueMessagingTemplate = new QueueMessagingTemplate(
-				amazonSqs, (ResourceIdResolver) null, simpleMessageConverter);
-
+	void instantiation_withoutConverter_shouldAddDefaultJacksonConverterToTheCompositeConverter() {
 		// Act
-		queueMessagingTemplate.convertAndSend("test",
-				new TestPerson("Agim", "Emruli", LocalDate.of(2017, 1, 1)));
-
-		// Assert
-		ArgumentCaptor<SendMessageRequest> sendMessageRequestArgumentCaptor = ArgumentCaptor
-				.forClass(SendMessageRequest.class);
-		verify(amazonSqs).sendMessage(sendMessageRequestArgumentCaptor.capture());
-		TestPerson testPerson = objectMapper.readValue(
-				sendMessageRequestArgumentCaptor.getValue().getMessageBody(),
-				TestPerson.class);
-
-		assertThat(testPerson.getFirstName()).isEqualTo("Agim");
-		assertThat(testPerson.getLastName()).isEqualTo("Emruli");
-		assertThat(testPerson.getActiveSince()).isEqualTo(LocalDate.of(2017, 1, 1));
-	}
-
-	@Test
-	void instantiation_withDefaultMapping2JacksonConverter_shouldSupportJava8Types()
-			throws IOException {
-
-		// Arrange
-		AmazonSQSAsync amazonSqs = createAmazonSqs();
-
-		ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json().build();
-
 		QueueMessagingTemplate queueMessagingTemplate = new QueueMessagingTemplate(
-				amazonSqs);
-
-		// Act
-		queueMessagingTemplate.convertAndSend("test",
-				new TestPerson("Agim", "Emruli", LocalDate.of(2017, 1, 1)));
+				createAmazonSqs(), (ResourceIdResolver) null, null);
 
 		// Assert
-		ArgumentCaptor<SendMessageRequest> sendMessageRequestArgumentCaptor = ArgumentCaptor
-				.forClass(SendMessageRequest.class);
-		verify(amazonSqs).sendMessage(sendMessageRequestArgumentCaptor.capture());
-		TestPerson testPerson = objectMapper.readValue(
-				sendMessageRequestArgumentCaptor.getValue().getMessageBody(),
-				TestPerson.class);
-
-		assertThat(testPerson.getFirstName()).isEqualTo("Agim");
-		assertThat(testPerson.getLastName()).isEqualTo("Emruli");
-		assertThat(testPerson.getActiveSince()).isEqualTo(LocalDate.of(2017, 1, 1));
+		assertThat(
+				((CompositeMessageConverter) queueMessagingTemplate.getMessageConverter())
+						.getConverters()).hasSize(2);
+		assertThat(
+				((CompositeMessageConverter) queueMessagingTemplate.getMessageConverter())
+						.getConverters().get(1))
+								.isInstanceOf(MappingJackson2MessageConverter.class);
 	}
 
 	private AmazonSQSAsync createAmazonSqs() {