Spring boot API自定义错误响应协定

Question

{
  "success": true,
  "data": {"name": "hello", "completed": false},
  "errors": []
}

{
"timestamp": "2019-11-21T15:41:28.545+0000",
"status": 400,
"error": "Bad Request",
"errors": [
    {
        "codes": [
            "Size.createTodoContract.name",
            "Size.name",
            "Size.java.lang.String",
            "Size"
        ],
        "arguments": [
            {
                "codes": [
                    "createTodoContract.name",
                    "name"
                ],
                "arguments": null,
                "defaultMessage": "name",
                "code": "name"
            },
            10,
            2
        ],
        "defaultMessage": "size must be between 2 and 10",
        "objectName": "createTodoContract",
        "field": "name",
        "rejectedValue": "attend wedding",
        "bindingFailure": false,
        "code": "Size"
    }
],
"message": "Validation failed for object='createTodoContract'. Error count: 1",
"path": "/api/todos"
}

@Getter
public class CreateTodoContract {
  @Size(min = 2, max = 10)
  private String name;

  @NotNull
  private boolean completed;
}

请帮助我了解我应该在哪里更新失败案例的实际合同？

Answer 1

你把项目中的一些编码部分搞乱了。

1）首先，为所有@size注释和所有其他与验证相关的注释(@notnull、@notempty等）添加“message”属性。当您尝试发出失败请求时，API将返回您在“message”属性中提到的错误消息。请参见下面的代码行。这些注释使用javax.validation.constraints库。其他注释也可以。但这样更好。

@Size(min = 1, message = "email can not be empty")
@NotNull(message = "email can not be null")
private String email;

2）然后，您应该通过使用“bindingresult”类（org.springframework.validation）在controller（API定义）中捕获这些无效场景，如下所示。此外，您还应该为您的请求体（CreateTodoContract）使用@valid annotaion；否则，服务器将重新调整您在问题中提到的无效场景的响应。

@PostMapping(value = "createTodoContract")
public ResponseEntity<Object> CreateTodoContract(@Valid @RequestBody 
                                                 CreateTodoContract 
                                                 createTodoContractRequest,
                                                 BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
        String error = bindingResult.getAllErrors().get(0).getDefaultMessage();
        return new ResponseEntity<>(responseBuilder.build("02", error), status);
    }

    return new ResponseEntity<>(response, response.getStatus());

}

字符串错误=BindingResult.GetAllErrors().Get(0).GetDefaultMessage（）

您可以使用上面的代码行得到错误信息。

如果您的API请求有多个需要验证的请求参数，请使用下面提到的代码行捕获错误消息。否则，API会得到不同的错误消息，这是您在代码库中经常提到的（零星问题）

if (bindingResult.hasErrors()) {
        String error = bindingResult.getAllErrors().get(0).getDefaultMessage();

        if (bindingResult.getAllErrors().size() == 1) {
            return new ResponseEntity<>(responseBuilder.build("02", error), status);

        } else {
            return new ResponseEntity<>(
                    responseBuilder.build("02", "mandatory parameters can not be 
            empty, null or invalid"), status);

        }
    }