在 Spring Boot 中，数据校验是保障数据合法性和完整性的重要环节，特别是在接收用户输入、请求参数和数据持久化时。Spring Boot 提供了强大的数据校验机制，通过使用 JSR-303 标准的注解，您可以方便地对实体类的字段进行校验。本文将详细介绍在 Spring Boot 中如何进行数据校验。
1. 添加依赖
首先，在 pom.xml 文件中添加 Hibernate Validator 依赖：
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>2. 创建实体类
创建需要校验的实体类，使用 JSR-303 注解标注字段，定义校验规则。
public class User {
@NotEmpty(message = "Username is required")
private String username;
@Email(message = "Invalid email address")
private String email;
@Size(min = 6, max = 20, message = "Password must be between 6 and 20 characters")
private String password;
// Getters and setters
}3. 在控制器中进行校验
在控制器方法中，使用 @Valid 注解标注需要校验的实体类参数，以触发校验过程。
@RestController
public class UserController {
@PostMapping("/users")
public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
// 处理用户创建逻辑
return ResponseEntity.ok("User created successfully");
}
}4. 处理校验结果
如果实体类校验失败，Spring Boot 会自动产生校验错误，您可以通过 BindingResult 对象获取错误信息。
@RestController
public class UserController {
@PostMapping("/users")
public ResponseEntity<String> createUser(@Valid @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
List<FieldError> errors = bindingResult.getFieldErrors();
// 处理错误信息
}
// 处理用户创建逻辑
return ResponseEntity.ok("User created successfully");
}
}5. 自定义校验器
除了使用内置的校验注解，您还可以自定义校验注解和校验器，以满足特定的业务需求。
@Constraint(validatedBy = MyCustomValidator.class)
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyCustomValidation {
String message() default "Invalid value";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
public class MyCustomValidator implements ConstraintValidator<MyCustomValidation, String> {
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
// 自定义校验逻辑
}
}通过以上步骤，您可以在 Spring Boot 中轻松地进行数据校验，保障数据的合法性和完整性。合理地使用校验注解和校验器，可以减少无效数据的输入，增加应用的稳定性和用户体验。