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

最新推荐文章于 2024-04-17 10:04:40 发布

转载最新推荐文章于 2024-04-17 10:04:40 发布 · 1.8k 阅读

文章标签：

#spring #mvc #json #class #log4j #bean

spring 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了解决Spring MVC框架中使用@ResponseBody返回JSON时出现中文乱码的问题。通过对Spring源码的理解，定制了一个UTF-8编码的StringHttpMessageConverter。

近日用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的源码，看看这个类究竟做了哪些事情。

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

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不就得了？代码如下：

public class UTF8StringHttpMessageConverter extends StringHttpMessageConverter {

	private static final MediaType utf8 = new MediaType("text", "plain", 
			Charset.forName("UTF-8"));

	private boolean writeAcceptCharset = true;

	@Override
	protected MediaType getDefaultContentType(String dumy) {
		return utf8;
	}

	protected List<Charset> getAcceptedCharsets() {
		return Arrays.asList(utf8.getCharSet());
	}

	protected void writeInternal(String s, HttpOutputMessage outputMessage) 
			throws IOException {
		if (this.writeAcceptCharset) {
			outputMessage.getHeaders().setAcceptCharset(getAcceptedCharsets());
		}
		Charset charset = utf8.getCharSet();
		FileCopyUtils.copy(s, new OutputStreamWriter(outputMessage.getBody(), charset));
	}

	public boolean isWriteAcceptCharset() {
		return writeAcceptCharset;
	}

	public void setWriteAcceptCharset(boolean writeAcceptCharset) {
		this.writeAcceptCharset = writeAcceptCharset;
	}
}

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

	<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" >  
		<property name="messageConverters">   
         	<list>   
	              <bean class="com.yougou.mobilemall.framework.base.UTF8StringHttpMessageConverter" />  
	         </list>   
	   </property>  
	</bean>

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