Spring4 MVC 返回json格式时候 设置不返回null值属性的问题

一、问题描述

    前段时间接手一个api项目，已经完成框架部分了。遇到的问题就是action在返回对象的时候，通过RequestMappingHandlerAdapter转化为Json字符串时出现null值。

二、解决过程

1.经过搜索以后发现可以通过配置com.fasterxml.jackson.databind.ObjectMapper的参数来解决这个问题。

<bean id="mappingJacksonHttpMessageConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
		<property name="objectMapper"> 
			<bean class="com.fasterxml.jackson.databind.ObjectMapper"> 
				<property name="serializationInclusion"> 
					<value type="com.fasterxml.jackson.annotation.JsonInclude.Include">NON_NULL</value> 
				</property> 
			</bean> 
		</property>
		<property name="supportedMediaTypes">
		    <list>
		        <value>text/html;charset=UTF-8</value>
		        <value>application/x-www-form-urlencoded;charset=UTF-8</value>
		        <value>application/json;charset=UTF-8</value>
		    </list>
		</property>
	</bean>
    
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="mappingJacksonHttpMessageConverter"/>
            </list>
        </property>
    </bean>

2.但是配置以后还是没有效果，然后经过我的地毯式搜索，终于发现同样问题的解决办法。

贴一下当时修改之前我的xml文件的代码：

    <!-- 启动注解扫面 -->
    <mvc:annotation-driven/>
      
    <!-- Servlet讲对象转为JSON功能 -->
    <bean id="mappingJacksonHttpMessageConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
		<property name="objectMapper"> 
			<bean class="com.fasterxml.jackson.databind.ObjectMapper"> 
				<property name="serializationInclusion"> 
					<value type="com.fasterxml.jackson.annotation.JsonInclude.Include">NON_NULL</value> 
				</property> 
			</bean> 
		</property>
		<property name="supportedMediaTypes">
		    <list>
		        <value>text/html;charset=UTF-8</value>
		        <value>application/x-www-form-urlencoded;charset=UTF-8</value>
		        <value>application/json;charset=UTF-8</value>
		    </list>
		</property>
	</bean>
    
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="mappingJacksonHttpMessageConverter"/>
            </list>
        </property>
    </bean>

正是这一行代码<mvc:annotation-driven/>导致后面的配置文件无效。

3.解决办法。将<mvc:annotation-driven/>放在自定义bean后面

    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="mappingJacksonHttpMessageConverter"/>
            </list>
        </property>
    </bean>

    <!-- 启动注解扫面 -->
    <mvc:annotation-driven/>

三、原因

先让我们了解一下<mvc:annotation-driven /> 做了什么：

<mvc:annotation-driven /> 是一种简写形式，完全可以手动配置替代这种简写形式，简写形式可以让初学都快速应用默认配置方案。<mvc:annotation-driven /> 会自动注册RequestMappingHandlerMapping与RequestMappingHandlerAdapter 两个bean,是spring MVC为@Controllers分发请求所必须的，即解决了@Controller注解使用的前提配置。

因为<mvc:annotation-driven />已经先定义了一个RequestMappingHandlerAdapter，所以注入时使用的时自动注册的RequestMappingHandlerAdapter，导致后面自定义的无效。

ManagedList<?> messageConverters = getMessageConverters(element, source, parserContext);
//这里生成了RequestMappingHandlerAdapter bean
RootBeanDefinition handlerAdapterDef = new RootBeanDefinition(RequestMappingHandlerAdapter.class);
handlerAdapterDef.setSource(source);
handlerAdapterDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
handlerAdapterDef.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);
handlerAdapterDef.getPropertyValues().add("webBindingInitializer", bindingDef);
handlerAdapterDef.getPropertyValues().add("messageConverters", messageConverters);
addRequestBodyAdvice(handlerAdapterDef);
addResponseBodyAdvice(handlerAdapterDef);

四、小结

现在我们在使用Spring MVC框架的时候只是从网上copy的配置文件，而并没有去仔细了解这些配置文件做了什么，所以就会出现看起来莫名其妙的问题，而这些往往是基本功不扎实的表现。所以以后学习的时候，在网上copy的时候还是要多问几个为什么。

参考链接：https://bbs.csdn.net/topics/391838351?page=1