REST 的最佳错误模型是什么

Question

是否有 REST 服务的标准错误消息模型？

我正在构建一个带有 Spring REST 后端和基于 Backbone JS 的前端的 REST 服务。在我所在的所有项目中，都有一些自制的错误消息机制，以及对这些错误的自制客户端解释。对于这个特定的项目，这通常具有有限的范围和用途。

现在，在我当前的项目中，我想为 POST 请求中的无效 JSON 字段引入字段错误。所以我需要扩展我的模型来支持这一点。

在我看来，这又是一辆自行车，因为现场验证是我们这个时代的标准要求，所以我想知道是否已经有一个错误模型，我可以在我的项目中重用它。

我非常熟悉 Spring 中的 HandlerExceptionResolver 和 Java 中的 @Valid 注解。事实上，我正在使用它们分配。这更像是一个架构类型的问题，将此类错误传达给独立 JS 客户端的最佳模型是什么。

Answer 1

我通常做的是创建一个ValidationError 模型。在验证错误的情况下，模型会以 JSON 形式返回给客户端，并带有 HTTP 状态代码，其中包含客户端需要了解的有关错误的所有信息。

模型的细节各不相同，但这样的事情将是一个好的开始：

public class ValidationError {
    private int code;

    private String message;

    private Map<String, String> fields;

    /*...*/
}

现在，当提交无效表单时，JSON 响应将类似于：

{
  "code": 400,
  "message": "invalid form value(s)",
  "fields": {
    "username": "the username already exists",
    "password": "password must be more than 6 characters"
  }
}

这与 Spring 的 @ExceptionHandler 非常吻合。当您收到BindException 之类的信息时，您所要做的就是：

@ExceptionHandler(BindException.class)
@ResponseBody
@ResponseStatus(value = HttpStatus.BAD_REQUEST)
private ValidationError handleBindException(BindException ex) {
    ValidationError validationError = new ValidationError();
    /* set code and message */
    for (FieldError error : ex.getFieldErrors()) {
        /* set fields' errors */
    }
    return validationError;
}

BindException 可以轻松获取字段的错误。从JsonMappingException 等异常中挖掘错误需要做更多工作。

Answer 2

大概最好的方法是在服务器和客户端上都进行验证。由于我对 Spring 不熟悉，因此我的建议仅限于客户：Backbone 确实有一个 validate 方法可用于您的 Backbone 模型。 The Backbone docs 鼓励您使用自己的验证逻辑覆盖此方法。 validate 在你做一个主干模型save（即POST）时默认被调用，你也可以在你想运行验证代码时触发invalid事件（例如，在按键之后，之前用户点击提交按钮）。

如果您不热衷于编写大量自定义前端验证，可以使用一些插件，例如 backbone.validation。