spring-projectsGH-1926 - Avoid wrapping nested entities ultimately to represent a value.

NestedEntitySerializer now skips the wrapping into an EntityModel if the target serializer is a JsonValueSerializer as EntityModel requires the value to ultimately resolve into key value pairs as it's only enriching something that's rendered as JSON document with hypermedia elements.

Author: odrotbohm

spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/json/PersistentEntityJackson2Module.java

@@ -86,6 +86,7 @@
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;
 import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
+import com.fasterxml.jackson.databind.ser.std.JsonValueSerializer;
 import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer;
 import com.fasterxml.jackson.databind.ser.std.StdSerializer;
 import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
@@ -365,7 +366,7 @@ public void serialize(Object value, JsonGenerator gen, SerializerProvider provid
 				List<Object> resources = new ArrayList<Object>();
 
 				for (Object element : source) {
-					resources.add(toModel(element));
+					resources.add(toModel(element, provider));
 				}
 
 				provider.defaultSerializeValue(resources, gen);
@@ -376,13 +377,13 @@ public void serialize(Object value, JsonGenerator gen, SerializerProvider provid
 				Map<Object, Object> resources = CollectionFactory.createApproximateMap(value.getClass(), source.size());
 
 				for (Entry<?, ?> entry : source.entrySet()) {
-					resources.put(entry.getKey(), toModel(entry.getValue()));
+					resources.put(entry.getKey(), toModel(entry.getValue(), provider));
 				}
 
 				provider.defaultSerializeValue(resources, gen);
 
 			} else {
-				provider.defaultSerializeValue(toModel(value), gen);
+				provider.defaultSerializeValue(toModel(value, provider), gen);
 			}
 		}
 
@@ -396,7 +397,13 @@ public void serializeWithType(Object value, JsonGenerator gen, SerializerProvide
 			serialize(value, gen, provider);
 		}
 
-		private EntityModel<Object> toModel(Object value) {
+		private Object toModel(Object value, SerializerProvider provider) throws JsonMappingException {
+
+			JsonSerializer<Object> serializer = provider.findValueSerializer(value.getClass());
+
+			if (JsonValueSerializer.class.isInstance(serializer)) {
+				return value;
+			}
 
 			PersistentEntity<?, ?> entity = entities.getRequiredPersistentEntity(value.getClass());
 

spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/json/PersistentEntityJackson2ModuleUnitTests.java

@@ -19,6 +19,7 @@
 import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 
+import lombok.Data;
 import lombok.Getter;
 
 import java.io.IOException;
@@ -58,6 +59,7 @@
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonValue;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.jayway.jsonpath.JsonPath;
@@ -89,6 +91,7 @@ public void setUp() {
 		mappingContext.getPersistentEntity(SampleWithAdditionalGetters.class);
 		mappingContext.getPersistentEntity(PersistentEntityJackson2ModuleUnitTests.PetOwner.class);
 		mappingContext.getPersistentEntity(Immutable.class);
+		mappingContext.getPersistentEntity(Wrapper.class);
 
 		this.persistentEntities = new PersistentEntities(Arrays.asList(mappingContext));
 
@@ -197,6 +200,16 @@ public void customizesDeserializerForCreatorProperties() throws Exception {
 				TypeDescriptor.valueOf(Home.class));
 	}
 
+	@Test // GH-1926
+	public void doesNotWrapJsonValueTypesIntoEntityModel() throws Exception {
+
+		Wrapper wrapper = new Wrapper();
+		wrapper.value = new ValueType();
+		wrapper.value.value = "sample";
+
+		assertThat(mapper.writeValueAsString(wrapper)).isEqualTo("{\"value\":\"sample\"}");
+	}
+
 	/**
 	 * @author Oliver Gierke
 	 */
@@ -257,4 +270,15 @@ public Immutable(@JsonProperty("home") Home home) {
 			this.home = home;
 		}
 	}
+
+	// GH-1926
+
+	@Data
+	static class Wrapper {
+		ValueType value;
+	}
+
+	static class ValueType {
+		@JsonValue String value;
+	}
 }