Spring Boot REST接口如何捕获RequestBody中的无效参数？

这个问题我之前也碰到过，默认情况下Jackson会悄悄忽略请求体中未匹配到POJO字段的属性，不会抛出任何异常，确实容易漏掉这类拼写错误或者多余参数的问题。不过咱们可以通过调整Jackson的配置，结合Spring的异常处理机制来解决，同时还能满足你字段可选的需求，具体操作如下：

1. 开启未知属性检测 #

Jackson提供了配置项，让我们可以在遇到未定义的属性时抛出异常，有两种配置方式：

全局配置（所有接口生效） #

在你的application.properties或者application.yml中添加以下配置：

• 对于properties文件：

spring.jackson.deserialization.fail-on-unknown-properties=true

• 对于yml文件：

spring:
  jackson:
    deserialization:
      fail-on-unknown-properties: true

开启后，只要请求体里存在POJO未定义的属性，Jackson就会抛出JsonMappingException，Spring会自动将其转换为HttpMessageNotReadableException。

局部配置（仅指定POJO生效） #

如果不想全局开启严格模式，只想针对SearchCriteria类生效，可以在该类上添加@JsonIgnoreProperties注解，设置ignoreUnknown = false：

@JsonIgnoreProperties(ignoreUnknown = false)
public class SearchCriteria {
    private String string1;
    private String string2;
    private String string3;

    // getter、setter、构造函数
}

这样只有在反序列化SearchCriteria时遇到未知属性才会报错，其他POJO不受影响。

2. 捕获异常并返回友好提示 #

开启检测后，遇到无效参数会抛出异常，但默认的错误返回不够友好，我们可以自定义全局异常处理器来捕获这个异常，解析出具体的无效字段并返回给前端：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity<ErrorResponse> handleInvalidRequestBody(HttpMessageNotReadableException ex) {
        String errorMsg = "请求体包含无效参数";
        // 解析Jackson抛出的具体异常信息
        if (ex.getCause() instanceof JsonMappingException) {
            JsonMappingException jsonEx = (JsonMappingException) ex.getCause();
            List<JsonMappingException.Reference> invalidFields = jsonEx.getPath();
            if (!invalidFields.isEmpty()) {
                String invalidFieldName = invalidFields.get(0).getFieldName();
                errorMsg = String.format("请求体中存在未定义的参数: %s", invalidFieldName);
            }
        }
        ErrorResponse response = new ErrorResponse(HttpStatus.BAD_REQUEST.value(), errorMsg);
        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
    }

    // 自定义错误响应体
    static class ErrorResponse {
        private int status;
        private String message;

        public ErrorResponse(int status, String message) {
            this.status = status;
            this.message = message;
        }

        // getter和setter
        public int getStatus() { return status; }
        public void setStatus(int status) { this.status = status; }
        public String getMessage() { return message; }
        public void setMessage(String message) { this.message = message; }
    }
}

这样前端就能收到清晰的错误提示，比如{"status":400,"message":"请求体中存在未定义的参数: strang1"}。

3. 保留字段可选性的注意事项 #

你提到的3个String字段是可选的，这个需求和上面的配置完全不冲突：

• 只要不给这些字段添加@NotNull、@NotBlank这类校验注解，请求体中可以不提供这些字段，Jackson会将它们设为null，不会触发任何异常。
• 如果后续需要将某些字段设为必填，只需给对应字段添加校验注解即可，和未知属性检测的逻辑互不影响。

额外说明 #

• 如果你的POJO有继承关系，要注意父类的@JsonIgnoreProperties注解会被子类继承，若子类需要不同的规则，可以在子类上重新注解覆盖。
• 对于嵌套的POJO对象，同样需要给嵌套类开启未知属性检测，或者通过全局配置统一生效。

内容的提问来源于stack exchange，提问作者DevelopingDeveloper