Configuring ObjectMapper in Spring

Question

my goal is to configure the objectMapper in the way that it only serialises element which are annotated with  JsonProperty   In order to do so I followed this explanation which says how to configurate the objectmapper   I included the custom objectmapper as described here   However when the class NumbersOfNewEvents is serialized it still contains all attributes in the json   Does anybody have a hint  Thanks in advance  Jackson 1 8 0 spring 3 0 5  CustomObjectMapper  public class CompanyObjectMapper extends ObjectMapper       public CompanyObjectMapper             super            setVisibilityChecker getSerializationConfig                    getDefaultVisibilityChecker                    withCreatorVisibility JsonAutoDetect Visibility NONE                   withFieldVisibility JsonAutoDetect Visibility NONE                   withGetterVisibility JsonAutoDetect Visibility NONE                   withIsGetterVisibility JsonAutoDetect Visibility NONE                   withSetterVisibility JsonAutoDetect Visibility DEFAULT              servlet xml   lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance      xmlns context  http   www springframework org schema context      xmlns mvc  http   www springframework org schema mvc      xsi schemaLocation  http   www springframework org schema beans http   www springframework org schema beans spring-beans xsd         http   www springframework org schema context http   www springframework org schema context spring-context-3 0 xsd         http   www springframework org schema mvc http   www springframework org schema mvc spring-mvc-3 0 xsd  gt        lt context component-scan base-package  de Company backend web    gt        lt mvc annotation-driven   gt        lt bean         class  org springframework web servlet mvc annotation AnnotationMethodHandlerAdapter  gt           lt property name  messageConverters  gt               lt list gt                   lt bean class  org springframework http converter json MappingJacksonHttpMessageConverter  gt                       lt property name  objectMapper  ref  jacksonObjectMapper    gt                   lt  bean gt               lt  list gt           lt  property gt       lt  bean gt        lt bean id  jacksonObjectMapper  class  de Company backend web CompanyObjectMapper    gt   lt  beans gt    NumbersOfNewEvents  public class NumbersOfNewEvents implements StatusAttribute        public Integer newAccepts      public Integer openRequests       public NumbersOfNewEvents             super

User · Answer

There is org springframework http converter json Jackson2ObjectMapperFactoryBean for a long time  Starting from 1 2 release of Spring Boot there is org springframework http converter json Jackson2ObjectMapperBuilder for Java Config   In String Boot configuration can be as simple as   spring jackson deserialization  lt feature name gt  true false spring jackson generator  lt feature name gt  true false spring jackson mapper  lt feature name gt  true false spring jackson parser  lt feature name gt  true false spring jackson serialization  lt feature name gt  true false spring jackson default-property-inclusion always non null non absent non default non empty   in classpath application properties or some Java code in  Configuration class    Bean public Jackson2ObjectMapperBuilder jacksonBuilder         Jackson2ObjectMapperBuilder builder   new Jackson2ObjectMapperBuilder        builder indentOutput true  dateFormat new SimpleDateFormat  yyyy-MM-dd         return builder      See    Official docs 74 3 Customize the Jackson ObjectMapper https   dzone com articles latest-jackson-integration How do you globally set Jackson to ignore unknown properties within Spring  http   docs spring io spring-framework docs current javadoc-api org springframework http converter json Jackson2ObjectMapperFactoryBean html

User · Answer

I ve used this with Jackson 2 x and Spring 3 1 2   servlet-context xml   Note that the root element is  lt beans beans gt   so you may need to remove beans and add mvc to some of these elements depending on your setup        lt annotation-driven gt           lt message-converters gt               lt beans bean                 class  org springframework http converter StringHttpMessageConverter    gt               lt beans bean                 class  org springframework http converter ResourceHttpMessageConverter    gt               lt beans bean                 class  org springframework http converter json MappingJackson2HttpMessageConverter  gt                   lt beans property name  objectMapper  ref  jacksonObjectMapper    gt               lt  beans bean gt           lt  message-converters gt       lt  annotation-driven gt        lt beans bean id  jacksonObjectMapper          class  au edu unimelb atcom transfer json mappers JSONMapper    gt    au edu unimelb atcom transfer json mappers JSONMapper java   public class JSONMapper extends ObjectMapper        public JSONMapper             SimpleModule module   new SimpleModule  JSONModule   new Version 2  0  0  null  null  null            module addSerializer Date class  new DateSerializer             module addDeserializer Date class  new DateDeserializer                Add more here             registerModule module              DateSerializer java   public class DateSerializer extends StdSerializer lt Date gt         public DateSerializer             super Date class               Override     public void serialize Date date  JsonGenerator json              SerializerProvider provider  throws IOException              JsonGenerationException              The client side will handle presentation  we just want it accurate         DateFormat df   StdDateFormat getBlueprintISO8601Format            String out   df format date           json writeString out              DateDeserializer java   public class DateDeserializer extends StdDeserializer lt Date gt         public DateDeserializer             super Date class               Override     public Date deserialize JsonParser json  DeserializationContext context              throws IOException  JsonProcessingException           try               DateFormat df   StdDateFormat getBlueprintISO8601Format                return df parse json getText               catch  ParseException e                return null

User · Answer

To configure a message converter in plain spring-web  in this case to enable the Java 8 JSR-310 JavaTimeModule  you first need to implement WebMvcConfigurer in your  Configuration class and then override the configureMessageConverters method    Override public void configureMessageConverters List lt HttpMessageConverter lt   gt  gt  converters        ObjectMapper objectMapper   Jackson2ObjectMapperBuilder json   modules new JavaTimeModule    new Jdk8Module    build                configure SerializationFeature WRITE DATES AS TIMESTAMPS  false       converters add new MappingJackson2HttpMessageConverter objectMapper        Like this you can register any custom defined ObjectMapper in a Java-based Spring configuration

User · Answer

If you want to add custom ObjectMapper for registering custom serializers  try my answer   In my case  Spring 3 2 4 and Jackson 2 3 1   XML configuration for custom serializer      lt mvc annotation-driven gt       lt mvc message-converters register-defaults  false  gt           lt bean class  org springframework http converter json MappingJackson2HttpMessageConverter  gt               lt property name  objectMapper  gt                   lt bean class  org springframework http converter json Jackson2ObjectMapperFactoryBean  gt                       lt property name  serializers  gt                           lt array gt                               lt bean class  com example business serializer json CustomObjectSerializer   gt                           lt  array gt                       lt  property gt                   lt  bean gt               lt  property gt           lt  bean gt       lt  mvc message-converters gt   lt  mvc annotation-driven gt    was in unexplained way overwritten back to default by something   This worked for me   CustomObject java     JsonSerialize using   CustomObjectSerializer class  public class CustomObject        private Long value       public Long getValue             return value             public void setValue Long value            this value   value            CustomObjectSerializer java    public class CustomObjectSerializer extends JsonSerializer lt CustomObject gt          Override     public void serialize CustomObject value  JsonGenerator jgen          SerializerProvider provider  throws IOException JsonProcessingException           jgen writeStartObject            jgen writeNumberField  y   value getValue             jgen writeEndObject                Override     public Class lt CustomObject gt  handledType             return CustomObject class            No XML configuration   lt mvc message-converters gt       lt  mvc message-converters gt   is needed in my solution

User · Answer

I am using Spring 3 2 4 and Jackson FasterXML 2 1 1   I have created a custom JacksonObjectMapper that works with explicit annotations for each attribute of the Objects mapped   package com test  import com fasterxml jackson annotation JsonAutoDetect  import com fasterxml jackson annotation PropertyAccessor  import com fasterxml jackson databind ObjectMapper  import com fasterxml jackson databind SerializationFeature   public class MyJaxbJacksonObjectMapper extends ObjectMapper    public MyJaxbJacksonObjectMapper          this setVisibility PropertyAccessor FIELD  JsonAutoDetect Visibility ANY               setVisibility PropertyAccessor CREATOR  JsonAutoDetect Visibility ANY               setVisibility PropertyAccessor SETTER  JsonAutoDetect Visibility NONE               setVisibility PropertyAccessor GETTER  JsonAutoDetect Visibility NONE               setVisibility PropertyAccessor IS GETTER  JsonAutoDetect Visibility NONE        this configure SerializationFeature FAIL ON EMPTY BEANS  false             Then this is instantiated in the context-configuration  servlet-context xml     lt mvc annotation-driven gt       lt mvc message-converters gt            lt beans bean class  org springframework http converter json MappingJackson2HttpMessageConverter  gt               lt beans property name  objectMapper  gt                   lt beans bean class  com test MyJaxbJacksonObjectMapper    gt               lt  beans property gt           lt  beans bean gt        lt  mvc message-converters gt   lt  mvc annotation-driven gt    This works fine

User · Answer

Using Spring Boot  1 2 4  and Jackson  2 4 6  the following annotation based configuration worked for me    Configuration public class JacksonConfiguration         Bean     public ObjectMapper objectMapper             ObjectMapper mapper   new ObjectMapper            mapper configure DeserializationFeature FAIL ON UNKNOWN PROPERTIES  false           mapper configure MapperFeature DEFAULT VIEW INCLUSION  true            return mapper

User · Answer

I am using Spring 4 1 6 and Jackson FasterXML 2 1 4        lt mvc annotation-driven gt           lt mvc message-converters gt               lt bean class  org springframework http converter json MappingJackson2HttpMessageConverter  gt                   lt property name  objectMapper  gt                       lt bean class  com fasterxml jackson databind ObjectMapper  gt                           lt  --      null  -- gt                           lt property name  serializationInclusion  value  NON NULL   gt                       lt  bean gt                   lt  property gt               lt  bean gt           lt  mvc message-converters gt       lt  mvc annotation-driven gt    this works at my applicationContext xml configration

User · Answer

SOLUTION 1    First working solution  tested  useful especially when using  EnableWebMvc      Configuration  EnableWebMvc public class WebConfig implements WebMvcConfigurer        Autowired     private ObjectMapper objectMapper    created elsewhere      Override     public void extendMessageConverters List lt HttpMessageConverter lt   gt  gt  converters               this won t add a 2nd MappingJackson2HttpMessageConverter             as the SOLUTION 2 is doing but also might seem complicated         converters stream   filter c - gt  c instanceof MappingJackson2HttpMessageConverter  forEach c - gt                   check default included objectMapper  registeredModuleTypes                 e g  Jdk8Module  JavaTimeModule when creating the ObjectMapper                without Jackson2ObjectMapperBuilder               MappingJackson2HttpMessageConverter  c  setObjectMapper this objectMapper                       SOLUTION 2    Of course the common approach below works too  also working with  EnableWebMvc     Configuration  EnableWebMvc public class WebConfig implements WebMvcConfigurer        Autowired     private ObjectMapper objectMapper    created elsewhere      Override     public void extendMessageConverters List lt HttpMessageConverter lt   gt  gt  converters               this will add a 2nd MappingJackson2HttpMessageConverter              additional to the default one  but will work and you             won t lose the default converters as you ll do when overwriting            configureMessageConverters List lt HttpMessageConverter lt   gt  gt  converters                         you still have to check default included            objectMapper  registeredModuleTypes  e g             Jdk8Module  JavaTimeModule when creating the ObjectMapper            without Jackson2ObjectMapperBuilder         converters add new MappingJackson2HttpMessageConverter this objectMapper            Why  EnableWebMvc usage is a problem    EnableWebMvc is using DelegatingWebMvcConfiguration which extends WebMvcConfigurationSupport which does this     if  jackson2Present        Jackson2ObjectMapperBuilder builder   Jackson2ObjectMapperBuilder json        if  this applicationContext    null            builder applicationContext this applicationContext             messageConverters add new MappingJackson2HttpMessageConverter builder build          which means that there s no way of injecting your own ObjectMapper with the purpose of preparing it to be used for creating the default MappingJackson2HttpMessageConverter when using  EnableWebMvc

User · Answer

Above Spring 4  there is no need to configure MappingJacksonHttpMessageConverter if you only intend to configure ObjectMapper    configure MappingJacksonHttpMessageConverter will cause you to lose other MessageConverter   You just need to do   public class MyObjectMapper extends ObjectMapper        private static final long serialVersionUID   4219938065516862637L       public MyObjectMapper             super            enable SerializationFeature INDENT OUTPUT                    And in your Spring configuration  create this bean    Bean  public MyObjectMapper myObjectMapper                 return new MyObjectMapper

User · Answer

I found the solution now based on https   github com FasterXML jackson-module-hibernate  I extended the object mapper and added the attributes in the inherited constructor   Then the new object mapper is registered as a bean    lt  -- https   github com FasterXML jackson-module-hibernate -- gt   lt bean class  org springframework web servlet mvc annotation AnnotationMethodHandlerAdapter  gt       lt property name  messageConverters  gt           lt array gt               lt bean id  jsonConverter              class  org springframework http converter json MappingJacksonHttpMessageConverter  gt                   lt property name  objectMapper  gt                       lt bean class  de company backend spring PtxObjectMapper   gt                   lt  property gt               lt  bean gt           lt  array gt       lt  property gt   lt  bean gt

User · Answer

It may be because I m using Spring 3 1  instead of Spring 3 0 5 as your question specified   but Steve Eastwood s answer didn t work for me  This solution works for Spring 3 1   In your spring xml context    lt mvc annotation-driven gt       lt mvc message-converters gt           lt bean class  org springframework http converter StringHttpMessageConverter   gt           lt bean class  org springframework http converter ByteArrayHttpMessageConverter   gt           lt bean class  org springframework http converter json MappingJacksonHttpMessageConverter  gt               lt property name  objectMapper  ref  jacksonObjectMapper    gt           lt  bean gt               lt  mvc message-converters gt   lt  mvc annotation-driven gt    lt bean id  jacksonObjectMapper  class  de Company backend web CompanyObjectMapper    gt

User · Answer

In Spring Boot 2 2 x you need to configure it like this    Bean public ObjectMapper objectMapper Jackson2ObjectMapperBuilder builder        return builder build       Kotlin     Bean fun objectMapper builder  Jackson2ObjectMapperBuilder    builder build

[java] Configuring ObjectMapper in Spring

Examples related to java

Examples related to json

Examples related to spring

Examples related to jackson

Examples related to object-object-mapping