Do not serialize subtype properties with Jackson in Spring MVC 3

Question

I am using Spring MVC with a controller like this:

@RequestMapping(value = "/list", method = RequestMethod.GET, produces = "application/json")
public @ResponseBody List<Service> list() {
return services.list();
}

The model is like this:

public class Service {
 private User user;
 ...
}

public class User {
 private String name;
 ...
}

public class ExtendedUser extends User {
 private Location location;
 ...
}

For sure, an object of type ExtendedUser is created in the application and set in Service. When the controller /list answer the request, an object of type ExtendedUser is serialized despite the reference in Service class is User. I would like to know if there is some way with annotations to only serialize supertype (the referenced type) and avoid the subtype propierties.

Taking the example into account, I want a JSON without the location property to be returned.

Thanks in advance

I am using jackson-mapper-asl-1.9.3 through org.springframework.web.servlet.view.json — Jonás, Oct 22 '13 at 14:13

score 0 · Answer 1 · answered Oct 22 '13 at 13:28

0

Try @JsonInclude(Include.NON_NULL) on ExtendedUser

answered Oct 22 '13 at 13:28

mvb13

1,514
3
18
33

score 0 · Answer 2 · answered Oct 22 '13 at 13:37

0

Your statement of "I want a JSON without the location property to be returned" can easily be accomplished using the @JsonIngore annotation:

public class ExtendedUser extends User {
    @JsonIgnore
    private Location location;
     ...
}

Is that what you're trying to do, though, just eliminate the location from the response, or does the actual type returned (type id) matter? If I'm off base, please post your expected JSON result and your actual JSON result.

answered Oct 22 '13 at 13:37

MattSenter

3,060
18
18

That was only an example. I don't want the subtype properties to be included in the serialization. One of them is Location but there are some others. – Jonás Oct 22 '13 at 13:39

score 0 · Answer 3 · edited May 23 '17 at 11:43

0

I think this will do the trick:

@JsonSerialize(using=User.class)

See this related answer: https://stackoverflow.com/a/13926740/1292605

edited May 23 '17 at 11:43

Community

1
1

answered Oct 22 '13 at 14:17

Pith

3,706
3
31
44

score 0 · Answer 4 · answered Jan 31 '19 at 07:51

I recommend to use as property of @JsonSerialize. BTW, @JsonSerialize can be declared on the fields so that it will not impact the common behavior of serialization of User or ExtendedUser.

public class Service {
  @JsonSerialize(as = User.class)
  private User user;
  ...
}

Do not serialize subtype properties with Jackson in Spring MVC 3

4 Answers4