如何使用 spring-boot 更改过滤器中的控制器响应以使响应结构在整个 API 中保持一致

Question

我已经使用 spring-boot 应用程序实现了 REST API。我所有的 API 现在都以 JSON 格式为每个实体返回响应。此响应已被其他服务器消耗，该服务器期望所有这些响应都采用相同的 JSON 格式。例如；

我的所有回复都应包含在以下结构中；

public class ResponseDto {
    private Object data;
    private int statusCode;
    private String error;
    private String message;
}

目前 spring-boot 以不同的格式返回错误响应。如何使用过滤器实现这一点。

错误信息格式；

{
   "timestamp" : 1426615606,
   "exception" : "org.springframework.web.bind.MissingServletRequestParameterException",
   "status" : 400,
   "error" : "Bad Request",
   "path" : "/welcome",
   "message" : "Required String parameter 'name' is not present"
}

我的 spring-boot 应用程序中的错误和成功响应都需要在相同的 json 结构中

Answer 1

这可以通过使用ControllerAdvice 并处理所有可能的异常，然后返回您自己选择的响应来实现。

@RestControllerAdvice
class GlobalControllerExceptionHandler {

    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(Throwable.class)
    public ResponseDto handleThrowable(Throwable throwable) {
        // can get details from throwable parameter
        // build and return your own response for all error cases.
    }

    // also you can add other handle methods and return 
    // `ResponseDto` with different values in a similar fashion
    // for example you can have your own exceptions, and you'd like to have different status code for them

    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(CustomNotFoundException.class)
    public ResponseDto handleCustomNotFoundException(CustomNotFoundException exception) {
        // can build a "ResponseDto" with 404 status code for custom "not found exception"
    }
}

Some great read on controller advice exception handlers