解決@ResponseBody作用在返回類型為String的方法時的坑

更新時間：2023年06月17日 15:46:16 作者：BryantLmm

這篇文章主要介紹了解決@ResponseBody作用在返回類型為String的方法時的坑，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

@ResponseBody作用在返回類型為String的方法時的坑

在默認的Spring配置中，當在返回類型為String的Controller方法時，在其上加上@ResponseBody時會出現(xiàn)問題，那就是返回的不再是我們期待的Json格式的字符串了，而是會變成在正常的Json串前后加上雙引號。

這是為什么呢？這是因為在HTTPMessageConverter中對應寫json格式相應的處理類在寫json的時候默認是對String類型進行這樣處理的。

以Gson為例

在SpringBoot中，有相應的Configuartion來配置用戶來解析Json格式的HttpMessageConverter，經(jīng)過DEBUG發(fā)現(xiàn)，在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類型的對象轉(zhuǎn)化為json就是會加上雙引號的，所以導致了String類型的返回不再是json串了。

如果想要String類型也轉(zhuǎn)為正常的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類型的，直接拼接，不轉(zhuǎn)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，在測試的時候發(fā)現(xiàn)，對于低版本的FastJson，會存在一個問題，就是當Java對象并沒有默認的構(gòu)造器的時候，是會報錯的，需要使用新版本的FastJson才會去尋找合適的構(gòu)造器去實例化對象。

至于哪個版本才可以稱為新版本，沒有仔細研究，我使用的1.2.47版本已經(jīng)修復這個問題。

Fastjson還是有很多坑的，之前有研究過他之前的一個遠程漏洞，這個后續(xù)會寫一篇文章，個人并不建議使用Fastjson,推薦Gson。

對了，如果你使用的是fastjson提供的HTTPMessageConverter,是一樣會對String格式做加引號處理的，具體可以看相應源碼。