Spring configure ResponseBody JSON format

Question

Imagine I have this annotated method in a Spring 3  Controller   RequestMapping     public  ResponseBody MyObject index  RequestBody OtherObject obj        MyObject result            return result      But I need to configure the output json format  just as if I were doing   ObjectMapper om   new ObjectMapper    om configure JsonGenerator Feature QUOTE FIELD NAMES  true   om getSerializationConfig            setSerializationInclusion JsonSerialize Inclusion NON DEFAULT   om getSerializationConfig            set SerializationConfig Feature INDENT OUTPUT  false     Is there any way to configure this behaviour   I ve found a couple of related questions  but I am not sure about how to adapt them to my specific case    spring prefixjson with responsebody Who sets response content-type in Spring MVC   ResponseBody    Thank you

User · Answer

For Spring version 4 1 3   I tried Jama s solution  but then all responses were returned with Content-type  application json   including the main  generated HTML page   Overriding configureMessageConverters      prevents spring from setting up the default converters  Spring 4 1 3 allows modification of already configured converters by overriding extendMessageConverters         Configuration public class ConverterConfig extends WebMvcConfigurerAdapter        Override     public void extendMessageConverters List lt HttpMessageConverter lt   gt  gt  converters            for  HttpMessageConverter lt   gt  converter   converters                if  converter instanceof AbstractJackson2HttpMessageConverter                    AbstractJackson2HttpMessageConverter c    AbstractJackson2HttpMessageConverter  converter                  ObjectMapper objectMapper   c getObjectMapper                    objectMapper setSerializationInclusion Include NON NULL                                    super extendMessageConverters converters                see org springframework  WebMvcConfigurationSupport getMessageConverters        see org springframework  WebMvcConfigurationSupport addDefaultHttpMessageConverters

User · Answer

You can do the following jackson version  lt  2    Custom mapper class   import org codehaus jackson JsonGenerator  import org codehaus jackson map ObjectMapper  import org codehaus jackson map SerializationConfig  import org codehaus jackson map annotate JsonSerialize   public class CustomObjectMapper extends ObjectMapper       public CustomObjectMapper             super configure JsonGenerator Feature QUOTE FIELD NAMES  true           super getSerializationConfig                    setSerializationInclusion JsonSerialize Inclusion NON DEFAULT           super getSerializationConfig                    set SerializationConfig Feature INDENT OUTPUT  false             Spring config    lt mvc annotation-driven gt       lt mvc message-converters register-defaults  false  gt           lt bean class  org springframework http converter json MappingJacksonHttpMessageConverter  gt               lt property name  objectMapper  gt                   lt bean class  package CustomObjectMapper   gt               lt  property gt           lt  bean gt       lt  mvc message-converters gt   lt  mvc annotation-driven gt

User · Answer

I needeed to solve very similar problem  which is configuring Jackson Mapper to  Do not serialize null values for Christ s sake       I didn t want to leave fancy mvc annotation-driven tag  so I found  how to configure Jackson s ObjectMapper without removing mvc annotation-driven and adding not really fancy ContentNegotiatingViewResolver   The beautiful thing is that you don t have to write any Java code yourself   And here is the XML configuration  don t be confused with different namespaces of Jackson classes  I simply used new Jakson 2 x library     the same should also work with Jackson 1 x libraries     lt mvc annotation-driven gt       lt mvc message-converters register-defaults  true  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 property name  serializationInclusion  gt                           lt value type  com fasterxml jackson annotation JsonInclude Include  gt NON NULL lt  value gt                       lt  property gt                   lt  bean gt               lt  property gt           lt  bean gt       lt  mvc message-converters gt   lt  mvc annotation-driven gt

User · Answer

Take a look at Rick Hightower s approach  His approach avoids configuring ObjectMapper as a singleton and allows you to filter the JSON response for the same object in different ways per each request method   http   www jroller com RickHigh entry filtering json feeds from spring

User · Answer

Yes but what happens if you start using mixins for example  you cant be having ObjectMapper as a singleton because you will be applying the configuration globally  So you will be adding or setting the mixin classes on the same ObjectMapper instance

User · Answer

AngerClown pointed me to the right direction   This is what I finally did  just in case anyone find it useful    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  -- jackson configuration   https   stackoverflow com questions 3661769 -- gt   lt bean id  jacksonObjectMapper  class  org codehaus jackson map ObjectMapper    gt   lt bean id  jacksonSerializationConfig  class  org codehaus jackson map SerializationConfig      factory-bean  jacksonObjectMapper  factory-method  getSerializationConfig    gt   lt bean     class  org springframework beans factory config MethodInvokingFactoryBean  gt       lt property name  targetObject  ref  jacksonSerializationConfig    gt       lt property name  targetMethod  value  setSerializationInclusion    gt       lt property name  arguments  gt           lt list gt               lt value type  org codehaus jackson map annotate JsonSerialize Inclusion  gt NON DEFAULT lt  value gt           lt  list gt       lt  property gt   lt  bean gt    I still have to figure out how to configure the other properties such as   om configure JsonGenerator Feature QUOTE FIELD NAMES  true

User · Answer

Doesn t answer the question but this is the top google result   If anybody comes here and wants do do it for Spring 4  as it happened to me   you can use the annotation   JsonInclude Include NON NULL    on the returning class

User · Answer

You can configure the ObjectMapper as a bean in your Spring xml file  What holds a reference to the ObjectMapper is the MappingJacksonJsonView class  You then need to attach the view to a ViewResolver   Something like this should work    lt bean class  org springframework web servlet view ContentNegotiatingViewResolver  gt         lt property name  mediaTypes  gt         lt map gt           lt entry key  json  value  application json    gt           lt entry key  html  value  text html    gt         lt  map gt       lt  property gt       lt property name  viewResolvers  gt         lt list gt           lt bean class  org springframework web servlet view InternalResourceViewResolver  gt             lt property name  prefix  value   WEB-INF jsp     gt             lt property name  suffix  value   jsp    gt           lt  bean gt         lt  list gt       lt  property gt       lt property name  defaultViews  gt         lt list gt           lt bean class  org springframework web servlet view json MappingJacksonJsonView  gt             lt property name  prefixJson  value  false    gt             lt property name  objectMapper  value  customObjectMapper    gt           lt  bean gt         lt  list gt       lt  property gt     lt  bean gt    Where customObjectMapper is defined elsewhere in the xml file  Note that you can directly set Spring property values with the Enums Jackson defines  see this question   Also  ContentNegotiatingViewResolver probably isn t required  it s just the code I am using in an existing project

User · Answer

In spring3 2  new solution is introduced by  http   static springsource org spring docs 3 2 0 BUILD-SNAPSHOT api org springframework http converter json Jackson2ObjectMapperFactoryBean html    the below is my example     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  org springframework http converter json Jackson2ObjectMapperFactoryBean  gt                   lt property name  featuresToEnable  gt                      lt array gt                         lt util constant static-field  com fasterxml jackson core JsonParser Feature ALLOW SINGLE QUOTES    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

User · Answer

I wrote my own FactoryBean which instantiates an ObjectMapper  simplified version      public class ObjectMapperFactoryBean implements FactoryBean lt ObjectMapper gt             Override         public ObjectMapper getObject   throws Exception                   ObjectMapper mapper   new ObjectMapper                    mapper getSerializationConfig   setSerializationInclusion JsonSerialize Inclusion NON NULL                   return mapper                      Override         public Class lt   gt  getObjectType                     return ObjectMapper class                      Override         public boolean isSingleton                     return true                 And the usage in the spring configuration    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

User · Answer

For the folks who are using Java based Spring configuration    Configuration  ComponentScan basePackages    com domain sample    EnableWebMvc public class SpringConfig extends WebMvcConfigurerAdapter              Override     public void configureMessageConverters List lt HttpMessageConverter lt   gt  gt  converters            final MappingJackson2HttpMessageConverter converter   new MappingJackson2HttpMessageConverter            final ObjectMapper objectMapper   new ObjectMapper            objectMapper setSerializationInclusion JsonInclude Include NON NULL           converter setObjectMapper objectMapper           converters add converter           super configureMessageConverters converters                    I m using MappingJackson2HttpMessageConverter  - which is from fasterxml    lt dependency gt     lt groupId gt com fasterxml jackson core lt  groupId gt     lt artifactId gt jackson-databind lt  artifactId gt     lt version gt 2 3 1 lt  version gt   lt  dependency gt    If you want to use codehaus-jackson mapper  instead use this one MappingJacksonHttpMessageConverter    lt dependency gt       lt groupId gt org codehaus jackson lt  groupId gt       lt artifactId gt jackson-mapper-asl lt  artifactId gt       lt version gt   codehaus jackson version  lt  version gt    lt  dependency gt

[java] Spring configure @ResponseBody JSON format

Examples related to java

Examples related to spring

Examples related to spring-mvc

Examples related to jackson