在Spring Boot应用中，我们经常需要对输入的数据进行验证，以确保它们满足特定的业务规则。Spring框架提供了JSR 303/JSR 349标准的Bean Validation功能，允许开发者自定义数据校验规则。本篇将详细介绍如何在Spring Boot中实现自定义校验，以`StartWithValidation`为例。
自定义校验注解`StartWithValidation`是整个过程的核心。这个注解使用了`@Constraint`，表明它是一个约束注解，并且通过`validatedBy`属性指定了验证器`StartWithValidator`。`@Target`和`@Retention`分别定义了注解的应用目标（如方法、字段等）和保留策略（运行时）。此外，注解还包含了一些基本的参数，如错误消息、起始字符串、验证组和负载。
```java
@Documented
@Constraint(validatedBy = StartWithValidator.class)
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface StartWithValidation {
String message() default "不是正确的性别取值范围";
String start() default "_";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
// 定义嵌套注解，允许多个StartWithValidation的使用
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@interface List {
StartWithValidation[] value();
}
}
```
接下来是验证器`StartWithValidator`，实现了`ConstraintValidator`接口，针对`StartWithValidation`注解。在这个类中，`initialize`方法用于初始化验证器，接收注解实例并获取起始字符串。`isValid`方法是实际的验证逻辑，检查字段值是否以指定的起始字符串开始。如果不符合条件，返回`false`，否则返回`true`。
```java
public class StartWithValidator implements ConstraintValidator<StartWithValidation, String> {
private String start;
@Override
public void initialize(StartWithValidation constraintAnnotation) {
start = constraintAnnotation.start();
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if (!StringUtils.isEmpty(value)) {
return value.startsWith(start);
}
return true;
}
}
```
在实际使用时，我们可以将`StartWithValidation`注解应用到字段上，例如：
```java
@StartWithValidation(message = "Param 'address' must be start with 'Beijing'.", start = "Beijing")
public String address;
```
这样，当尝试设置或修改`address`字段的值时，Spring会自动调用`StartWithValidator`进行验证。如果`address`不以"Beijing"开头，校验会失败，并抛出一个`ConstraintViolationException`，提示用户输入的地址不符合要求。
总结一下，Spring Boot中的自定义校验机制允许开发者灵活地定义自己的数据验证规则。通过创建自定义的校验注解和验证器，可以更好地适应各种业务场景，提升代码的可读性和维护性。在上述示例中，我们创建了一个检查字符串是否以特定字符开始的校验规则，这只是一个基础示例，实际上可以扩展到更复杂的校验逻辑，如日期格式、数字范围等。了解并掌握自定义校验对于提高Spring Boot应用的质量和安全性至关重要。
