spring boot使用validate注解

水深无声 2024-03-23 13:21 127阅读 0赞

使用\`@Validate\`注解进行参数校验时，如果校验失败会抛出\`MethodArgumentNotValidException\`异常。因此，需要在代码中处理该异常以返回给客户端相应的错误信息。一般来说，建议在Controller层使用\`@ExceptionHandler\`注解统一处理该异常，将错误信息封装为统一的返回格式返回给客户端。这样可以使代码更加规范和易于维护。而对于自定义的注解，如果需要进行特殊的处理，例如将校验失败的信息写入日志或者进行其他业务操作，可以通过自定义\`HandlerMethodArgumentResolver\`来实现。但一般情况下，使用\`@Validate\`注解并配合\`@ExceptionHandler\`注解即可满足大部分场景的需求。

在DTO上加上\`@NotNull\`等校验注解只是定义了校验规则，但不会自动触发校验。需要在Controller层的方法参数前加上\`@Valid\`注解才能触发校验。同时，如果校验失败，会抛出\`MethodArgumentNotValidException\`异常，需要在方法上加上\`@ExceptionHandler\`注解进行统一处理。因此，你需要进行以下操作：

1. 在DTO上添加校验注解，例如\`@NotNull\`。

2. 在Controller层的方法参数前加上\`@Valid\`注解，触发校验。

\`\`\`  
@PostMapping("/user")  
public ResponseEntity<User> createUser(@Valid @RequestBody UserDTO userDTO) \{  
// ...  
\}  
\`\`\`

3. 在Controller层的方法上加上\`@ExceptionHandler\`注解，统一处理校验失败的异常。

\`\`\`  
@ExceptionHandler(MethodArgumentNotValidException.class)  
public ResponseEntity<ErrorResponse> handleValidationExceptions(MethodArgumentNotValidException ex) \{  
// ...  
\}  
\`\`\`

另外，需要注意的是，以上操作只是基础的校验处理，如果需要进行更复杂的校验或者自定义校验规则，可能需要进行更多的操作。

在\`@ExceptionHandler\`注解的方法中，需要编写具体的异常处理逻辑。一般来说，处理逻辑包括以下几个步骤：1. 获取校验失败的字段和错误信息。

\`\`\`  
BindingResult bindingResult = ex.getBindingResult();  
List<FieldError> fieldErrors = bindingResult.getFieldErrors();  
\`\`\`

2. 将错误信息封装为统一的返回格式。

\`\`\`  
List<String> errorMessages = new ArrayList<>();  
for (FieldError fieldError : fieldErrors) \{  
errorMessages.add(fieldError.getField() + ": " + fieldError.getDefaultMessage());  
\}  
ErrorResponse errorResponse = new ErrorResponse("Validation failed", errorMessages);  
\`\`\`

3. 返回封装好的错误信息。

\`\`\`  
return new ResponseEntity<>(errorResponse, HttpStatus.BAD\_REQUEST);  
\`\`\`

下面是一个完整的示例：

List<String> errorMessages = new ArrayList<>();  
for (FieldError fieldError : fieldErrors) \{  
errorMessages.add(fieldError.getField() + ": " + fieldError.getDefaultMessage());  
\}  
ErrorResponse errorResponse = new ErrorResponse("Validation failed", errorMessages);

return new ResponseEntity<>(errorResponse, HttpStatus.BAD\_REQUEST);  
\}  
\`\`\`

在实际开发中，你需要根据具体的业务需求编写异常处理逻辑。如果你不需要进行特殊的处理，可以将方法中的代码留空，这样就会返回一个空的响应。

那么如何实现分组功能

使用\`javax.validation\`提供的分组功能，你可以通过定义不同的校验分组，来实现在不同场景下使用不同的校验规则。具体实现步骤如下：

1. 在DTO的字段上，使用\`@NotNull\`等校验注解，并通过\`groups\`属性指定校验分组。例如：

\`\`\`  
public class UserDTO \{  
@NotNull(groups = \{Create.class\})  
private String name;  
  
@NotNull(groups = \{Update.class\})  
private Integer age;  
  
// ...  
\}  
\`\`\`

2. 定义校验分组接口。例如：

\`\`\`  
public interface Create \{\}  
  
public interface Update \{\}  
\`\`\`

3. 在Controller层的方法参数前，使用\`@Validated\`注解，并通过\`value\`属性指定使用的校验分组。例如：

\`\`\`  
@PostMapping("/users")  
public ResponseEntity<User> createUser(@Validated(Create.class) @RequestBody UserDTO userDTO) \{  
// ...  
\}  
  
@PutMapping("/users/\{id\}")  
public ResponseEntity<User> updateUser(@Validated(Update.class) @RequestBody UserDTO userDTO, @PathVariable Long id) \{  
// ...  
\}  
\`\`\`

4. 在Controller层的异常处理方法中，可以通过\`BindingResult\#getFieldErrors()\`方法获取到校验失败的字段和错误信息。需要注意的是，通过\`BindingResult\#getFieldErrors()\`获取到的错误信息是所有分组的校验错误信息，需要根据分组进行过滤。例如：

\`\`\`  
@ExceptionHandler(MethodArgumentNotValidException.class)  
public ResponseEntity<ErrorResponse> handleValidationExceptions(MethodArgumentNotValidException ex) \{  
BindingResult bindingResult = ex.getBindingResult();  
List<FieldError> fieldErrors = bindingResult.getFieldErrors();  
  
List<String> errorMessages = new ArrayList<>();  
for (FieldError fieldError : fieldErrors) \{  
if (fieldError.getArguments().length > 0 && fieldError.getArguments()\[0\] instanceof Class) \{  
Class<?> clazz = (Class<?>) fieldError.getArguments()\[0\];  
if (clazz == Create.class) \{  
errorMessages.add("create-" + fieldError.getField() + ": " + fieldError.getDefaultMessage());  
\} else if (clazz == Update.class

上面的只能处理一个方法的异常

下面我做全局异常处理

你可以创建一个全局异常处理类来管理所有的异常，统一处理所有Controller层的异常。具体实现步骤如下：1. 创建一个全局异常处理类，例如\`GlobalExceptionHandler\`，并在类上添加\`@ControllerAdvice\`注解。

\`\`\`  
@ControllerAdvice  
public class GlobalExceptionHandler \{  
// ...  
\}  
\`\`\`

2. 在该类中添加\`@ExceptionHandler\`注解的方法，用于处理不同的异常类型。

\`\`\`  
@ExceptionHandler(MethodArgumentNotValidException.class)  
public ResponseEntity<ErrorResponse> handleValidationExceptions(MethodArgumentNotValidException ex) \{  
// ...  
\}  
  
@ExceptionHandler(RuntimeException.class)  
public ResponseEntity<ErrorResponse> handleRuntimeException(RuntimeException ex) \{  
// ...  
\}  
  
// ...  
\`\`\`

3. 在每个\`@ExceptionHandler\`注解的方法中，添加具体的异常处理逻辑。

4. 在Controller层的方法中，不需要添加异常处理方法，因为此时异常已经被全局异常处理类所管理，会自动进入对应的\`@ExceptionHandler\`方法进行处理。

通过以上步骤，你就可以实现全局统一管理所有Controller层的异常，避免在每个Controller层的方法中都添加异常处理方法，使得代码更加简洁和易于维护。