Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象

今天在上班的时候,因为要涉及到springmvc写json接口,通过ajax写数据到前端,然后就发现一个很神奇的事情。
当我使用@RestController或者@ResponseBody的时候,前端拿到的数据如下图:

Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第1张图片
json.png

很显然这是一个json对象,而不是一个json字符串
后台代码如下:

@RestController
public class LoginRestController {

    @Autowired
    private LoginAction loginAction;

    @RequestMapping(value = DuMockUrlConstants.LOGIN_JSON,method = {RequestMethod.POST})
    public RequestResult uploadJar(UserVO userVO){
        loginAction.handle(new LoginRequest(userVO.getLoginName(),userVO.getPassword()),new ActionResponse());
        return RequestResult.success();
    }
}
@AllArgsConstructor
@Data
@ToString(callSuper = true)
@RequiredArgsConstructor
public class RequestResult extends AbstractResquestResult{

    private T data;

    public static RequestResult success(){
        return new RequestResult(RespEnum.SUCCESS.getCode(),RespEnum.SUCCESS.getMemo(),null);
    }
    public static RequestResult fail(){
        return new RequestResult(RespEnum.ERROR.getCode(),RespEnum.ERROR.getMemo(),null);
    }
    public RequestResult(String code, String message, T data) {
        super(code, message);
        this.data = data;
    }

    public RequestResult(String code, String message) {
        super(code, message);
    }
}
@ToString
@AllArgsConstructor
@NoArgsConstructor
@Data
public class AbstractResquestResult implements Serializable{

    @NonNull
    protected String code;

    @NonNull
    protected String message;
}
@AllArgsConstructor
public enum  RespEnum {
   @Getter
    private String code;
    @Getter
    private String memo;
    SUCCESS("000000","成功"),
}

简单来讲,代码实质是返回了一个RequestResult对象,该对象的code为000000,message为成功,很显然是一个登陆的接口。
但当我把代码改成如下:

@RestController
public class LoginRestController {

    @Autowired
    private LoginAction loginAction;

    @RequestMapping(value = DuMockUrlConstants.LOGIN_JSON,method = {RequestMethod.POST})
    public RequestResult uploadJar(UserVO userVO,HttpServletResponse response) {
        try {
            response.getWriter().write(JSON.toJSONString(RequestResult.success()));
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
}

结果成了如下图所示,返回的是json格式的字符串,和上文通过@RestController,@ResponseBody不一样的数据。这里的乱码先忽略不用管。

Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第2张图片
屏幕快照 2018-07-13 下午11.43.47.png

为什么会出现这样的问题,按照我的理解,springmvc肯定底层会做json格式数据转换,转换成json,然后写入到流中,难道是我写json格式的姿势不正确?
带着这个疑问,动手调试springMvc源代码,从 DispatcherServlet开始,一路找相应的返回值,最终在HandlerAdapter中找到调用反射获取返回对象 RequestResult该对象。
Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第3张图片
HandlerAdapter.java

Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第4张图片
ServletInvocableHandlerMethod.java

找到该对象,差不多往输出流中写数据也就快到了,然后继续往下看。
Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第5张图片
RequestResponseBodyMethodProcessor.java

调试到 RequestResponseBodyMethodProcessor对象时,发现了写流的地方,就在上文单步调试的位置,终于要找到了。。。 然而下班了。
然后下班途中就顺手在我们精尽XXX小分队的微信群中问了一句,如下图:
Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第6张图片
1.jpeg

在各位大佬的集思广益之下,终于答案浮出水面:
Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第7张图片
3.jpeg

一个关键字, HttpMessageConverter浮出水面,终于在刚才那个方法的实现类中找到了write方法。如下:
MappingJackson2CborHttpMessageConverterHttpMessageConvert的实例, 通过write方法写数据,最终返回的是Json对象,而不是json数据串。
然后通过下面代码,证明了这一点:

@RequestMapping(value = DuMockUrlConstants.LOGIN_JSON,method = {RequestMethod.POST})
public RequestResult uploadJar(UserVO userVO,HttpServletResponse response){
   RequestResult requestResult= RequestResult.success();
    MappingJackson2HttpMessageConverter converter=new MappingJackson2HttpMessageConverter();
    try{
        converter.write(requestResult, requestResult.getClass(), MediaType.APPLICATION_JSON_UTF8, new ServletServerHttpResponse(response));
    }catch (Exception e){
        e.printStackTrace();
    }
    return null;
}

终于,通过@ResponseBody和@RestController和通过流写入json的格式实现一样了。
不得不感叹人外有人,天外有天,谦虚使人进步,查了一下午不敌别人一句话来得快,要虚心学习了。
局势有了新突破,深夜总会给人很多思考,大半夜群里一声吼,吓得我赶紧起来看看。


Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象_第8张图片
4.jpeg

代码做了如下改动:

response.setContentType("application/json;charset=UTF-8");
response.getWriter().write(JSON.toJSONString(requestResult));

结果如第一个图一样,还以为是spring本身做了转换,原来是我自己的response的ContentType未设置导致的问题
好吧,mark一下这个问题,希望后面不要有人踩这个坑。

你可能感兴趣的:(Spring的ResponseBody和RestController注解返回的json数据不是json字符串,而是json对象)