Spring REST服务:如何配置以删除json响应中的空对象

Question

我有一个spring webservice,它返回一个json响应.我正在使用此处给出的示例来创建服务:http: //www.mkyong.com/spring-mvc/spring-3-mvc-and-json-example/

返回json的格式为:{"name":null,"staffName":["kfc-kampar","smith"]}

我想从返回的响应中删除任何空对象,所以它看起来像这样:{"staffName":["kfc-kampar","smith"]}

我在这里找到了类似的问题,但我已经能够得到一个解决方案,例如

在Spring中配置ObjectMapper

如何在使用基于spring注释的配置时配置MappingJacksonHttpMessageConverter？

配置jacksonObjectMapper不能在spring mvc 3中工作

如何配置spring mvc 3在json响应中不返回"null"对象？

Spring配置@ResponseBody JSON格式

Jackson + Spring3.0.5自定义对象映射器

通过阅读这些和其他来源,我认为实现我想要的最简洁的方法是使用Spring 3.1和可以在mvc-annotation中配置的消息转换器.我更新的spring配置文件是:

<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
    http://www.springframework.org/schema/beans     
    http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
    http://www.springframework.org/schema/context 
    http://www.springframework.org/schema/context/spring-context-3.1.xsd
    http://www.springframework.org/schema/mvc
    http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd">

<context:component-scan base-package="com.mkyong.common.controller" />

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
            <property name="prefixJson" value="true" />
            <property name="supportedMediaTypes" value="application/json" />
            <property name="objectMapper">
                <bean class="org.codehaus.jackson.map.ObjectMapper">
                    <property name="serializationInclusion" value="NON_NULL"/>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

服务类与mkyong.com网站上的服务类相同,只是我注释了商店名称变量的设置,所以它是null,即

@Controller
@RequestMapping("/kfc/brands")
public class JSONController {
    @RequestMapping(value="{name}", method = RequestMethod.GET)
    @ResponseStatus(HttpStatus.OK) 
    public @ResponseBody Shop getShopInJSON(@PathVariable String name) {
        Shop shop = new Shop();
        //shop.setName(name);
        shop.setStaffName(new String[]{name, "cronin"});
        return shop;
    }
}

我正在使用的杰克逊罐子是jackson-mapper-asl 1.9.0和jackson-core-asl 1.9.0.这是我添加到pom中的唯一新罐子,作为我从mkyong.com下载的spring-json项目的一部分提供的.

项目构建成功,但是当我通过浏览器调用服务时,我仍然得到相同的东西,即{"name":null,"staffName":["kfc-kampar","smith"]}

谁能告诉我我的配置出错了？

我已经尝试了其他几个选项,但是我能够以正确的格式返回json的唯一方法是将Object mapper添加到JSONController并让"getShopInJSON"方法返回一个字符串,即

public @ResponseBody String getShopInJSON(@PathVariable String name) throws JsonGenerationException, JsonMappingException, IOException {
    ObjectMapper mapper = new ObjectMapper();
    mapper.setSerializationInclusion(JsonSerialize.Inclusion.NON_NULL);

    Shop shop = new Shop();
    //shop.setName(name);
    shop.setStaffName(new String[]{name, "cronin"});
    String test = mapper.writeValueAsString(shop);
    return test;
}

现在,如果我调用该服务,我得到预期的ie {"staffName":["kfc-kampar","cronin"]}

我也能够使用@JsonIgnore注释使其工作,但这个解决方案不适合我.

我不明白为什么它在代码中工作但在配置中没有,所以任何帮助都会很棒.

Answer 1

从Jackson 2.0开始,您可以使用JsonInclude

@JsonInclude(Include.NON_NULL)
public class Shop {
    //...
}

Answer 2

自从Jackson被使用以来,你必须将其配置为杰克逊的财产.对于Spring Boot REST服务,您必须在以下位置配置它application.properties:

spring.jackson.default-property-inclusion = NON_NULL

资源

Answer 3

@JsonSerialize(include=JsonSerialize.Inclusion.NON_EMPTY)
public class Shop {
    //...
}

对于jackson 2.0或更高版本使用 @JsonInclude(Include.NON_NULL)

这将删除空对象和空对象.

Answer 4

如果您使用的是Jackson 2,则消息转换器标记为:

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="prefixJson" value="true"/>
            <property name="supportedMediaTypes" value="application/json"/>
            <property name="objectMapper">
                <bean class="com.fasterxml.jackson.databind.ObjectMapper">
                    <property name="serializationInclusion" value="NON_NULL"/>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

Answer 5

从版本 1.6 开始，我们有了新的注释 JsonSerialize（例如在版本 1.9.9 中）。

例子：

@JsonSerialize(include=Inclusion.NON_NULL)
public class Test{
...
}

默认值为始终。

在旧版本中，您可以使用 JsonWriteNullProperties，但在新版本中已弃用。例子：

@JsonWriteNullProperties(false)
public class Test{
    ...
}

Answer 6

截至Jackson 2.0,@JsonSerialize(include = xxx)已被弃用赞成@JsonInclude

Answer 7

设置spring.jackson.default-property-inclusion=non_null选项是最简单的解决方案，而且效果很好。

但是，如果您在代码中的某处实现 WebMvcConfigurer，请小心，那么属性解决方案将不起作用，您必须在代码中设置 NON_NULL 序列化，如下所示：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    // some of your config here...

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter(objectMapper);
        converters.add(jsonConverter);
    }
}

Answer 8

我通过配置Spring容器找到了解决方案，但它仍然不是我想要的。

我回滚到 Spring 3.0.5，删除并在其中将配置文件更改为：

    <bean
    class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
        <list>
            <bean
                class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper" ref="jacksonObjectMapper" />
            </bean>
        </list>
    </property>
</bean>


<bean id="jacksonObjectMapper" class="org.codehaus.jackson.map.ObjectMapper" />
<bean id="jacksonSerializationConfig" class="org.codehaus.jackson.map.SerializationConfig"
    factory-bean="jacksonObjectMapper" factory-method="getSerializationConfig" />
<bean
    class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
    <property name="targetObject" ref="jacksonSerializationConfig" />
    <property name="targetMethod" value="setSerializationInclusion" />
    <property name="arguments">
        <list>
            <value type="org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion">NON_NULL</value>
        </list>
    </property>
</bean>

这当然与其他问题中给出的回答类似，例如

配置 jacksonObjectMapper 在 spring mvc 3 中不起作用

需要注意的重要一点是 mvc:annotation-driven 和 AnnotationMethodHandlerAdapter 不能在同一上下文中使用。

我仍然无法让它与 Spring 3.1 和 mvc:annotation-driven 一起工作。我认为使用 mvc:annotation-driven 及其附带的所有好处的解决方案会好得多。如果有人能告诉我如何做到这一点，那就太好了。