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

2022-08-31 11:40:23

我有一个返回json响应的春季Web服务。我使用这里给出的示例来创建服务:http://www.mkyong.com/spring-mvc/spring-3-mvc-and-json-example/

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

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

我在这里发现了类似的问题,但我能够得到一个可行的解决方案,例如

在春季配置对象映射器

如何在使用基于弹簧注释的配置时配置MapingJacksonHttpMessageConverter?

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

如何将spring mvc 3配置为在json响应中不返回“null”对象?

@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 网站上给出的相同,除了我注释掉了Shop名称变量的设置,因此它是空的,即。

@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注释使其工作,但此解决方案不适合我。

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


答案 1

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

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

答案 2

由于正在使用 Jackson,因此必须将其配置为 Jackson 属性。对于 Spring Boot REST 服务,您必须在 或 中对其进行配置:application.propertiesapplication.yml

spring.jackson.default-property-inclusion = NON_NULL


推荐