Apply spring.jackson.* config to Spring Data REST object mappers

wilkinsona · wilkinsona · commit 261b3afca1a8 · 2014-10-15T16:57:06.000+01:00
Closes spring-projectsgh-1698
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestMvcAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestMvcAutoConfiguration.java
@@ -16,6 +16,7 @@
 
 package org.springframework.boot.autoconfigure.data.rest;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -25,6 +26,9 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration;
+import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for Spring Data Rest's MVC
@@ -50,12 +54,22 @@ public class RepositoryRestMvcAutoConfiguration {
 	static class RepositoryRestMvcBootConfiguration extends
 			RepositoryRestMvcConfiguration {
 
+		@Autowired(required = false)
+		private Jackson2ObjectMapperBuilder objectMapperBuilder;
+
 		@Bean
 		@ConfigurationProperties(prefix = "spring.data.rest")
 		@Override
 		public RepositoryRestConfiguration config() {
 			return super.config();
 		}
 
+		@Override
+		protected void configureJacksonObjectMapper(ObjectMapper objectMapper) {
+			if (this.objectMapperBuilder != null) {
+				this.objectMapperBuilder.configure(objectMapper);
+			}
+		}
+
 	}
 }
diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestMvcAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestMvcAutoConfigurationTests.java
@@ -17,6 +17,7 @@
 package org.springframework.boot.autoconfigure.data.rest;
 
 import java.net.URI;
+import java.util.Date;
 
 import org.junit.After;
 import org.junit.Test;
@@ -27,22 +28,28 @@
 import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
 import org.springframework.boot.test.EnvironmentTestUtils;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.data.rest.webmvc.BaseUri;
 import org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration;
+import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
 import org.springframework.mock.web.MockServletContext;
 import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 
 /**
  * Tests for {@link RepositoryRestMvcAutoConfiguration}.
  *
  * @author Rob Winch
+ * @author Andy Wilkinson
  */
 public class RepositoryRestMvcAutoConfigurationTests {
 
@@ -85,6 +92,23 @@ public void backOffWithCustomConfiguration() {
 
 	}
 
+	@Test
+	public void objectMappersAreConfiguredUsingObjectMapperBuilder()
+			throws JsonProcessingException {
+		load(TestConfigurationWithObjectMapperBuilder.class);
+
+		assertThatDateIsFormattedCorrectly("halObjectMapper");
+		assertThatDateIsFormattedCorrectly("objectMapper");
+	}
+
+	public void assertThatDateIsFormattedCorrectly(String beanName)
+			throws JsonProcessingException {
+		ObjectMapper objectMapper = this.context.getBean(beanName, ObjectMapper.class);
+
+		assertEquals("\"2014-10\"",
+				objectMapper.writeValueAsString(new Date(1413387983267L)));
+	}
+
 	private void load(Class<?> config, String... environment) {
 		AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext();
 		applicationContext.setServletContext(new MockServletContext());
@@ -110,4 +134,17 @@ protected static class TestConfigurationWithRestMvcConfig {
 
 	}
 
+	@Configuration
+	@TestAutoConfigurationPackage(City.class)
+	@EnableWebMvc
+	static class TestConfigurationWithObjectMapperBuilder {
+
+		@Bean
+		public Jackson2ObjectMapperBuilder objectMapperBuilder() {
+			Jackson2ObjectMapperBuilder objectMapperBuilder = new Jackson2ObjectMapperBuilder();
+			objectMapperBuilder.simpleDateFormat("yyyy-MM");
+			return objectMapperBuilder;
+		}
+	}
+
 }
