52. 如何在Spring Boot中实现数据验证？如何使用`@Valid`和`@Validated`注解？
大约 4 分钟
在Spring Boot中，数据验证是确保输入数据符合预期格式和规则的重要步骤。Spring Boot通过集成Bean Validation（JSR-303/JSR-380）提供了强大的数据验证功能。常用的注解有@Valid和@Validated，它们可以用来在请求参数、方法参数和实体对象中执行验证。以下是如何在Spring Boot中实现数据验证的详细介绍。
1. 引入必要的依赖
Spring Boot项目通常默认包含了必要的依赖，但如果你的项目没有包含，可以手动添加spring-boot-starter-validation依赖。
Maven依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>这个依赖包括了Hibernate Validator，这是Java Bean Validation的参考实现。
2. 使用@Valid注解进行验证
@Valid注解通常用于方法参数或类的字段上，表示该参数或字段需要进行验证。
2.1 验证Controller方法参数
假设你有一个User类，它包含了一些需要验证的字段：
import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
public class User {
@NotBlank(message = "Name is mandatory")
private String name;
@Email(message = "Email should be valid")
private String email;
@Size(min = 6, message = "Password should have at least 6 characters")
private String password;
// getters and setters
}然后，在Controller中，可以使用@Valid注解来触发验证：
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;
@RestController
@RequestMapping("/users")
public class UserController {
@PostMapping
public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
// 如果验证通过，处理创建用户逻辑
return ResponseEntity.status(HttpStatus.CREATED).body("User created successfully");
}
}在这个例子中：
@Valid：用于触发User对象的字段验证。@RequestBody：将请求体中的JSON数据转换为User对象。
如果请求体中的数据不符合验证规则，Spring Boot将自动返回400 Bad Request状态，并在响应体中包含详细的错误信息。
2.2 验证路径或查询参数
你还可以使用@Valid注解在路径参数或查询参数上进行验证：
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
public class UserIdRequest {
@NotNull(message = "User ID cannot be null")
@Min(value = 1, message = "User ID must be greater than 0")
private Long id;
// getters and setters
}
@RestController
@RequestMapping("/users")
public class UserController {
@GetMapping("/{id}")
public ResponseEntity<User> getUserById(@Valid UserIdRequest request) {
// 根据ID查找用户逻辑
return ResponseEntity.ok(new User());
}
}3. 使用@Validated注解进行分组验证
@Validated注解不仅可以用于类级别，也可以用于方法级别的参数验证。与@Valid不同，@Validated支持分组验证的功能。
3.1 创建验证分组
public class ValidationGroups {
public interface Create {}
public interface Update {}
}3.2 在实体类中使用分组
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
public class User {
@NotBlank(message = "Name is mandatory", groups = ValidationGroups.Create.class)
private String name;
@Size(min = 6, message = "Password should have at least 6 characters", groups = ValidationGroups.Create.class)
private String password;
@Size(min = 6, message = "Password should have at least 6 characters", groups = ValidationGroups.Update.class)
private String newPassword;
// getters and setters
}3.3 在Controller中使用@Validated指定分组
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/users")
public class UserController {
@PostMapping
public ResponseEntity<String> createUser(@Validated(ValidationGroups.Create.class) @RequestBody User user) {
// 创建用户逻辑
return ResponseEntity.status(HttpStatus.CREATED).body("User created successfully");
}
@PutMapping
public ResponseEntity<String> updateUser(@Validated(ValidationGroups.Update.class) @RequestBody User user) {
// 更新用户逻辑
return ResponseEntity.ok("User updated successfully");
}
}在这个示例中：
@Validated：可以用于指定验证分组。groups属性：在实体类的验证注解中通过groups属性指定验证组。
4. 自定义验证注解
有时候内置的验证注解不足以满足需求，你可以创建自定义的验证注解。
4.1 创建自定义注解
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyCustomValidator.class)
public @interface MyCustomConstraint {
String message() default "Invalid value";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}4.2 实现验证逻辑
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class MyCustomValidator implements ConstraintValidator<MyCustomConstraint, String> {
@Override
public void initialize(MyCustomConstraint constraintAnnotation) {
// 初始化逻辑（如果需要）
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
// 自定义验证逻辑
return value != null && value.matches("[A-Z]{2}[0-9]{3}");
}
}4.3 在实体类中使用自定义注解
public class User {
@MyCustomConstraint(message = "Code must be in format: XX123")
private String code;
// 其他字段和getter/setter
}5. 处理验证错误
Spring Boot默认会将验证错误返回给客户端，但你可以通过全局异常处理器来自定义错误响应。
5.1 使用@ExceptionHandler处理验证异常
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.Map;
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
Map<String, String> errors = new HashMap<>();
ex.getBindingResult().getFieldErrors().forEach(error ->
errors.put(error.getField(), error.getDefaultMessage())
);
return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
}
}在这个示例中，当验证失败时，MethodArgumentNotValidException会被抛出，@ExceptionHandler会捕获该异常并生成自定义的错误响应。
6. 总结
在Spring Boot中，@Valid和@Validated注解提供了强大的数据验证功能。@Valid注解通常用于简单的场景，而@Validated注解更适合复杂的分组验证需求。Spring Boot还支持自定义验证注解，以应对更复杂的验证逻辑。通过合理使用这些注解和异常处理机制，你可以确保应用的数据输入是安全、可靠的。