Set Jackson DEFAULT_VIEW_INCLUSION property to false by default

sdeleuze · sdeleuze · commit 77abe07807ad · 2014-09-30T05:18:15.000+02:00
Issue: SPR-12179
diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java b/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java
@@ -47,6 +47,12 @@
 /**
  * A builder used to create {@link ObjectMapper} instances with a fluent API.
  *
+ * <p>It customizes Jackson defaults properties with the following ones:
+ * <ul>
+ *  <li>{@link MapperFeature#DEFAULT_VIEW_INCLUSION} is disabled</li>
+ *  <li>{@link DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES} is disabled</li>
+ * </ul>
+ *
  * <p>Note that Jackson's JSR-310 and Joda-Time support modules will be registered automatically
  * when available (and when Java 8 and Joda-Time themselves are available, respectively).
  *
@@ -384,6 +390,9 @@ public <T extends ObjectMapper> T build() {
 			this.objectMapper.registerModule(module);
 		}
 
+		if(!features.containsKey(MapperFeature.DEFAULT_VIEW_INCLUSION)) {
+			configureFeature(MapperFeature.DEFAULT_VIEW_INCLUSION, false);
+		}
 		if(!features.containsKey(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)) {
 			configureFeature(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 		}
diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java b/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java
@@ -52,6 +52,12 @@
  * {@link XmlMapper} ({@code createXmlMapper} property set to true) with setters
  * to enable or disable Jackson features from within XML configuration.
  *
+ * <p>It customizes Jackson defaults properties with the following ones:
+ * <ul>
+ *  <li>{@link MapperFeature#DEFAULT_VIEW_INCLUSION} is disabled</li>
+ *  <li>{@link DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES} is disabled</li>
+ * </ul>
+ *
  * <p>Example usage with
  * {@link MappingJackson2HttpMessageConverter}:
  *
@@ -413,6 +419,9 @@ public void afterPropertiesSet() {
 			this.objectMapper.registerModule(module);
 		}
 
+		if(!features.containsKey(MapperFeature.DEFAULT_VIEW_INCLUSION)) {
+			configureFeature(MapperFeature.DEFAULT_VIEW_INCLUSION, false);
+		}
 		if(!features.containsKey(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)) {
 			configureFeature(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 		}
diff --git a/spring-web/src/test/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilderTests.java b/spring-web/src/test/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilderTests.java
@@ -80,7 +80,7 @@ public void unknownFeature() {
 	public void defaultProperties() {
 		ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json().build();
 		assertNotNull(objectMapper);
-		assertTrue(objectMapper.isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+		assertFalse(objectMapper.isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
 		assertFalse(objectMapper.isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
 		assertTrue(objectMapper.isEnabled(MapperFeature.AUTO_DETECT_FIELDS));
 		assertTrue(objectMapper.isEnabled(MapperFeature.AUTO_DETECT_GETTERS));
@@ -240,7 +240,7 @@ public void completeSetup() {
 		assertTrue(objectMapper.getFactory().isEnabled(JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS));
 
 		assertFalse(objectMapper.getSerializationConfig().isEnabled(MapperFeature.AUTO_DETECT_GETTERS));
-		assertTrue(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+		assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
 		assertFalse(objectMapper.getDeserializationConfig().isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
 		assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.AUTO_DETECT_FIELDS));
 		assertFalse(objectMapper.getFactory().isEnabled(JsonParser.Feature.AUTO_CLOSE_SOURCE));
diff --git a/spring-web/src/test/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBeanTests.java b/spring-web/src/test/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBeanTests.java
@@ -259,7 +259,7 @@ public void completeSetup() {
 		assertTrue(objectMapper.getFactory().isEnabled(JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS));
 
 		assertFalse(objectMapper.getSerializationConfig().isEnabled(MapperFeature.AUTO_DETECT_GETTERS));
-		assertTrue(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+		assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
 		assertFalse(objectMapper.getDeserializationConfig().isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
 		assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.AUTO_DETECT_FIELDS));
 		assertFalse(objectMapper.getFactory().isEnabled(JsonParser.Feature.AUTO_CLOSE_SOURCE));
diff --git a/spring-web/src/test/java/org/springframework/http/converter/json/MappingJackson2HttpMessageConverterTests.java b/spring-web/src/test/java/org/springframework/http/converter/json/MappingJackson2HttpMessageConverterTests.java
@@ -255,7 +255,7 @@ public void jsonView() throws Exception {
 		String result = outputMessage.getBodyAsString(Charset.forName("UTF-8"));
 		assertThat(result, containsString("\"withView1\":\"with\""));
 		assertThat(result, not(containsString("\"withView2\":\"with\"")));
-		assertThat(result, containsString("\"withoutView\":\"without\""));
+		assertThat(result, not(containsString("\"withoutView\":\"without\"")));
 	}
 
 	@Test
@@ -288,7 +288,7 @@ public void jsonpAndJsonView() throws Exception {
 		assertThat(result, endsWith(");"));
 		assertThat(result, containsString("\"withView1\":\"with\""));
 		assertThat(result, not(containsString("\"withView2\":\"with\"")));
-		assertThat(result, containsString("\"withoutView\":\"without\""));
+		assertThat(result, not(containsString("\"withoutView\":\"without\"")));
 	}
 
 
diff --git a/spring-web/src/test/java/org/springframework/http/converter/xml/MappingJackson2XmlHttpMessageConverterTests.java b/spring-web/src/test/java/org/springframework/http/converter/xml/MappingJackson2XmlHttpMessageConverterTests.java
@@ -126,7 +126,7 @@ public void jsonView() throws Exception {
 		String result = outputMessage.getBodyAsString(Charset.forName("UTF-8"));
 		assertThat(result, containsString("<withView1>with</withView1>"));
 		assertThat(result, not(containsString("<withView2>with</withView2>")));
-		assertThat(result, containsString("<withoutView>without</withoutView>"));
+		assertThat(result, not(containsString("<withoutView>without</withoutView>")));
 	}
 
 	@Test
diff --git a/spring-web/src/test/java/org/springframework/web/client/RestTemplateIntegrationTests.java b/spring-web/src/test/java/org/springframework/web/client/RestTemplateIntegrationTests.java
@@ -226,7 +226,7 @@ public void jsonPostForObjectWithJacksonView() throws URISyntaxException {
 		String s = template.postForObject(baseUrl + "/jsonpost", entity, String.class, "post");
 		assertTrue(s.contains("\"with1\":\"with\""));
 		assertFalse(s.contains("\"with2\":\"with\""));
-		assertTrue(s.contains("\"without\":\"without\""));
+		assertFalse(s.contains("\"without\":\"without\""));
 	}
 
 	// SPR-12123
diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/MvcNamespaceTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/MvcNamespaceTests.java
@@ -173,8 +173,8 @@ public void testDefaultConfig() throws Exception {
 		for(HttpMessageConverter<?> converter : converters) {
 			if(converter instanceof AbstractJackson2HttpMessageConverter) {
 				ObjectMapper objectMapper = ((AbstractJackson2HttpMessageConverter)converter).getObjectMapper();
-				assertTrue(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
-				assertTrue(objectMapper.getSerializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+				assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+				assertFalse(objectMapper.getSerializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
 				assertFalse(objectMapper.getDeserializationConfig().isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
 				if(converter instanceof MappingJackson2XmlHttpMessageConverter) {
 					assertEquals(XmlMapper.class, objectMapper.getClass());
diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportExtensionTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportExtensionTests.java
@@ -162,8 +162,8 @@ public void requestMappingHandlerAdapter() throws Exception {
 		assertEquals(1, adapter.getMessageConverters().size());
 		assertEquals(MappingJackson2HttpMessageConverter.class, adapter.getMessageConverters().get(0).getClass());
 		ObjectMapper objectMapper = ((MappingJackson2HttpMessageConverter)adapter.getMessageConverters().get(0)).getObjectMapper();
-		assertTrue(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
-		assertTrue(objectMapper.getSerializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+		assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+		assertFalse(objectMapper.getSerializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
 		assertFalse(objectMapper.getDeserializationConfig().isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
 
 		DirectFieldAccessor fieldAccessor = new DirectFieldAccessor(adapter);
diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportTests.java
@@ -162,8 +162,8 @@ public void requestMappingHandlerAdapter() throws Exception {
 		for(HttpMessageConverter<?> converter : converters) {
 			if(converter instanceof AbstractJackson2HttpMessageConverter) {
 				ObjectMapper objectMapper = ((AbstractJackson2HttpMessageConverter)converter).getObjectMapper();
-				assertTrue(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
-				assertTrue(objectMapper.getSerializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+				assertFalse(objectMapper.getDeserializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+				assertFalse(objectMapper.getSerializationConfig().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
 				assertFalse(objectMapper.getDeserializationConfig().isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
 				if(converter instanceof MappingJackson2XmlHttpMessageConverter) {
 					assertEquals(XmlMapper.class, objectMapper.getClass());
diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/RequestResponseBodyMethodProcessorTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/RequestResponseBodyMethodProcessorTests.java
@@ -322,7 +322,7 @@ public void jacksonJsonViewWithResponseBodyAndJsonMessageConverter() throws Exce
 		String content = this.servletResponse.getContentAsString();
 		assertFalse(content.contains("\"withView1\":\"with\""));
 		assertTrue(content.contains("\"withView2\":\"with\""));
-		assertTrue(content.contains("\"withoutView\":\"without\""));
+		assertFalse(content.contains("\"withoutView\":\"without\""));
 	}
 
 	@Test
@@ -343,7 +343,7 @@ public void jacksonJsonViewWithResponseEntityAndJsonMessageConverter() throws Ex
 		String content = this.servletResponse.getContentAsString();
 		assertFalse(content.contains("\"withView1\":\"with\""));
 		assertTrue(content.contains("\"withView2\":\"with\""));
-		assertTrue(content.contains("\"withoutView\":\"without\""));
+		assertFalse(content.contains("\"withoutView\":\"without\""));
 	}
 
 	// SPR-12149
@@ -366,7 +366,7 @@ public void jacksonJsonViewWithResponseBodyAndXmlMessageConverter() throws Excep
 		String content = this.servletResponse.getContentAsString();
 		assertFalse(content.contains("<withView1>with</withView1>"));
 		assertTrue(content.contains("<withView2>with</withView2>"));
-		assertTrue(content.contains("<withoutView>without</withoutView>"));
+		assertFalse(content.contains("<withoutView>without</withoutView>"));
 	}
 
 	// SPR-12149
@@ -389,7 +389,7 @@ public void jacksonJsonViewWithResponseEntityAndXmlMessageConverter() throws Exc
 		String content = this.servletResponse.getContentAsString();
 		assertFalse(content.contains("<withView1>with</withView1>"));
 		assertTrue(content.contains("<withView2>with</withView2>"));
-		assertTrue(content.contains("<withoutView>without</withoutView>"));
+		assertFalse(content.contains("<withoutView>without</withoutView>"));
 	}
 
 

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,12 @@`
`47`	`47`	`/**`
`48`	`48`	`* A builder used to create {@link ObjectMapper} instances with a fluent API.`
`49`	`49`	`*`
	`50`	`+ * <p>It customizes Jackson defaults properties with the following ones:`
	`51`	`+ * <ul>`
	`52`	`+ * <li>{@link MapperFeature#DEFAULT_VIEW_INCLUSION} is disabled</li>`
	`53`	`+ * <li>{@link DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES} is disabled</li>`
	`54`	`+ * </ul>`
	`55`	`+ *`
`50`	`56`	`* <p>Note that Jackson's JSR-310 and Joda-Time support modules will be registered automatically`
`51`	`57`	`* when available (and when Java 8 and Joda-Time themselves are available, respectively).`
`52`	`58`	`*`
`@@ -384,6 +390,9 @@ public <T extends ObjectMapper> T build() {`
`384`	`390`	`this.objectMapper.registerModule(module);`
`385`	`391`	`}`
`386`	`392`
	`393`	`+ if(!features.containsKey(MapperFeature.DEFAULT_VIEW_INCLUSION)) {`
	`394`	`+ configureFeature(MapperFeature.DEFAULT_VIEW_INCLUSION, false);`
	`395`	`+ }`
`387`	`396`	`if(!features.containsKey(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)) {`
`388`	`397`	`configureFeature(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);`
`389`	`398`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,12 @@`
`52`	`52`	`* {@link XmlMapper} ({@code createXmlMapper} property set to true) with setters`
`53`	`53`	`* to enable or disable Jackson features from within XML configuration.`
`54`	`54`	`*`
	`55`	`+ * <p>It customizes Jackson defaults properties with the following ones:`
	`56`	`+ * <ul>`
	`57`	`+ * <li>{@link MapperFeature#DEFAULT_VIEW_INCLUSION} is disabled</li>`
	`58`	`+ * <li>{@link DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES} is disabled</li>`
	`59`	`+ * </ul>`
	`60`	`+ *`
`55`	`61`	`* <p>Example usage with`
`56`	`62`	`* {@link MappingJackson2HttpMessageConverter}:`
`57`	`63`	`*`
`@@ -413,6 +419,9 @@ public void afterPropertiesSet() {`
`413`	`419`	`this.objectMapper.registerModule(module);`
`414`	`420`	`}`
`415`	`421`
	`422`	`+ if(!features.containsKey(MapperFeature.DEFAULT_VIEW_INCLUSION)) {`
	`423`	`+ configureFeature(MapperFeature.DEFAULT_VIEW_INCLUSION, false);`
	`424`	`+ }`
`416`	`425`	`if(!features.containsKey(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)) {`
`417`	`426`	`configureFeature(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);`
`418`	`427`	`}`
Original file line number	Diff line number	Diff line change
`@@ -255,7 +255,7 @@ public void jsonView() throws Exception {`
`255`	`255`	`String result = outputMessage.getBodyAsString(Charset.forName("UTF-8"));`
`256`	`256`	`assertThat(result, containsString("\"withView1\":\"with\""));`
`257`	`257`	`assertThat(result, not(containsString("\"withView2\":\"with\"")));`
`258`		`- assertThat(result, containsString("\"withoutView\":\"without\""));`
	`258`	`+ assertThat(result, not(containsString("\"withoutView\":\"without\"")));`
`259`	`259`	`}`
`260`	`260`
`261`	`261`	`@Test`
`@@ -288,7 +288,7 @@ public void jsonpAndJsonView() throws Exception {`
`288`	`288`	`assertThat(result, endsWith(");"));`
`289`	`289`	`assertThat(result, containsString("\"withView1\":\"with\""));`
`290`	`290`	`assertThat(result, not(containsString("\"withView2\":\"with\"")));`
`291`		`- assertThat(result, containsString("\"withoutView\":\"without\""));`
	`291`	`+ assertThat(result, not(containsString("\"withoutView\":\"without\"")));`
`292`	`292`	`}`
`293`	`293`
`294`	`294`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public void jsonView() throws Exception {`
`126`	`126`	`String result = outputMessage.getBodyAsString(Charset.forName("UTF-8"));`
`127`	`127`	`assertThat(result, containsString("<withView1>with</withView1>"));`
`128`	`128`	`assertThat(result, not(containsString("<withView2>with</withView2>")));`
`129`		`- assertThat(result, containsString("<withoutView>without</withoutView>"));`
	`129`	`+ assertThat(result, not(containsString("<withoutView>without</withoutView>")));`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`@Test`
Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ public void jsonPostForObjectWithJacksonView() throws URISyntaxException {`
`226`	`226`	`String s = template.postForObject(baseUrl + "/jsonpost", entity, String.class, "post");`
`227`	`227`	`assertTrue(s.contains("\"with1\":\"with\""));`
`228`	`228`	`assertFalse(s.contains("\"with2\":\"with\""));`
`229`		`- assertTrue(s.contains("\"without\":\"without\""));`
	`229`	`+ assertFalse(s.contains("\"without\":\"without\""));`
`230`	`230`	`}`
`231`	`231`
`232`	`232`	`// SPR-12123`