MethodArgumentNotValidException

MethodArgumentNotValidException 是 Spring 框架中用于处理方法参数验证失败时抛出的异常。通常在使用 Spring MVC 或 Spring Boot 时，当请求体中的数据未通过验证注解（如 @NotNull, @Size, @Min, @Max 等）的检查时，会抛出此异常。

触发场景

假设你有一个 REST 控制器，它接收一个包含验证注解的对象作为请求体。如果请求体中的数据不符合验证规则，Spring 会抛出 MethodArgumentNotValidException。

示例:

1.定义一个带有验证注解的DTO

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;public class UserDTO {@NotNull(message = "Name cannot be null")@Size(min = 2, max = 30, message = "Name must be between 2 and 30 characters")private String name;// Getters and setterspublic String getName() {return name;}public void setName(String name) {this.name = name;}
}

2.创建一个接收此 DTO 的控制器

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;import javax.validation.Valid;
import java.util.HashMap;
import java.util.Map;@RestController
public class UserController {@PostMapping("/users")public ResponseEntity<String> createUser(@Valid @RequestBody UserDTO user) {return ResponseEntity.ok("User is valid");}@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {Map<String, String> errors = new HashMap<>();ex.getBindingResult().getAllErrors().forEach((error) -> {String fieldName = ((FieldError) error).getField();String errorMessage = error.getDefaultMessage();errors.put(fieldName, errorMessage);});return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errors);}
}

解释

DTO 定义：UserDTO 类包含一个 name 字段，并使用 @NotNull 和 @Size 注解来指定验证规则。
控制器：UserController 包含一个接收 UserDTO 对象的 POST 请求处理方法 createUser，该方法使用 @Valid 注解来触发验证。
异常处理：handleValidationExceptions 方法使用 @ExceptionHandler(MethodArgumentNotValidException.class) 注解来捕获验证失败时抛出的 MethodArgumentNotValidException，并将错误信息提取到一个 Map 中返回给客户端。

验证失败示例

如果客户端发送一个无效的请求体：

{"name": "A"
}

由于 name 字段的长度小于 2 个字符，MethodArgumentNotValidException 将被抛出，并由异常处理方法处理，返回以下响应：

{"name": "Name must be between 2 and 30 characters"
}

其他注意事项

全局异常处理器：使用 @ControllerAdvice 创建一个全局异常处理器，以集中处理所有控制器中的验证异常。
自定义验证注解：除了内置的验证注解，你还可以创建自定义的验证注解来满足特定的业务需求。
绑定结果：在需要更灵活的错误处理时，可以注入 BindingResult 并手动检查验证错误。

全局异常处理器示例

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;import java.util.HashMap;
import java.util.Map;@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {Map<String, String> errors = new HashMap<>();ex.getBindingResult().getAllErrors().forEach((error) -> {String fieldName = ((FieldError) error).getField();String errorMessage = error.getDefaultMessage();errors.put(fieldName, errorMessage);});return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errors);}
}