<Spring实战(第四版)笔记>——REST发送错误信息给客户端
情景描述:客户端传入id,服务端查找对象并返回信息。
@RestController
@RequestMapping(value = "city")
public class CityRestController {
@Autowired
private CityService cityService;
@RequestMapping(value = "/api/{id}", method = RequestMethod.GET)
public City findOneCity(@PathVariable("id") Long id) {
return cityService.findCityById(id);
}
}
如果根据给定的ID,无法找到某个city对象的ID属性能够与之匹配,findOneCity()方法返回null的时候,你觉得会发生什么呢?
结果就是findOneCity()方法会返回null,响应体为空,不会返回任何有用的数据给客户端。同时,响应中默认的HTTP状态码是200(OK),表示所有的事情运行正常。
但是,所有的事情都是不对的。客户端要求City对象,但是它什么都没有得到。它既没有收到City对象也没有收到任何消息表明出现了错误。
服务器实际上是在说:“这是一个没用的响应,但是能够告诉你一切都正常!”
现在,我们考虑一下在这种场景下应该发生什么。至少,状态码不应该是200,而应该是404(Not Found),告诉客户端它们所要求的内容没有找到。如果响应体中能够包含错误信息而不是空的话就更好了。
Spring提供了多种方式来处理这样的场景:
** 使用@ResponseStatus注解可以指定状态码;**
** 控制器方法可以返回ResponseEntity对象,该对象能够包含更多响应相关的元数据;**
** 异常处理器能够应对错误场景,这样处理器方法就能关注于正常的状况。**
使用ResponseEntity,处理返回的状态码
作为@ResponseBody的替代方案,控制器方法可以返回一个ResponseEntity对象。
ResponseEntity中可以包含响应相关的元数据(如头部信息和状态码)以及要转换成资源表述的对象。
因为ResponseEntity允许我们指定响应的状态码,所以当无法找到City对象的时候,我们可以返回HTTP 404错误。
如下是新版本的findOneCity(),它会返回ResponseEntity:
/**
* @author gucailiang
* @date 2018/10/10
*/
@Controller
@RequestMapping(value = "city")
public class CityController {
@Autowired
private CityService cityService;
/**
* ResponseEntity中可以包含响应相关的元数据(如头部信息和状态码)以及要转换成资源表述的对象。
* ResponseEntity允许我们指定响应的状态码,所以当无法找到City的时候,我们可以返回HTTP 404错误
* <p>
* 路径中得到的ID用来从Repository中检索City。如果找到的话,状态码设置
* 为HttpStatus.OK(这是之前的默认值),但是如果Repository返回null的话,状态码设置为HttpStatus.NOT_FOUND,这会转换为HTTP 404。
* 最后,会创建一个新的ResponseEntity,它会把City和状态码传送给客户
* <p>
* ResponseEntity还包含了@ResponseBody的语义,因此负载部分将会渲染到响应体中,就像之前在方法上使用@ResponseBody注解一样。
* 如果返回ResponseEntity的话,那就没有必要在方法上使用@ResponseBody注解了。
* </p>
*
* @param id
* @return
*/
@RequestMapping(value = "/api2/{id}", method = RequestMethod.GET)
public ResponseEntity<City> findOneCityById(