所有HTTP错误响应都应该具有相同的JSON结构吗？

Question

我们正在用Spring Boot开发一个REST服务，并陷入了困境，想知道是否每个错误响应都应该具有相同的JSON结构？

对于错误情况，我们的服务使用简单的JSON格式进行响应。例如，如果参数格式错误，我们将以HTTP状态400和JSON响应：

{
  "errorCode": 05,
  "message": "provided paramter XY is malformed"
}

errorCode是我们的自html" target="_blank">定义代码id。人们可能会争论这种设计是否好，但它很简单，服务消费者可以轻松处理。

现在，Spring Boot会自动创建一些错误响应。例如，对于一个TypeMismatchExc0019和具有HTTP状态的响应400被创建。但是当然，这些自动生成的响应不具有错误格式。

所以我们遇到的情况是，服务消费者事先不知道HTTP状态400的正文中是否有简单的JSON错误格式。我们真的应该覆盖所有Spring Boot默认异常处理，以便在每个响应中使用我们的格式，还是服务消费者应该吞下苦果，确定是否使用了简单的JSON格式？

Answer 1

这取决于你项目的规模。如果您的API被许多应用程序使用，您应该采用“捕获一切并使用JSON格式”的方法。是的，你会有更多的事情要做，但是当你公司的其他应用程序都可以使用你的标准方式时，他们可以节省很多时间。

在我参与的大多数项目中，我们也有一个“标准方式”来回复我们的错误响应（也是JSON）：

@RestControllerAdvice
public class GlobalResourceExceptionHandler {

    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalResourceExceptionHandler.class);

    // the class ValidationError contains the properties the json should contain.
    @ExceptionHandler(Exception.class)
    public List<ValidationError> exceptionHandler(Exception e, HttpServletResponse response) {
        LOGGER.warn("Exception thrown in a resource", e);
        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
        return Collections.singletonList(new ValidationError(null, "unexpected exception"));
    }
}

您可以使用更多的@ExceptionHandlers扩展该类。

事实证明，这是一个非常好的方法，因为它易于实现（也适用于小型应用程序），并且涵盖了很多内容。很多基本上意味着与Rest请求有关的一切。排除在外的是一个资源处理程序，它提供了一个角应用程序和安全层。

更新：结论：当你有一个被许多应用程序使用的api时，抓住一切。在这两种情况下（小应用或大应用），您都应该使用上面所示的方式开始错误处理。