關于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下都會產生下載提示的問題。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容