SpringMVC使用@ResponseBody中文乱码

Spring3.0 MVC @ResponseBody 的作用是把返回值直接写到HTTP response body里。 

  使用jQuery ajax调用的返回json，中文乱码问题

Spring使用AnnotationMethodHandlerAdapter的handleResponseBody方法， AnnotationMethodHandlerAdapter使用request header中"Accept"的值和messageConverter支持的MediaType进行匹配，然后会用"Accept"的第一个值写入response的"Content-Type"。

一般的请求都是通过浏览器进行的，request header中"Accept"的值由浏览器生成。

 

 

  

 

有人跟踪@ResponseBody 的实现类发现其默认的编码是 iso-8859-1,

解决办法，在spring mvc的配置文件中手工配置bean：
<!-- 启动Spring MVC的注解功能，完成请求和注解POJO的映射 -->    
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" >  
<property name="messageConverters">   
         <list>   
             <bean class = "org.springframework.http.converter.StringHttpMessageConverter">   
                <property name = "supportedMediaTypes">
                      <list>
                          <value>text/html;charset=UTF-8</value>   
                     </list>   
                </property>   
             </bean>   
         </list>   
   </property>  
</bean>  

 

这样通过配置AnnotationMethodHandlerAdapter类messageConverters属性来指定编码。
记住，需要把bean部分加入到<context:component-scan base-package="com.zlscw.mvc" />前面，

这样就可以在jquery中直接调用而不出现乱码了。

 

-------------------------------------------这篇文章说的很到位

近日用Spring3的MVC写东西，深感其之于Webwork/Struts2的便利，但是在通过@ResponseBody这个annotation输出一个json字符串的时候，发现页面上获得的json字符串中文字符出现了乱码的现象。通过firefox观察返回的字符串，中文部分全部变成了？？？？？？？的形式，初步判定是返回时，spring处理@ResponseBody使用了错误的编码。

因为我在web.xml中已经配置了Spring的CharacterEncodingFilter，并且强制将request和response的编码都指定为utf-8，所以出现乱码的原因肯定是在Spring内部某处的逻辑了。

把log4j中关于spring的输出级别调为debug，通过访问出问题的地址，发现Spring在处理@ResponseBody这个annotation的时候，org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter使用了org.springframework.http.converter.StringHttpMessageConverter进行处理，于是打开了Spring的源码，看看这个类究竟做了哪些事情。

不看不要紧，一看吓一跳，里面竟然是这样定义其默认编码的： 

1	publicstaticfinalCharset DEFAULT_CHARSET = Charset.forName("ISO-8859-1");

顿时心生N种不爽：堂堂Spring，竟然还在其中用西欧字符集作为其默认编码，坑爹啊！（很多spring的类中，涉及编码的已经都是utf-8了，比如负责JSON视图的MappingJacksonHttpMessageConverter，就是默认使用UTF-8）。本来想直接修改spring的源码重新打包一个jar出来，后来看spring的java doc发现，其父类org.springframework.http.converter.AbstractHttpMessageConverter中的getDefaultContentType方法是可以重写的：

By default, this returns the first element of the supportedMediaTypes property, if any. Can be overridden in subclasses.

心想这下就简单了，你的DEFAULT_CHARSET不是final么？那我自己继承一个出来，按照我的需求定义为utf-8不就得了？代码如下：

01	publicclassUTF8StringHttpMessageConverter extendsStringHttpMessageConverter {

02

03	privatestaticfinalMediaType utf8 = newMediaType("text", "plain",

04	Charset.forName("UTF-8"));

05	privatebooleanwriteAcceptCharset = true;

06

07

@Override

08	protectedMediaType getDefaultContentType(String dumy) {

09	returnutf8;

10

}

11

12	protectedList<Charset> getAcceptedCharsets() {

13	returnArrays.asList(utf8.getCharSet());

14

}

15

16	protectedvoidwriteInternal(String s, HttpOutputMessage outputMessage)

17	throwsIOException {

18	if(this.writeAcceptCharset) {

19	outputMessage.getHeaders().setAcceptCharset(getAcceptedCharsets());

20

}

21	Charset charset = utf8.getCharSet();

22	FileCopyUtils.copy(s, newOutputStreamWriter(outputMessage.getBody(),

23	charset));

24

}

25

26	publicbooleanisWriteAcceptCharset() {

27	returnwriteAcceptCharset;

28

}

29

30	publicvoidsetWriteAcceptCharset(booleanwriteAcceptCharset) {

31	this.writeAcceptCharset = writeAcceptCharset;

32

}

33

34

}

然后，在spring的配置文件中添加如下bean声明，用自己写的类替换掉原有的StringHttpMessageConverter：

1	<beanclass="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">

2	<propertyname="messageConverters">

3

<list>

4	<beanid="utf8StringHttpMessageConverter"class="xxx.xxx.UTF8StringHttpMessageConverter"/>

5

</list>

6	</property>

7

</bean>

再看通过@ResponseBody返回的json字符串，终于中文都可以正常显示了。

 

-------------------------------------------下面有一些解释

但我们一般会在标注@ResponseBody的方法上返回String或byte[]类型的结果，期望的"Content-Type"的值应为"text/plain"或"application/octet-stream"。
这样导致了浏览器不能正确处理返回的内容。
实际上Spring在用HttpMessageConverter处理的过程中首先会判断response header中有没有写入"Content-Type"，如果没有写入的话才会使用request header中"Accept"的第一个值。
但是由于Spring对HttpServletResponse进行了封装，实际上使用的是ServletServerHttpResponse，这个类有一个对真正的HttpServletResponse的引用。
判断response header的过程中使用的是ServletServerHttpResponse的getHeaders()方法，但该方法并没有返回真正的HttpServletResponse中的header。（这应该有问题吧？）
所以我们虽然可以在Controller的方法中加入对HttpServletResponse的引用，然后设置"Content-Type"的值，但是并不会起作用。
来处理@ResponseBody，该类再使用一些HttpMessageConverter来具体处理信息。
Chrome生成的值为application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
IE8生成的值为application/x-ms-application, image/jpeg, application/xaml+xml, image/gif, image/pjpeg, application/x-ms-xbap, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, */*
所以最后写入response中"Content-Type"的值为"application/xml"或"application/x-ms-application"。

 

 -------------------------------------------------其实这个注解完全可以不用， 直接使用response往输出流里面写。

 

Jquery ：

$.ajax({
    url: '/test/testAction.do?method=test',
    type: 'POST',
    dataType: 'json',
    timeout: 5000,
    async: false,
    error: function(){
     alert('获取数据失败！');
    },
    success: function(json){
     jsObject  = eval(json);
    }
  });
  return jsObject;

 

JSONArray json = JSONArray.fromObject(SysList);//SysList是一个List
//  设置response的ContentType解决中文乱码
  response.setContentType("text/html;charset=UTF-8");
  response.getWriter().print(json.toString());
  return null;