自定义实现 Java Bean 属性中列表元素格式校验注解及其实现

引言

在 Java 开发中，验证对象属性的有效性是一个常见的需求。Hibernate Validator 作为 Java Bean Validation 的标准实现，为我们提供了丰富的内置注解来处理各类校验。然而，当遇到更复杂或特定的需求，如需要校验集合类属性中每一个元素的格式时，我们可以通过自定义注解和校验器来实现。

以下是如何自定义一个用于校验列表中元素是否符合 "yyyyMMdd" 格式的日期注解及其实现。

1、自定义校验器

public class DateListValidator implements ConstraintValidator<ValidDateList, List<Integer>> {

    @Override
    public void initialize(ValidDateList constraintAnnotation) {
        // 初始化方法，此处无需额外处理
    }

    @Override
    public boolean isValid(List<Integer> dates, ConstraintValidatorContext constraintValidatorContext) {
        if (dates == null || dates.isEmpty()) {
            // 如果列表为空或null，允许其通过校验
            return true;
        }

        // 遍历列表，对每个元素进行日期格式校验
        for (Integer date : dates) {
            if (!isValidDate(date)) {
                return false;
            }
        }

        // 若所有元素均符合日期格式要求，则返回true，表示校验成功
        return true;
    }

    // 辅助方法，校验单个整数是否符合"yyyyMMdd"格式
    private boolean isValidDate(Integer date) {
        if (date == null) {
            return false;
        }
        String dateString = String.valueOf(date);
        // 使用正则表达式匹配 "yyyyMMdd" 格式
        return dateString.matches("\\d{8}");
    }
}

2、自定义注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = DateListValidator.class)
public @interface ValidDateList {

    // 提供默认错误提示信息
    String message() default "日期格式错误";

    // 可选的分组校验，留空表示不指定
    Class<?>[] groups() default {};

    // 可选的payload元数据，一般用于携带额外信息，此处留空表示不携带
    Class<? extends Payload>[] payload() default {};
}

3、使用示例

下面是在请求 DTO 中应用自定义注解 @ValidDateList 的示例：

@Data
@EqualsAndHashCode(callSuper = true)
public class AlarmInfosReqDTO extends BasePageDTO {

    // 其他属性...

    /**
     * 查询日期列表（格式：yyyyMMdd）
     */
    @ValidDateList(message = "dates列表元素格式错误！")
    private List<Integer> dates;
}

总结：

• 通过以上步骤，我们成功创建了一个自定义注解 @ValidDateList 及其对应的校验器 DateListValidator，该注解能够应用于任何类的 List<Integer> 类型字段，用于校验列表中的每个元素是否符合 "yyyyMMdd" 格式的日期要求。
• 在实际业务处理过程中，当接收到包含此注解的 DTO 对象时，Spring MVC 或其他支持 Bean Validation 的框架会自动调用校验器进行校验，确保数据的一致性和有效性。