本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net
在 Spring Boot 中进行分组校验
前言
环境版本号
springboot 3.1.3
java 17
在 Spring Validation 中，分组是一种通过 @Validated 注解和 groups 属性进行指定的校验方式。默认情况下，如果不指定分组，会使用默认分组进行校验。同时，分组之间可以通过继承关系来复用校验规则。
1. 默认分组
代码如下：在没有指定分组的情况下，会使用默认分组进行校验
public class User {
@NotBlank(message = "用户名不能为空")
private String username;
@NotBlank(message = "密码不能为空")
private String password;
// 其他字段...
// 对应的 getter 和 setter 方法...
}
代码如下：在控制器中，@Valid 注解默认会使用默认分组进行校验。
@RestController
@RequestMapping("/user")
@Validated
public class UserController {
@PostMapping("/add")
public ResponseEntity<String> addUser(@Valid @RequestBody User user) {
// 处理用户添加逻辑
// ...
return ResponseEntity.ok("User added successfully");
}
}
2. 自定义分组
代码如下：可以通过定义接口作为分组标识，然后在校验注解的 groups 属性中指定使用哪个分组
public class User {
public interface BasicInfoGroup {}
public interface UpdateInfoGroup {}
@NotBlank(message = "用户名不能为空", groups = {BasicInfoGroup.class, UpdateInfoGroup.class})
private String username;
@NotBlank(message = "密码不能为空", groups = {BasicInfoGroup.class})
@Size(min = 5, max = 16, message = "密码长度必须在5到16位之间", groups = {BasicInfoGroup.class, UpdateInfoGroup.class})
private String password;
// 其他字段...
// 对应的 getter 和 setter 方法...
}
代码如下：在控制器中使用分组，@Validated(User.BasicInfoGroup.class) 表示在添加用户时只校验 BasicInfoGroup 分组的规则，而 @Validated(User.UpdateInfoGroup.class) 表示在更新用户时只校验 UpdateInfoGroup 分组的规则
@RestController
@RequestMapping("/user")
@Validated
public class UserController {
@PostMapping("/add")
public ResponseEntity<String> addUser(@Validated(User.BasicInfoGroup.class) @RequestBody User user) {
// 处理用户添加逻辑
// ...
return ResponseEntity.ok("User added successfully");
}
@PutMapping("/update")
public ResponseEntity<String> updateUser(@Validated(User.UpdateInfoGroup.class) @RequestBody User user) {
// 处理用户更新逻辑
// ...
return ResponseEntity.ok("User updated successfully");
}
}
3. 分组继承
代码如下：分组之间还可以通过继承关系来实现校验规则的复用。
public class User {
public interface BasicInfoGroup {}
public interface UpdateInfoGroup extends BasicInfoGroup {}
@NotBlank(message = "用户名不能为空", groups = {BasicInfoGroup.class, UpdateInfoGroup.class})
private String username;
@NotBlank(message = "密码不能为空", groups = {BasicInfoGroup.class})
@Size(min = 5, max = 16, message = "密码长度必须在5到16位之间", groups = {BasicInfoGroup.class, UpdateInfoGroup.class})
private String password;
// 其他字段...
// 对应的 getter 和 setter 方法...
}
代码如下：在控制器中使用分组，UpdateInfoGroup 分组继承了 BasicInfoGroup 分组的规则，因此在更新用户时，不仅会校验 UpdateInfoGroup 分组的规则，还会校验 BasicInfoGroup 分组的规则。
@RestController
@RequestMapping("/user")
@Validated
public class UserController {
@PostMapping("/add")
public ResponseEntity<String> addUser(@Validated(User.BasicInfoGroup.class) @RequestBody User user) {
// 处理用户添加逻辑
// ...
return ResponseEntity.ok("User added successfully");
}
@PutMapping("/update")
public ResponseEntity<String> updateUser(@Validated(User.UpdateInfoGroup.class) @RequestBody User user) {
// 处理用户更新逻辑
// ...
return ResponseEntity.ok("User updated successfully");
}
}