关于SpringMVC向前端返回数据乱码及相关问题解决方案
问题背景
使用springMVC框架,可以在Controller方法的注解中,指定返回数据的格式(xml、html、key-value、json等),但是spring默认的消息转换器的默认编码标准是ISO-8859-1,该编码是西欧编码,无法对中文编码,所以,前端收到数据之后,按照响应头中的编码(ISO-8859-1)去解码,关于中文的内容都会得到乱码,即使我们手动采用UTF-8,也不能解码。
解决方案
可行的配置方法
首先:在controller的@RequestMapping头中,定义produces属性,比如:
produces = "application/json; charset=utf-8"
其次,还需要在springMVC的相关配置文件(xml)中进行配置。
网上的配置文件很多,我所找到的大致是两种方法。
开启声明驱动的方式
开启声明驱动,在mvc:annotation-driven标签内定义消息转换器,如下:
<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>
不开启声明驱动的方式
不开启声明驱动,用bean的方式注入消息转换器:
<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>
或者:
`<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>
<!-- 这里顺序不能反,一定先写text/html,不然ie下出现下载提示 -->
<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>
<!-- 这里顺序不能反,一定先写text/html,不然ie下出现下载提示 -->
<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 />`
参考来源:
https://stackoverflow.com/questions/3616359/who-sets-response-content-type-in-spring-mvc-responsebody
http://blog.csdn.net/stationxp/article/details/38775295
http://blog.csdn.net/jiaotuwoaini/article/details/51487605
http://www.cnblogs.com/feiyujun/p/6581683.html
关于修改StringHttpMessageConverter的源码,在打包成jar。这种做法只能够暂时解决乱码的问题,在后期升级、代码移植上都存在隐患。所以不是解决方案。
试验通过的配置方法
方法一
<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>
方法二
<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>
可能会遇到的问题
在开启声明驱动之后,可能会遇到一些问题,比如:启动应用,初始化的时候(第一个请求到达后开始初始化)会抛异常。又如:eclipse对spring的配置文件进行XML约束校验时报错。
模糊的映射导致BeanCreationException
现象说明:
采用mvc:annotation-driven方式配置,启动之后抛异常。异常信息如下:
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/>,就会抛这个异常。
仔细阅读异常信息发现,某个Controller类中,有些名字相似的方法,映射路径相同(复制@RequestMapping(value = "/dept/list",忘记修改导致的)。
结论:
开启注解驱动之后,首次启动初始化的时候,会遍历全部的映射路径,确保不存在重复映射,否则会抛出BeanCreationException异常。
其他参考:
http://www.cnblogs.com/davidwang456/p/4387654.html
http://www.fanfanyu.cn/news/staticpagefile/2351.html
XML校验报错
修改了spring的配置文件,编译器校验出错。比如:
cvc-complex-type.2.4.c: 通配符的匹配很全面, 但无法找到元素 'mvc:annotation-driven'
又比如:
编译器校验配置文件出错
原因分析:
只要发布之后,没有什么问题,就可以认为校验报错的原因在校验程序本身(网络)
问题解决后的效果
参考《关于SpringMVC向前端返回数据乱码及相关问题解决过程记录》
尚存在的问题
虽然上述的配置消息转换器的方案中,有的强调某些标签的配置顺序,声称可以解决“json数据传到IE浏览器会被当作文件下载”的问题,但是就我而言,上述“试验通过的配置方法”所列方案,都不能解决在IE下都会产生下载提示的问题。