Spring Boot中@GetMapping校验请求参数字段是否存在的实现方法

Spring Boot默认会忽略请求中与目标绑定对象不匹配的未知参数，要实现检测未知参数并抛出异常，可通过修改WebDataBinder的配置来实现，无需改用Map接收参数。

方法一：针对单个Controller生效 #

在你的Controller类中添加@InitBinder方法，将ignoreUnknownFields设为false：

@RestController
public class MyController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 关闭忽略未知字段，遇到未定义的参数时抛出BindException
        binder.setIgnoreUnknownFields(false);
    }

    @GetMapping(value = "/action")
    public List<MyObject> myAction(MyObject myObject) {
        // 业务逻辑
        return Collections.singletonList(myObject);
    }
}

方法二：全局生效（所有Controller） #

如果希望所有接口都启用未知参数检测，可使用@ControllerAdvice定义全局绑定规则：

@ControllerAdvice
public class GlobalBindingConfig {

    @InitBinder
    public void initGlobalBinder(WebDataBinder binder) {
        binder.setIgnoreUnknownFields(false);
    }
}

自定义异常响应 #

当检测到未知参数时，Spring会抛出BindException，你可以通过全局异常处理器返回友好的错误信息：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BindException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public Map<String, Object> handleBindException(BindException ex) {
        Map<String, Object> response = new HashMap<>();
        response.put("code", 400);
        response.put("message", "请求包含未定义的参数");
        // 可获取具体的未知参数信息
        String unknownField = ex.getFieldError().getField();
        response.put("detail", String.format("未知参数：%s", unknownField));
        return response;
    }
}

说明 #

• WebDataBinder的ignoreUnknownFields默认值为true，设置为false后，Spring在参数绑定过程中发现目标对象不存在的字段时，会立即抛出BindException。
• 该方式完全保留了你原有的MyObject参数绑定逻辑，无需改用Map或其他形式。

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