@ResponseBody作用在返回类型为String的方法时的坑

在默认的Spring配置中，当在返回类型为String的Controller方法时，在其上加上@ResponseBody时会出现问题，那就是返回的不再是我们期待的Json格式的字符串了，而是会变成在正常的Json串前后加上双引号。这是为什么呢？这是因为在HTTPMessageConverter中对应写json格式相应的处理类在写json的时候默认是对String类型进行这样处理的。

以Gson为例。

在SpringBoot中，有相应的Configuartion来配置用户来解析Json格式的HttpMessageConverter，经过DEBUG发现，在HttpMessageConverter列表中第一个符合处理json返回格式的是GsonHttpMessageConverter，他是在GsonHttpMessageConvertersConfiguration类中被注入的。

他对json的处理是

	@Override
	protected void writeInternal(Object o, Type type, HttpOutputMessage outputMessage)
			throws IOException, HttpMessageNotWritableException {

		Charset charset = getCharset(outputMessage.getHeaders());
		OutputStreamWriter writer = new OutputStreamWriter(outputMessage.getBody(), charset);
		try {
			if (this.jsonPrefix != null) {
				writer.append(this.jsonPrefix);
			}
      
			if (type != null) {
				this.gson.toJson(o, type, writer);
			}
			else {
				this.gson.toJson(o, writer);
			}
			writer.close();
		}
		catch (JsonIOException ex) {
			throw new HttpMessageNotWritableException("Could not write JSON: " + ex.getMessage(), ex);
		}
	}

因为Gson默认对String类型的对象转化为json就是会加上双引号的，所以导致了String类型的返回不再是json串了。

如果想要String类型也转为正常的json格式的话，只要重写GsonHttpMessageConverter即可。

	@Override
	protected void writeInternal(Object o, Type type, HttpOutputMessage outputMessage)
			throws IOException, HttpMessageNotWritableException {

		Charset charset = getCharset(outputMessage.getHeaders());
		OutputStreamWriter writer = new OutputStreamWriter(outputMessage.getBody(), charset);
		try {
			if (this.jsonPrefix != null) {
				writer.append(this.jsonPrefix);
			}
      
			if (type != null) {
                //对于String类型的，直接拼接，不转json
			if("java.lang.String".equals(type.getTypeName())){
                writer.append(value.toString());
			}else{
				this.gson.toJson(o, type, writer);
                }
				}
			}
			else {
				this.gson.toJson(o, writer);
			}
			writer.close();
		}
		catch (JsonIOException ex) {
			throw new HttpMessageNotWritableException("Could not write JSON: " + ex.getMessage(), ex);
		}
	}

对于FastJson，在测试的时候发现，对于低版本的FastJson，会存在一个问题，就是当Java对象并没有默认的构造器的时候，是会报错的，需要使用新版本的FastJson才会去寻找合适的构造器去实例化对象。至于哪个版本才可以称为新版本，没有仔细研究，我使用的1.2.47版本已经修复这个问题。Fastjson还是有很多坑的，之前有研究过他之前的一个远程漏洞，这个后续会写一篇文章，个人并不建议使用Fastjson,推荐Gson。

对了，如果你使用的是fastjson提供的HTTPMessageConverter,是一样会对String格式做加引号处理的，具体可以看相应源码。

总结

所以为了@ResponseBody能良好的实现返回json格式的功能，要不我们就不要返回String对象，要么就需要重写相应将返回对象处理为Json的HTTPMessageConverter，特殊化他对String类型的处理。