Spring3 MVC使用@ResponseBody的乱码问题及解决办法

近日用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 public static final Charset 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 public class UTF8StringHttpMessageConverter extendsStringHttpMessageConverter {
02
03  private static final MediaType utf8 = new MediaType("text","plain",
04  Charset.forName("UTF-8"));
05  private boolean writeAcceptCharset = true;
06
07  @Override
08  protected MediaType getDefaultContentType(String dumy) {
09  return utf8;
10  }
11
12  protected List getAcceptedCharsets() {
13  return Arrays.asList(utf8.getCharSet());
14  }
15
16  protected void writeInternal(String s, HttpOutputMessage outputMessage)
17  throws IOException {
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  public boolean isWriteAcceptCharset() {
27  return writeAcceptCharset;
28  }
29
30  public void setWriteAcceptCharset(boolean writeAcceptCharset) {
31  this.writeAcceptCharset = writeAcceptCharset;
32  }
33
34 }

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

1 <beanclass="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
2     <property name="messageConverters">
3         <list>
4             <bean id="utf8StringHttpMessageConverter"class="xxx.xxx.UTF8StringHttpMessageConverter" />
5         list>
6     property>
7 bean>

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