关于SpringMVC向前端返回数据乱码及相关问题解决过程记录

问题背景

使用springMVC框架,可以在Controller方法的注解中,指定返回数据的格式(xml、html、key-value、json等),但是spring默认的消息转换器的默认编码标准是ISO-8859-1,该编码是西欧编码,无法对中文编码,所以,前端收到数据之后,按照响应头中的编码(ISO-8859-1)去解码,关于中文的内容都会得到乱码,即使我们手动采用UTF-8,也不能解码。

关于乱码的几种解决方案

如何给springMVC框架指定一个编码呢?网上的大部分的说法是开头提到的:在controller的@RequestMapping头中,定义produces属性,比如:

@RequestMapping(value = "/path/map" produces = "application/json; charset=utf-8">

但是,按照我初学springMVC的资料,Demo里一开始就是这么写的,初学者也不会去想为什么springMVC要采用json传输、能不能用别的个数传输数据
在前端请求数据,后台在控制台打印的DEBUG信息里有一行:

Written [ json串 ] as "text/plain;charset=ISO-8859-1" using org.springframework.http.converter.StringHttpMessageConverter@34da3a54]

相继搜索下述关键词:

  • Written xxx as "text/plain;charset=ISO-8859-1" using StringHttpMessageConverter
  • springMVC json 乱码

找到了配置编码的方法:除了要在Controller中注释以外,还需要在springMVC的相关配置文件(xml)中进行配置。
我的配置文件分为三个:spring-dao.xml、spring-service.xml和spring-web.xml文件,分别用于将springMVC与DAO层框架Mybatis整合、spring与service层整合、springMVC与web项目整合。所以,我的项目中,关于消息转换器的配置,应该在spring-web.xml文件中进行配置。
按照网上的说法(排除掉关于GET、POST方法中含有中文,服务端收到乱码的回答和博客):

说法一:

`<mvc:annotation-driven >

<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<property name="supportedMediaTypes" value="text/html;charset=UTF-8"/>
</bean>
</mvc:message-converters>

</mvc:annotation-driven>`

说法二:

<bean class = "org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="messageConverters"> <array> <bean class = "org.springframework.http.converter.StringHttpMessageConverter"> <property name="supportedMediaTypes" value = "text/plain;charset=UTF-8" /> </bean> </array> </property> </bean>
参考来源:https://stackoverflow.com/questions/3616359/who-sets-response-content-type-in-spring-mvc-responsebody

说法三:

<mvc:annotation-driven> <mvc:message-converters> <bean class="org.springframework.http.converter.StringHttpMessageConverter"> <property name="supportedMediaTypes"> <list> <value>text/plain;charset=UTF-8</value> </list> </property> </bean> </mvc:message-converters> </mvc:annotation-driven>
参考来源:http://blog.csdn.net/stationxp/article/details/38775295

说法四:

<bean id="mappingJacksonHttpMessageConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="supportedMediaTypes"> <list> <value>application/json</value> <value>text/html;charset=UTF-8</value> </list> </property> </bean> <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="messageConverters"> <list> <ref bean="mappingJacksonHttpMessageConverter" /> </list> </property> </bean>
参考来源:http://blog.csdn.net/jiaotuwoaini/article/details/51487605

最不靠谱的一种说法是,修改StringHttpMessageConverter的实现,并且打包成jar。这种做法能够暂时解决乱码的问题,但是后期要是升级springMVC的版本,问题会再度出现。此外,对于Maven管理依赖的项目,移植到别的机器上,就会变成原生springMVC的jar包(如果修改的包不同名,那么就会找不到依赖)。所以这个不是解决方案。

上述方案的分析与尝试

上述说法大致有两个方案,一个是关于mvc:annotation-driven,一个是直接配置一些bean。但是,按照第一种方式配置之后,初始化的时候就会抛异常。第二种方式也不起作用,应该是缺少什么。
第一种方式的异常一般都是:

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping': Invocation of init method failed; nested exception is java.lang.IllegalStateException: Ambiguous mapping. Cannot map 'workItemsSubmitController' method public java.lang.Object imp4sep.controller.WorkItemsSubmitController.submitEGPAdd(int,java.util.List<imp4sep.po.EngineeringGeophysicsInfo>,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) to {[/work/submit/GDSP/add],methods=[POST],produces=[application/json;charset=utf-8]}: There is already 'workItemsSubmitController' bean method public java.lang.Object imp4sep.controller.WorkItemsSubmitController.submitGDSPAdd(int,java.util.List<imp4sep.po.GeologicalDrillingSamplingInfo1>,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) mapped.

寻找异常的原因

为了确定导致问题的原因,我相继把mvc:annotation-driven标签的子标签和属性移除,到最后,只要配置了<mvc:annotation-driven/>,就会抛这个异常。
搜索下述关键词:

  • 开启mvc:annotation-driven 导致BeanCreationException RequestMappingHandlerMap
  • Ambiguous mapping. Cannot map 'xxx' method xxx to xx: There is already 'xx'

一些博客记录了相同的问题,一般是初学者的demo项目,发现是Controller的映射路径重复,移除其中一个controller。我没有在意。
参考来源:http://www.cnblogs.com/davidwang456/p/4387654.html
还有说法:
bean重复初始化:使用@controller注解初始化一次,在applicationContext中又定义一次
参考来源:http://www.fanfanyu.cn/news/staticpagefile/2351.html

XML校验报错

在这中间还出现了一个小插曲:spring-*.xml文件相继校验出错。
cvc-complex-type.2.4.c: 通配符的匹配很全面, 但无法找到元素 'mvc:annotation-driven'

在搜索报错信息的过程中找到了意外一个博客


<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"> <property name="messageConverters"> <list> <bean id="stringConverter" class="org.springframework.http.converter.StringHttpMessageConverter"> <property name="supportedMediaTypes"> <list> <value>text/html;charset=UTF-8</value> <value>application/json;charset=UTF-8</value> <value>text/plain;charset=UTF-8</value> </list> </property> </bean> <bean id="jsonConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="supportedMediaTypes"> <list> <value>text/html;charset=UTF-8</value> <value>application/json;charset=UTF-8</value> <value>text/plain;charset=UTF-8</value> </list> </property> </bean> </list> </property> </bean>
``
<mvc:annotation-driven />
参考来源:http://www.cnblogs.com/feiyujun/p/6581683.html

这篇博客的最后还提到springMVC版本的的问题,以至于后面我在找到问题真正所在前,开始怀疑高版本的配置文件与低版本不同。
此外,介绍的配置方式能够解决乱码问题,但是其中强调的配置顺序却并不能解决IE提示下载的问题。

在一个springMVC的QQ群里问了乱码的问题,有三个群友给出两个不同的配置:

  1. 配置一:
配置方法一

可能他的是低版本的配置,我将MappingJacksonHttpMessageConverter改成MappingJackson2HttpMessageConverter了:

<mvc:annotation-driven> <mvc:message-converters register-defaults="true"> <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/> <bean class="org.springframework.http.converter.StringHttpMessageConverter"> <constructor-arg value="UTF-8" /> <property name="writeAcceptCharset" value="false" /> <property name="supportedMediaTypes"> <list> <value>text/plain;charset=UTF-8</value> <value>text/html;charset=UTF-8</value> <value>application/json;charset=UTF-8</value> </list> </property> </bean> </mvc:message-converters> </mvc:annotation-driven>

  1. 配置二

<mvc:annotation-driven> <mvc:message-converters register-defaults="true"> <bean class="org.springframework.http.converter.StringHttpMessageConverter"> <property name="supportedMediaTypes" value="text/plain;charset=UTF-8" /> </bean> </mvc:message-converters> </mvc:annotation-driven>
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="messageConverters"> <list> <ref bean="mappingJacksonHttpMessageConverter" /> </list> </property> </bean> <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"> <property name="messageConverters"> <list> <ref bean="mappingJacksonHttpMessageConverter" /> </list> </property> </bean>
<bean id="mappingJacksonHttpMessageConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="supportedMediaTypes"> <list> <bean class="org.springframework.http.MediaType"> <constructor-arg index="0" value="text" /> <constructor-arg index="1" value="plain" /> <constructor-arg index="2" value="UTF-8" /> </bean> <bean class="org.springframework.http.MediaType"> <constructor-arg index="0" value="*" /> <constructor-arg index="1" value="*" /> <constructor-arg index="2" value="UTF-8" /> </bean> <bean class="org.springframework.http.MediaType"> <constructor-arg index="0" value="text" /> <constructor-arg index="1" value="*" /> <constructor-arg index="2" value="UTF-8" /> </bean> <bean class="org.springframework.http.MediaType"> <constructor-arg index="0" value="application" /> <constructor-arg index="1" value="json" /> <constructor-arg index="2" value="UTF-8" /> </bean> </list> </property> </bean>

发现错误的根本原因

尝试了两天仍然没有解决的乱码问题,今天我仔细看了一下异常信息,由于方法名相似,之前一直以为异常的信息所说的模糊映射是由于“多处配置”所致,
原来真的存在重复的映射。这个问题根结的发现,同时也说明一个问题:开启注解驱动之后,首次启动初始化的时候,会遍历全部的映射路径,确保不存在重复映射,否则会抛出BeanCreationException异常。

解决问题

找到存在的重复映射路径,修改过来之后,重新发布

  1. 无乱码的,但不能美化的输出
    按照群友1给出的配置之后,前端发来请求,得到没有乱码的数据,如下:


    firefox浏览器展示的样式

    原始数据

    点击美化输出无效。“头”标签里的响应头信息:


    请求响应头信息
  2. 无乱码且可以美化的输出
    按照群友2所说的配置:


    firefox浏览器展示的样式

    原始数据

    请求响应头信息
  3. 无乱码,可美化,接受编码类型多的方案

`<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<property name="supportedMediaTypes">
<list>
<value>application/json;charset=UTF-8</value>
<value>text/plain;charset=UTF-8</value>
</list>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>

校验会报错:

eclipse校验xml约束

这种校验报错时有时无,据说校验时,除了从网络位置校验,还会从本地的jar包中校验,不知道eclipse是不是这么做的。

firefox浏览器展示的样式

原始数据标签下,点击“美化输出”,能够进行排版:

原始数据

头标签的响应数据也不同:


Accept-Charset的编码格式丰富
  1. 无乱码、不能美化的输出
    网上找到的原配置是错误的,如下:

<mvc:annotation-driven> <mvc:message-converters register-defaults="true"> <bean lass="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="supportedMediaTypes" value="application/json;charset=UTF-8" /> <property name="supportedMediaTypes" value="text/html;charset=UTF-8" /> </bean> <bean class="org.springframework.http.converter.json.GsonHttpMessageConverter"> <property name="supportedMediaTypes" value="application/json;charset=UTF-8" /> <property name="supportedMediaTypes" value="text/html;charset=UTF-8" /> </bean> </mvc:message-converters> </mvc:annotation-driven>

发布之后会抛异常:
org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Multiple 'property' definitions for property 'supportedMediaTypes' Offending resource: file [D:\Apache\apache-tomcat-9.0.0.M18\webapps\imp4sep\WEB-INF\classes\spring\spring-web.xml] Bean '' -> Property 'supportedMediaTypes'
修改为下述形式才可以:

<mvc:annotation-driven> <mvc:message-converters register-defaults="true"> <bean lass="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="supportedMediaTypes" value="application/json;charset=UTF-8" /> </bean> <bean class="org.springframework.http.converter.json.GsonHttpMessageConverter"> <property name="supportedMediaTypes" value="text/html;charset=UTF-8" /> </bean> </mvc:message-converters> </mvc:annotation-driven>

HTTP头是这样的:

请求响应头信息

上述可行方案的对比

在IE下都会会产生下载提示

推荐阅读更多精彩内容