Spring Boot自定义http错误响应？

Question

如果在Spring Boot Web应用程序中发生异常，我如何自定义响应状态码和响应正文中的数据？

我已经创建了一个Web应用程序，如果由于某些内部状态不正常而导致意外发生，则会引发自定义异常。因此，触发错误的请求的响应机身看起来是这样的：

HTTP/1.1 500 Internal Server Error 
{ 
    "timestamp": 1412685688268, 
    "status": 500, 
    "error": "Internal Server Error", 
    "exception": "com.example.CustomException", 
    "message": null, 
    "path": "/example" 
} 

---

现在，我想改变状态代码，并设置在响应正文中的字段。掠过我想到的一个解决办法是这样的：

@ControllerAdvice 
class CustomResponseEntityExceptionHandler extends ResponseEntityExceptionHandler { 

    @ExceptionHandler 
    @ResponseStatus(HttpStatus.BAD_REQUEST) 
    @ResponseBody 
    ErrorMessage handleBadCredentials(CustomException e) { 
     return new ErrorMessage("Bad things happened"); 
    } 
} 

@XmlRootElement 
public class ErrorMessage(
    private String error; 

    public ErrorMessage() { 
    } 

    public ErrorMessage(String error) { 
     this.error = error; 
    } 

    public String getError() { 
     return error; 
    } 

    public void setError(String error) { 
     this.error = error; 
    } 
) 

然而，创建（涉嫌）完全不同的反应：

HTTP/1.1 400 Bad Request 
{ 
    "error": "Bad things happened" 
} 

Answer 1

HTTP响应状态代码可以通过使用HttpServletResponse.sendError(int)方法改变，例如

@ExceptionHandler({IllegalArgumentException.class, NullPointerException.class}) 
void handleBadRequests(HttpServletResponse response) throws IOException { 
    response.sendError(HttpStatus.BAD_REQUEST.value()); 
} 

更多信息可以在我的blog post发现：

@ExceptionHandler 
void handleIllegalArgumentException(IllegalArgumentException e, HttpServletResponse response) throws IOException { 
    response.sendError(HttpStatus.BAD_REQUEST.value()); 
} 

或者，如果你有两个或两个以上的异常产生相同的响应状态，你可以声明在@ExceptionHandler注释异常类型。

Answer 2

如@zeroflagL所述，Spring Boot在org.springframework.boot.autoconfigure.web.DefaultErrorAttributes中构造“标准”错误响应体。与您的需求类似，我想要充分利用所有这些，但只需增加一些由我的例外提供的“类型”字段。

我通过实施Component来做到这一点，其分类为DefaultErrorAttributes。 Spring Boot自动将其拾起并用于我的默认值。

@Component 
public class ExtendedErrorAttributes extends DefaultErrorAttributes { 
    @Override 
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) { 
     final Map<String, Object> errorAttributes = super.getErrorAttributes(requestAttributes, includeStackTrace); 

     final Throwable error = super.getError(requestAttributes); 
     if (error instanceof TypeProvider) { 
      final TypeProvider typeProvider = (TypeProvider) error; 
      errorAttributes.put("type", typeProvider.getTypeIdentifier()); 
     } 

     return errorAttributes; 
    } 
} 

就这样，我得到了增强JSON响应体，如

{ 
    "timestamp": 1488058582764, 
    "status": 429, 
    "error": "Too Many Requests", 
    "exception": "com.example.ExternalRateLimitException", 
    "message": "DAILY_LIMIT: too many requests", 
    "path": "/api/lookup", 
    "type": "DAILY_LIMIT" 
}