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

问题描述 投票:0回答:11

我有一个返回 json 响应的 Spring Web 服务。我使用此处给出的示例来创建服务: 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 注释中配置的消息转换器。 我更新的 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 网站上给出的相同,只是我注释掉了商店名称变量的设置,因此它为空,即

@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 jar 是 jackson-mapper-asl 1.9.0 和 jackson-core-asl 1.9.0。这些是我添加到 pom 中的唯一新 jar,作为我从 mkyong.com 下载的 spring-json 项目的一部分提供。

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

谁能告诉我我的配置哪里出了问题?

我尝试了其他几个选项,但能够以正确格式返回 json 的唯一方法是将对象映射器添加到 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;
}

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

我也可以使用 @JsonIgnore 注释让它工作,但这个解决方案不适合我。

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

java spring jackson
11个回答
138
投票

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

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

120
投票

由于正在使用 Jackson,因此您必须将其配置为 Jackson 属性。对于 Spring Boot REST 服务,您必须在

application.properties
application.yml
中配置它:

spring.jackson.default-property-inclusion = NON_NULL

来源


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

适合 jackson 2.0 或更高版本使用

@JsonInclude(Include.NON_NULL)

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


9
投票

设置

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);
    }
}

5
投票

如果您使用的是 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>

5
投票

从 1.6 版本开始,我们有了新的注释 JsonSerialize(例如在 1.9.9 版本中)。

示例:

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

默认值始终。

在旧版本中,您可以使用 JsonWriteNullProperties,但在新版本中已弃用。 示例:

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

5
投票

从 Jackson 2.0 开始,

@JsonSerialize(include = xxx)
已被弃用,取而代之的是
@JsonInclude


4
投票

对于所有非 xml 配置人员:

ObjectMapper objMapper = new ObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL);
HttpMessageConverter msgConverter = new MappingJackson2HttpMessageConverter(objMapper);
restTemplate.setMessageConverters(Collections.singletonList(msgConverter));

1
投票

对于旧版本的 Jackson,您可以使用

JsonWriteNullProperties

对于 Jackson 1.9+,请使用

JsonSerialize.include


0
投票

我通过配置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 及其附带的所有好处的解决方案会好得多。如果有人能告诉我如何做到这一点,那就太好了。


0
投票

嗨,您还可以将配置类与对象映射器 Bean 一起使用

    @Configuration
public class ObjectMapperConfiguration {

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer getObjectMapper() {
        return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL);
    }
}
© www.soinside.com 2019 - 2024. All rights reserved.