ResponseEntity总结

@Author：Guzi499

@QQ：504305797

@Date：2020/01/11

1.理解

csdn某位大佬在一篇文章的评论中总结的很好，这里直接拿过来

ResponseEntity的优先级高于@ResponseBody。在不是ResponseEntity的情况下才去检查有没有@ResponseBody注解。如果响应类型是ResponseEntity可以不写@ResponseBody注解，写了也没有关系。
ResponseEntity 是在 org.springframework.http.HttpEntity 的基础上添加了http status code(http状态码)，用于RestTemplate以及@Controller的HandlerMethod。它在Controller中或者用于服务端响应时，作用是和@ResponseStatus与@ResponseBody结合起来的功能一样的。用于RestTemplate时，它是接收服务端返回的http status code 和 result的。
总结：简单粗暴的讲 @ResponseBody可以直接返回Json结果， @ResponseEntity不仅可以返回json结果，还可以定义返回的HttpHeaders和HttpStatus

其实我之前在某论坛上也看到有人这样介绍ResponseEntity<T>(忘记原话了)：

一般我们返回结果都是自定义vo类返回给前台，但是你要是没有其他需要的话，直接用ResponseEntity<T>来返回你想返回的对象。

2.基本使用

@RequestMapping(value="/demo1"`)
public ResponseEntity demo1(){//使用方式一//    ResponseEntity responseEntity = new ResponseEntity(new User("lvbb",24),HttpStatus.OK);//使用方式二   returnResponseEntity.ok(new User("lvbb",24));
}

ResponseEntity类继承自HttpEntity，有三个关键属性 httpStatus 、body、httpHeader，分别代表响应状态码、响应体、响应头信息；

2.1 返回状态码200

下面，我来演示一下目前我碰到的一些使用情况：

2.1.1 返回200且无返回值

@GetMapping("/hello")
public ResponseEntity<User> getBean(){//...业务处理中//只用关注这一句return ResponseEntity.ok(null);
}

2.1.2 返回200且有返回值

@GetMapping("/hello")
public ResponseEntity<User> getBean(){//...业务处理中User user = new User();user.setUserName("guzi");user.setAge(24);//只用关注这一句return ResponseEntity.ok(user);
}

2.2 返回状态码非200

先介绍一下ResponseEntity<T>中的方法，如果你能看得懂的话，就大概看一下，然后自己翻翻源码，如果能力有限，请看我案例,标注出来的为我目前使用过的方法。

2.2.1 返回状态码非200且无返回值

@GetMapping("/hello")
public ResponseEntity<User> getBean(){//...业务处理中//只用关注这一句return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
}

Httpstatus.INTERNAL_SERVER_ERROR代表已定义的相应状态码，如上则为INTERNAL_SERVER_ERROR（内部服务器错误）即状态码为500，再看看源码，发现是个枚举，也就是我们想返回什么状态码就直接选择对应的枚举项就OK了。这里我抛砖引玉，大家针对自己的情况选择对应的要返回的状态码。至于后面的build方法，要么参考源码(上图指针指向的接口被实现)，要么百度，要么看我演示的两种情况。无返回对象用build方法，有返回用2.2.2中的body方法。

2.2.2 返回状态码非200且有返回值

@GetMapping("/hello")
public ResponseEntity<User> getBean(){//...业务处理中User user = new User();user.setUserName("guzi");user.setAge(24);//只用关注这一句return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(user);
}

2.3 返回状态码非200包含HttpHeaders和HttpStatus

这里目前没使用过，等用到了再补充，如果你准备保存这篇文章，也请你碰到时自行补充！

3.总结

个人观点：

除非有特殊需要，不然我是不会使用这玩意的…，一般请求成功我就返回 json，请求失败就返回 null 。当然了，特殊情况特殊对待。比如接口文档一定要你的返回状态头，自定义返回状态码，你还是得规矩听从的。

知乎上大佬观点：

如果仅仅需要返回json格式的数据，那么添加 @ResponseBody 注解就行了，其他的时候视情况再考虑使用。