Bean验证-验证可选字段

时间:2019-09-18 08:21:30

标签: spring spring-boot bean-validation

给出一个表示从表单提交的有效负载的类,我想将bean验证应用于可能存在或可能不存在的字段,例如:

class FormData {
    @Pattern(...)
    @Size(...)
    @Whatever(...)
    private String optionalField;

    ...
} 

如果未在有效负载中发送optionalField,则我不想应用上面的任何验证器,但是如果发送了验证器,则我想应用所有验证器。怎么办?

谢谢。

1 个答案:

答案 0 :(得分:0)

因此,通常所有这些约束都将null值视为有效。如果您的可选字段是null,但它不是有效负载的一部分,则所有文件都应该可以正常工作。

对于任何必填字段,您都可以在其上放置@NotNull

编辑 这是一个例子:

class FormData {
    @Pattern(regexp = "\\d+")
    @Size(min = 3, max = 3)
    private final String optionalField;

    @Pattern(regexp = "[a-z]+")
    @Size(min = 3, max = 3)
    @NotNull
    private final String mandatoryField;
}

@Test
public void test() {
    Validator validator = getValidator();

    // optonal field is null so no violations will rise on it
    FormData data = new FormData( null, "abc" );
    Set<ConstraintViolation<FormData>> violations = validator.validate( data );
    assertThat( violations ).isEmpty();

    // optional field is present but it should fail the pattern validation:
    data = new FormData( "aaa", "abc" );
    violations = validator.validate( data );
    assertThat( violations ).containsOnlyViolations(
            violationOf( Pattern.class ).withProperty( "optionalField" )
    );
}

您可以看到,在第一种情况下您没有收到任何违规信息,因为可选字段为null。但是在第二个示例中,您收到违反模式约束的信息,因为aaa不是数字字符串。