一招搞定Dto自定义校验规则，轻松说拜拜唯一值判断
2023-09-08 22:37:39
Dto 自定义校验规则：告别重复冗余的字段唯一性判断
前言
在软件开发过程中，字段唯一性验证是一个常见的需求。尤其是在注册或数据更新场景下，我们经常需要判断特定字段是否已存在，这往往需要编写大量冗余的代码来检查各个字段。为了解决这一问题，Dto 自定义校验规则应运而生，它允许我们在 Dto 中定义校验规则，将校验逻辑与业务逻辑分离，使代码更加清晰易读。
1. 引入依赖
对于 Java 开发，可以使用 Hibernate Validator 依赖来实现 Dto 校验功能。在 Maven 项目中添加以下依赖：
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>7.0.1.Final</version>
</dependency>
2. 定义校验规则
在 Dto 中，我们可以使用 javax.validation.constraints 包下的注解来定义校验规则。常用的注解包括：
@NotBlank：不能为空@NotNull：不能为 null@Size：字符串长度范围@Email：邮箱格式@Pattern：正则表达式
例如，以下代码定义了一个 UserDto，其中 username 字段不能为空，password 字段长度必须在 6 到 16 位之间：
import javax.validation.constraints.*;
public class UserDto {
@NotBlank
private String username;
@Size(min = 6, max = 16)
private String password;
}
3. 使用校验规则
在进行字段验证时，我们可以使用 javax.validation.Validator 接口来进行校验：
import javax.validation.Validator;
public class UserController {
private Validator validator;
public boolean validate(UserDto userDto) {
Set<ConstraintViolation<UserDto>> violations = validator.validate(userDto);
return violations.isEmpty();
}
}
4. 自定义校验规则
除了使用内置的校验注解外，我们还可以自定义校验规则，例如判断用户名是否已存在：
import javax.validation.Constraint;
import javax.validation.Payload;
@Constraint(validatedBy = UniqueUsernameValidator.class)
public @interface UniqueUsername {
String message() default "Username already exists";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class UniqueUsernameValidator implements ConstraintValidator<UniqueUsername, String> {
@Override
public boolean isValid(String username, ConstraintValidatorContext context) {
// 根据 username 去数据库中查询，判断是否已经存在
return !usernameExists(username);
}
private boolean usernameExists(String username) {
// 根据 username 去数据库中查询，返回是否存在
return false;
}
}
然后，我们就可以在 Dto 中使用这个自定义校验注解：
import javax.validation.constraints.*;
public class UserDto {
@NotBlank
private String username;
@UniqueUsername
private String password;
}
5. 示例代码
假设我们有一个 User 实体，其中 username 字段需要保证唯一性。我们可以使用 Dto 自定义校验规则来实现这一功能：
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(unique = true)
private String username;
}
@Validated
public class UserDto {
@NotBlank
private String username;
}
@PostMapping("/register")
public ResponseEntity<String> register(@Valid @RequestBody UserDto userDto) {
// ... 省略业务逻辑 ...
}
结语
Dto 自定义校验规则为我们提供了一种优雅的方式来处理字段唯一性验证。它将校验逻辑与业务逻辑分离，使代码更加清晰易读，也便于维护。通过自定义校验规则，我们可以灵活地定义各种验证条件，满足不同的业务需求。
常见问题解答
-
为什么需要 Dto 自定义校验规则？
- 因为它可以将校验逻辑与业务逻辑分离，使代码更加清晰易读，也便于维护。
-
如何定义自定义校验规则？
- 我们可以在 Dto 中使用 javax.validation.constraints 包下的注解来定义校验规则，也可以自定义校验注解。
-
如何使用 Dto 自定义校验规则？
- 我们可以在进行字段验证时，使用 javax.validation.Validator 接口来进行校验。
-
Dto 自定义校验规则的优点是什么？
- 可以提高代码的质量和可维护性。
- 可以灵活地定义各种验证条件，满足不同的业务需求。
-
Dto 自定义校验规则有什么局限性？
- 对于复杂或需要大量计算的校验规则，使用 Dto 自定义校验规则可能会降低性能。
