java - Spring Boot Controller 处理无效 JSON

Question

我有一个使用 JSON 的 Spring Boot Controller :

    @PostMapping(
    value = "/shipdetails")
    public ResponseEntity acceptShip(@RequestBody Ship ship, HttpServletRequest request) {
        shipService.checkShip(ship);
        return new ResponseEntity<>(HttpStatus.OK);
    }

有一个对应的船舶实体:

public class Ship implements Serializable {

@JsonProperty("Name")
private String name;
@JsonProperty("Owner")
private String owner;

public Ship(String name, String owner) {
    this.name = name;
    this.owner = owner;    }

public Ship() {
}

// Getters and Setters removed for brevity

最后是服务:

@Service
public class ShipService {

Boolean checkShip(Ship ship) {
    if (ship.getName().equals("Queen Mary")) {
         // do something
    }
//edited for brevity

无效 JSON 示例:

{
    "name_wrong":"test name",
    "owner":"Lloyds Shipping"
}

目前，如果我发送无效的 JSON，堆栈跟踪上出现的错误是(服务层):无法调用“String.equals(Object)”，因为“com.ships.Ship.getName() 的返回值” “为空。

Jackson 需要无参数构造函数来进行反序列化。

在调试器中检查时，Ship 实体具有所有者集，但没有名称集，因此并非整个实体为空 - 只有一个字段。

我在没有默认无参数构造函数的情况下尝试了我的 Ship 实体，因此您甚至无法将带有 null 字段的实体传递给服务，但即使有效的 JSON 也会失败。

如何以及在哪里处理无效 JSON 的异常？

Answer 1

需要添加一些注释并检查请求正文 json 的验证。

<强>1。在 pom.xml 中为以下注释添加依赖项 -

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
            <version>3.1.1</version>
</dependency>

<强>2。 @Valid 与请求正文

    @PostMapping(value = "/shipdetails")
    public ResponseEntity acceptShip(@Valid @RequestBody Ship ship, 
                                     HttpServletRequest request)

<强>3。 @NotNull 具有强制属性

    public class Ship implements Serializable {

      @NotNull(message = "The name is mandatory")
      @JsonProperty("Name")
      private String name;
      @JsonProperty("Owner")
      private String owner;

<强>4。 equals方法之前额外的空检查

Boolean checkShip(Ship ship) {
        if (StringUtils.isNotBlank(ship.getName()) 
            && ship.getName().equals("Queen Mary")) {
            // do something
        }

输出无效 json:

输入

    {
     "name_wrong":"test name",
     "owner":"Lloyds Shipping"
    }

输出:您将收到 400 Bad 请求状态，其中包含长错误堆栈跟踪，其中包括类似内容

    "message": "Validation failed for object='ship'. Error count: 1",
"errors": [
    {
        "codes": [
            "NotNull.ship.name",
            "NotNull.name",
            "NotNull.java.lang.String",
            "NotNull"
        ],
        "arguments": [
            {
                "codes": [
                    "ship.name",
                    "name"
                ],
                "arguments": null,
                "defaultMessage": "name",
                "code": "name"
            }
        ],
        "defaultMessage": "The name is mandatory",
        "objectName": "ship",
        "field": "name",
        "rejectedValue": null,
        "bindingFailure": false,
        "code": "NotNull"
    }
]

注意:使用我们的自定义异常处理程序处理 MethodArgumentNotValidException 异常的一些附加代码，以便验证将以正确格式的响应而不是冗长的错误堆栈跟踪并控制状态代码以及如下图所示:

@ControllerAdvice
public class ValidationExceptionHandler {
    /**
     * For an invalid input, spring framework will throw an 
            MethodArgumentNotValidException exception
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<?> notValidInput(MethodArgumentNotValidException e) {
        Map<String,String> errorMap = e.getAllErrors()
                .stream()
                .collect(Collectors.toMap(x -> ((FieldError)x).getField(), 
                 b -> b.getDefaultMessage(),(p,q) -> p, LinkedHashMap::new));
        return new ResponseEntity<>(errorMap, HttpStatus.BAD_REQUEST);
    }
}

无效 json 的格式化输出:

{
    "name": "The name is mandatory"
}