自定义validation注解：多字段属性关联校验，开发中的秘密武器

后端

2023-01-05 09:41:30

自定义验证注解：关联多字段属性验证

在实际开发中，我们经常遇到需要对多个字段进行关联验证的情况。例如：

用户注册时，需要验证用户名和密码是否符合特定规则。
下订单时，需要验证订单中商品的总价是否超过用户的信用额度。
添加商品时，需要验证商品的名称和价格是否符合特定规则。

使用 Spring Boot 提供的自定义验证注解可以轻松实现这些关联验证。自定义验证注解允许我们定义自己的验证逻辑，并将其应用于特定字段。

创建自定义验证注解

要创建自定义验证注解，需要：

创建一个 Java 类，继承 javax.validation.Constraint 注解。
定义一个 validateValue() 方法，接收一个 Object 参数并返回一个 boolean 值。
在 validateValue() 方法中编写验证逻辑。

示例：验证两个字段是否相等

@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FieldsEqualValidator.class)
public @interface FieldsEqual {

    String message() default "字段不相等";

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

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

    String field1();

    String field2();
}

public class FieldsEqualValidator implements ConstraintValidator<FieldsEqual, Object> {

    private String field1;
    private String field2;

    @Override
    public void initialize(FieldsEqual constraintAnnotation) {
        this.field1 = constraintAnnotation.field1();
        this.field2 = constraintAnnotation.field2();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        Object field1Value = BeanUtils.getProperty(value, field1);
        Object field2Value = BeanUtils.getProperty(value, field2);
        return Objects.equals(field1Value, field2Value);
    }
}

使用自定义验证注解

定义好自定义验证注解后，就可以在代码中使用它：

在需要验证的字段上添加自定义验证注解。
在控制器方法中，使用 @Validated 注解验证参数。

示例：验证用户注册信息

public class User {

    @FieldsEqual(field1 = "password", field2 = "confirmPassword")
    private String password;

    private String confirmPassword;

    // 其他字段...
}

@PostMapping("/register")
public String register(@Validated @RequestBody User user) {
    // 业务逻辑
    return "success";
}

使用 Spring 表达式进行复杂验证

自定义验证注解中可以使用 Spring 表达式来实现复杂的验证逻辑。Spring 表达式是一种强大的表达式语言，允许访问 Java 对象的属性和方法，并执行各种数学运算和逻辑判断。

使用 Spring 表达式，我们可以轻松实现：

验证两个字段是否相等。
验证一个字段是否在特定范围内。
验证一个字段是否符合特定正则表达式。
验证一个字段是否包含特定值。

示例：验证订单金额是否超过信用额度

@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = OrderAmountValidator.class)
public @interface OrderAmount {

    String message() default "订单金额超过信用额度";

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

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

    String creditLimit();
}

public class OrderAmountValidator implements ConstraintValidator<OrderAmount, Order> {

    private String creditLimit;

    @Override
    public void initialize(OrderAmount constraintAnnotation) {
        this.creditLimit = constraintAnnotation.creditLimit();
    }

    @Override
    public boolean isValid(Order order, ConstraintValidatorContext context) {
        BigDecimal totalAmount = order.getTotalAmount();
        BigDecimal creditLimitValue = (BigDecimal) SpELUtils.parseExpression(creditLimit).getValue();
        return totalAmount.compareTo(creditLimitValue) <= 0;
    }
}