自定义Spring Boot验证器：为你的代码增加更优雅的验证

开发工具

2023-09-25 10:50:11

用自定义验证器打造更可靠的应用程序

作为开发者，确保我们应用程序中数据的准确性和完整性至关重要。Spring Boot 的内置验证功能虽然强大，但有时我们还需要更细致的验证，以满足特定的需求。创建自定义验证器可以帮我们轻松实现这一点。

数据完整性的关键

数据是应用程序的心脏，数据完整性是保证其准确性和可靠性的基石。当数据完整性受到威胁时，应用程序就会出现错误，最终影响用户体验。

Spring Boot 的内置验证

Spring Boot 提供了丰富的开箱即用验证注解，可以轻松地对数据进行验证。这些注解包括 @NotNull、@NotBlank、@Size、@Pattern 等。

自定义验证器的优势

然而，在某些情况下，Spring Boot 内置的验证注解可能不够用。此时，我们可以创建自定义验证器，以满足特定的验证需求。自定义验证器可以让我们对数据进行更细粒度的验证，从而确保数据的准确性。

如何创建自定义验证器

创建自定义验证器非常简单，只需以下几个步骤：

创建一个新的 Java 类并继承 javax.validation.ConstraintValidator 接口。
重写 isValid() 方法，并在其中编写验证逻辑。
使用 @Constraint() 注解声明自定义验证器。
将自定义验证器添加到要验证的实体类中。

以下是一个创建自定义验证器的示例：

import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

@Constraint(validatedBy = EmailValidator.class)
public @interface Email {
    String message() default "Invalid email address";
    Class<?>[] groups() default {};
    Class<?>[] payload() default {};
}

public class EmailValidator implements ConstraintValidator<Email, String> {
    @Override
    public boolean isValid(String email, ConstraintValidatorContext context) {
        if (email == null || email.isEmpty()) {
            return true;
        }

        String regex = "^[a-zA-Z0-9_+&*-]+(?:\\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,7}import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

@Constraint(validatedBy = EmailValidator.class)
public @interface Email {
    String message() default "Invalid email address";
    Class<?>[] groups() default {};
    Class<?>[] payload() default {};
}

public class EmailValidator implements ConstraintValidator<Email, String> {
    @Override
    public boolean isValid(String email, ConstraintValidatorContext context) {
        if (email == null || email.isEmpty()) {
            return true;
        }

        String regex = "^[a-zA-Z0-9_+&*-]+(?:\\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,7}$";
        return email.matches(regex);
    }
}
quot;;
        return email.matches(regex);
    }
}