验证框架的魅力之二：验证引擎的自定义约束注解

2024-02-12 21:09:29

前言

在上一篇文章中，我们了解了验证框架的基本概念和使用方式。本篇将深入探讨验证框架的自定义约束注解，揭秘验证引擎背后的原理，并指导开发者如何扩展已有的约束注解或创建新的约束注解来满足复杂的数据校验需求。

自定义约束注解

验证框架支持自定义约束注解，允许开发者根据实际需要创建自己的约束注解。自定义约束注解的本质是扩展javax.validation.Constraint接口或其子类，并通过@Documented和@Target注解指定约束注解的文档和作用目标。

扩展已有约束注解

验证框架提供了一系列常用的约束注解，如@NotNull、@Size和@Pattern等。开发者可以扩展这些注解来满足更细粒度的校验需求。例如，可以扩展@Size注解来校验字符串的最小长度和最大长度，而不仅仅是长度是否为零。

@Documented
@Constraint(validatedBy = MySizeValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface MySize {

    String message() default "{javax.validation.constraints.Size.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    int min() default 0;

    int max() default Integer.MAX_VALUE;
}

创建新的约束注解

除了扩展已有约束注解，开发者还可以创建完全新的约束注解来校验特定类型的业务规则。例如，可以创建一个@Unique注解来校验数据库中是否存在同名记录。

@Documented
@Constraint(validatedBy = UniqueValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface Unique {

    String message() default "{com.example.Unique.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    String field();
}