Question

在我的应用程序中，每个restful服务都返回以下对象，该对象指示请求是成功终止还是错误，它包含可选的错误消息，当然还有对象：

public class JSONResponse {

    public boolean success = true;
    public String errmsg = "";
    public Object body;

    /* getter/setter */
}

当我调用restful服务时，我得到以下JSON：

{
   "JSONResponse":{
      "success":true,
      "errmsg":"",
      "body":[]
    }
 }

不幸的是，我已经有了客户端代码，它希望只得到对象内容：

{
   "success":true,
   "errmsg":"",
   "body":[]
}

我想保留现有的JS代码。如何配置MappingJackson2JsonView以获取仅包含“JSONResponse：”字段内容的JSON。

以下是简化的restful控制器的一部分：

@RequestMapping(value="/list")
public JSONResponse list() {
    JSONResponse response = new JSONResponse();
    response.success(new String[] { "a", "b", "c"});
    return response;
}//EndMethod.

在xml中，我使用 MappingJackson2JsonView 默认视图，如部分附加的xml：

<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
    <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
    <property name="viewResolvers">
        <list>
            <bean class="org.springframework.web.servlet.view.BeanNameViewResolver"/>
            <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
                <property name="prefix" value="/WEB-INF/views/"/>
                <property name="suffix" value=".jsp"/>
            </bean>
        </list>
    </property>

    <property name="defaultViews">
        <list>
            <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView" />
        </list>
    </property>
</bean>

Answer 1

为了从生成的JSON响应中删除根密钥名称，我通过添加p:extractValueFromSingleKeyModel="true"更新了spring配置文件

<bean id="contentNegotiationManager"  class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">   
    <property name="favorPathExtension" value="true" />
    <property name="ignoreAcceptHeader" value="true"/>
    <property name="useJaf" value="false"/>
    <property name="defaultContentType" value="text/html" />

    <property name="mediaTypes">
        <map>
           <entry key="html" value="text/html"/>
           <entry key="json" value="application/json"/>
       </map>
    </property>
</bean>

<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
    <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
    <property name="viewResolvers">
        <list>
            <bean class="org.springframework.web.servlet.view.BeanNameViewResolver"/>
            <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
                <property name="prefix" value="/WEB-INF/views/"/>
                <property name="suffix" value=".jsp"/>
            </bean>
        </list>
    </property>

    <property name="defaultViews">
        <list>
            <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"
                p:extractValueFromSingleKeyModel="true" />
        </list>
    </property>
</bean>

我还更新了根 beans 标记，以提供＆＃34; p＆＃34;如下面的代码段所示：

<?xml version="1.0" encoding="UTF-8"?>
<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:p="http://www.springframework.org/schema/p" 
    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.xsd">

简要的技术说明

使用调试器进行一些测试，我注意到ObjectMapper的方法writeValue只接收一个HashMap，其中的关键是＆＃34; JSONResponse＆＃34;并且值是控制器方法返回的对象。因此，ObjectMapper将从此HashMap实例生成JSON，因此存在＆＃34; JSONResponse＆＃34;以root身份，因为序列化程序从哈希映射对象开始。

默认情况下，spring中的WRAP ROOT VALUE值为false，并且不会影响＆＃34; JSONResponse＆＃34;在特定情况下以字符串形式显示。实际上，通过启用它，您将获得{ "HashMap": { "JSONResponse": ... }}。因此，this.configure(SerializationFeature.WRAP_ROOT_VALUE, false)无法解决问题。

MappingJackson2JsonView有一个方法setExtractValueFromSingleKeyModel，来自文档here＆＃34; 设置是否将包含单个属性的模型序列化为地图或是否提取模型中的单个值并直接序列化＆＃34;。默认情况下，它为false并且不从hashmap中提取值，但hashmap本身是转换为JSON的对象。当此属性设置为true时，它将从哈希映射中提取值并将其转换为JSON。

Answer 2

像这样定义你自己的ObjectMapper：

public class MyCustomMapper extends ObjectMapper {

    public MyCustomMapper() {
        //this.configure(DeserializationFeature.UNWRAP_ROOT_VALUE, false);
        //this.setSerializationInclusion(Include.NON_NULL);
        this.configure(SerializationFeature.WRAP_ROOT_VALUE, false);
    }
}

然后在xml中添加bean定义：

<bean id="myCustomObjectMapper" class="put.your.package.name.MyCustomMapper"/>

最后重新配置MappingJackson2HttpMessageConverter：

<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
    <property name="objectMapper" ref="myCustomObjectMapper" />
</bean>

Spring JSON响应：仅序列化响应对象内容（不要包装根值）

2 个答案:

简要的技术说明