Spring/spring-hateoas
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#1686 - Avoid serializing empty beans in EntityModel.

Browse Source 
The unwrapping nature of EntityModel.getContent() does not work well with value that would result in an empty object being rendered. We now skip the rendering if failing for empty beans is disabled.
This commit is contained in:
Oliver Drotbohm
2021-10-19 13:54:18 +02:00
parent e0f1643448
commit 2cac83fcef
2 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/org/springframework/hateoas/EntityModel.java
View File

@@ -33,9 +33,11 @@ import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import com.fasterxml.jackson.databind.ser.impl.UnknownSerializer;
import com.fasterxml.jackson.databind.ser.std.JsonValueSerializer;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import com.fasterxml.jackson.databind.util.NameTransformer;
@@ -225,6 +227,11 @@ public class EntityModel<T> extends RepresentationModel<EntityModel<T>> {
JsonSerializer<Object> serializer = provider.findValueSerializer(value.getClass());
if (UnknownSerializer.class.isInstance(serializer)
&& !provider.isEnabled(SerializationFeature.FAIL_ON_EMPTY_BEANS)) {
return;
}
if (JsonValueSerializer.class.isInstance(serializer)) {
throw new IllegalStateException(
"@JsonValue rendered classes can not be directly nested in EntityModel as they do not produce a document key!");

21
src/test/java/org/springframework/hateoas/EntityModelIntegrationTest.java
View File

@@ -21,6 +21,9 @@ import org.junit.jupiter.api.Test;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
/**
* Integration tests for {@link EntityModel}.
@@ -59,6 +62,22 @@ class EntityModelIntegrationTest extends AbstractJackson2MarshallingIntegrationT
assertThat(result.getContent().lastname).isEqualTo("Matthews");
}
@Test // #1686
void doesNotFailOnSerializingEmptyBean() {
ObjectMapper mapper = MappingTestUtils.defaultObjectMapper();
// Fail if we're supposed to
assertThatExceptionOfType(JsonMappingException.class) //
.isThrownBy(() -> mapper.enable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
.writeValueAsString(EntityModel.of(new Empty())));
// Ignore empty bean if we're supposed to
assertThatNoException() //
.isThrownBy(() -> mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
.writeValueAsString(EntityModel.of(new Empty())));
}
static class PersonModel extends EntityModel<Person> {
public PersonModel(Person person) {
@@ -74,4 +93,6 @@ class EntityModelIntegrationTest extends AbstractJackson2MarshallingIntegrationT
String firstname;
String lastname;
}
static class Empty {}
}