如何标准化 JHipster 应用程序中的 REST 错误?
How to standardize REST errors in a JHipster app?
我已经使用 JHipster 作为起始模板构建了一个应用程序。
JHipster 提供了一个 ExceptionTranslator
class,用 @ControllerAdvice
注释,它对控制器中客户端请求生成的错误进行异常处理。此 class 将异常类型映射到方法,每个方法构建并 returns 一个 ErrorDTO
类型的对象,然后在 JSON 中序列化并发送到客户端。我为一个简单的用例添加了自己的方法:
@ExceptionHandler(IllegalArgumentException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public ErrorDTO processIllegalArgumentException(IllegalArgumentException exception) {
return new ErrorDTO(ErrorConstants.ERR_VALIDATION, exception.getMessage());
}
它工作得很好,如果发生错误(在本例中是一个太短的值),我会在客户端收到此 JSON :
{
"message":"error.validation",
"description":"The request payload that defines the search terms should be at least 3 characters long.",
"fieldErrors":null
}
但是,当错误是由Spring MVC本身在进入控制器之前产生的(例如缺少必需的参数)时,客户端接收到的json的结构是不同的,例如:
{
"timestamp":"2015-11-27T15:08:32.897+0000",
"status":400,
"error":"Bad Request",
"exception": "org.springframework.http.converter.HttpMessageNotReadableException",
"message":"Required request body is missing: public java.lang.String ch.unine.directory.web.rest.SearchResource.search(java.lang.String)",
"path":"/api/search"
}
class Spring Boot/Spring MVC 用来表示错误的 class(或其他机制)是什么?如何在出错时统一发送回客户端的数据类型,以便我可以为错误页面提供一个漂亮的唯一模板?
我在这个博客上找到了解决方案 post : http://www.jayway.com/2014/10/19/spring-boot-error-responses/ :
在@ExceptionHandler
方法中,只需指定状态码,剩下的交给Spring处理。它将生成 JSON 响应,其字段与进入控制器之前发生错误时的字段相同:
@ExceptionHandler
void handleIllegalArgumentException(IllegalArgumentException e, HttpServletResponse response) throws IOException {
response.sendError(HttpStatus.BAD_REQUEST.value());
}
响应正文示例:
{
"timestamp": "2015-11-27T16:08:46.148+0000",
"status": 400,
"error": "Bad Request",
"exception": "java.lang.IllegalArgumentException",
"message": "The request payload that defines the search terms should be at least 3 characters long.",
"path": "/api/search"
}
我已经使用 JHipster 作为起始模板构建了一个应用程序。
JHipster 提供了一个 ExceptionTranslator
class,用 @ControllerAdvice
注释,它对控制器中客户端请求生成的错误进行异常处理。此 class 将异常类型映射到方法,每个方法构建并 returns 一个 ErrorDTO
类型的对象,然后在 JSON 中序列化并发送到客户端。我为一个简单的用例添加了自己的方法:
@ExceptionHandler(IllegalArgumentException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public ErrorDTO processIllegalArgumentException(IllegalArgumentException exception) {
return new ErrorDTO(ErrorConstants.ERR_VALIDATION, exception.getMessage());
}
它工作得很好,如果发生错误(在本例中是一个太短的值),我会在客户端收到此 JSON :
{
"message":"error.validation",
"description":"The request payload that defines the search terms should be at least 3 characters long.",
"fieldErrors":null
}
但是,当错误是由Spring MVC本身在进入控制器之前产生的(例如缺少必需的参数)时,客户端接收到的json的结构是不同的,例如:
{
"timestamp":"2015-11-27T15:08:32.897+0000",
"status":400,
"error":"Bad Request",
"exception": "org.springframework.http.converter.HttpMessageNotReadableException",
"message":"Required request body is missing: public java.lang.String ch.unine.directory.web.rest.SearchResource.search(java.lang.String)",
"path":"/api/search"
}
class Spring Boot/Spring MVC 用来表示错误的 class(或其他机制)是什么?如何在出错时统一发送回客户端的数据类型,以便我可以为错误页面提供一个漂亮的唯一模板?
我在这个博客上找到了解决方案 post : http://www.jayway.com/2014/10/19/spring-boot-error-responses/ :
在@ExceptionHandler
方法中,只需指定状态码,剩下的交给Spring处理。它将生成 JSON 响应,其字段与进入控制器之前发生错误时的字段相同:
@ExceptionHandler
void handleIllegalArgumentException(IllegalArgumentException e, HttpServletResponse response) throws IOException {
response.sendError(HttpStatus.BAD_REQUEST.value());
}
响应正文示例:
{
"timestamp": "2015-11-27T16:08:46.148+0000",
"status": 400,
"error": "Bad Request",
"exception": "java.lang.IllegalArgumentException",
"message": "The request payload that defines the search terms should be at least 3 characters long.",
"path": "/api/search"
}