如何组合验证两个或多个字段?

问题描述 投票:62回答:3

我正在使用JPA 2.0 / Hibernate验证来验证我的模型。我现在有一种情况,必须验证两个字段的组合:

public class MyModel {
    public Integer getValue1() {
        //...
    }
    public String getValue2() {
        //...
    }
}

如果getValue1()getValue2()都是null,则模型无效,否则无效。

如何使用JPA 2.0 / Hibernate执行此类验证?使用简单的@NotNull注释,两个getter都必须为非null才能通过验证。

java jpa jpa-2.0 bean-validation
3个回答
83
投票

对于多个属性验证,您应该使用类级别约束。来自Bean Validation Sneak Peek part II: custom constraints

Class-level constraints

你们中的一些人表示担心能够应用跨越多个属性的约束,或表达依赖于几个属性的约束。经典的例子是地址验证。地址有复杂的规则:

  • 街道名称有点标准,必须有一个长度限制
  • 邮政编码结构完全取决于国家
  • 城市通常可以与邮政编码相关联,并且可以进行一些错误检查(前提是可以访问验证服务)
  • 由于这些相互依赖性,一个简单的属性级别约束确实适合该法案

Bean Validation规范提供的解决方案有两个方面:

  • 它提供了通过使用组和组序列强制在一组其他约束之前应用一组约束的能力。这个主题将在下一篇博客文章中介绍
  • 它允许定义类级别约束

类级别约束是常规约束(注释/实现二重奏),它适用于类而不是属性。换句话说,类级约束在isValid中接收对象实例(而不是属性值)。

@AddressAnnotation 
public class Address {
    @NotNull @Max(50) private String street1;
    @Max(50) private String street2;
    @Max(10) @NotNull private String zipCode;
    @Max(20) @NotNull String city;
    @NotNull private Country country;

    ...
}

@Constraint(validatedBy = MultiCountryAddressValidator.class)
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface AddressAnnotation {
    String message() default "{error.address}";
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
}

public class MultiCountryAddressValidator implements ConstraintValidator<AddressAnnotation, Address> {
    public void initialize(AddressAnnotation constraintAnnotation) {
    // initialize the zipcode/city/country correlation service
    }

    /**
     * Validate zipcode and city depending on the country
     */
    public boolean isValid(Address object, ConstraintValidatorContext context) {
        if (!(object instanceof Address)) {
            throw new IllegalArgumentException("@Address only applies to Address");
        }
        Address address = (Address) object;
        Country country = address.getCountry();
        if (country.getISO2() == "FR") {
            // check address.getZipCode() structure for France (5 numbers)
            // check zipcode and city correlation (calling an external service?)
            return isValid;
        } else if (country.getISO2() == "GR") {
            // check address.getZipCode() structure for Greece
            // no zipcode / city correlation available at the moment
            return isValid;
        }
        // ...
    }
}

高级地址验证规则已被遗漏在地址对象之外,并由MultiCountryAddressValidator实现。通过访问对象实例,类级别约束具有很大的灵活性,可以验证多个相关属性。请注意,这里的排序不在等式中,我们将在下一篇文章中回到它。

专家组讨论了各种多属性支持方法:与其他涉及依赖关系的属性级方法相比,我们认为类级别约束方法提供了足够的简单性和灵活性。欢迎您的反馈。


25
投票

为了与Bean Validation正常工作,Pascal Thivent的answer中提供的示例可以重写如下:

@ValidAddress
public class Address {

    @NotNull
    @Size(max = 50)
    private String street1;

    @Size(max = 50)
    private String street2;

    @NotNull
    @Size(max = 10)
    private String zipCode;

    @NotNull
    @Size(max = 20)
    private String city;

    @Valid
    @NotNull
    private Country country;

    // Getters and setters
}
public class Country {

    @NotNull
    @Size(min = 2, max = 2)
    private String iso2;

    // Getters and setters
}
@Documented
@Target(TYPE)
@Retention(RUNTIME)
@Constraint(validatedBy = { MultiCountryAddressValidator.class })
public @interface ValidAddress {

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

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

    Class<? extends Payload>[] payload() default {};
}
public class MultiCountryAddressValidator 
       implements ConstraintValidator<ValidAddress, Address> {

    public void initialize(ValidAddress constraintAnnotation) {

    }

    @Override
    public boolean isValid(Address address, 
                           ConstraintValidatorContext constraintValidatorContext) {

        Country country = address.getCountry();
        if (country == null || country.getIso2() == null || address.getZipCode() == null) {
            return true;
        }

        switch (country.getIso2()) {
            case "FR":
                return // Check if address.getZipCode() is valid for France
            case "GR":
                return // Check if address.getZipCode() is valid for Greece
            default:
                return true;
        }
    }
}

8
投票

当您想要继续使用Bean Validation规范时,可以使用自定义类级别验证器,例如here

如果您乐意使用Hibernate Validator功能,可以使用自Validator-4.1.0.Final以来提供的@ScriptAssert。从JavaDoc中除外:

脚本表达式可以用任何脚本或表达式语言编写,为此可以在类路径上找到JSR 223(“JavaTM平台的脚本”)兼容引擎。

例:

@ScriptAssert(lang = "javascript", script = "_this.value1 != null || _this != value2)")
public class MyBean {
  private String value1;
  private String value2;
}
© www.soinside.com 2019 - 2024. All rights reserved.