Spring Boot 参数校验机制原理以及如何实现一个自定义校验注解

Spring Boot 参数校验原理

Spring Boot 提供了一种方便的参数校验机制，借助于 JSR-303（Bean Validation）规范，通过在方法参数上添加校验注解来实现参数校验。下面是 Spring Boot 参数校验的基本原理：

1. JSR-303 标准注解: Spring Boot 使用了 JSR-303 提供的一系列标准注解来进行参数校验，如 @NotNull、@Size、@Min、@Max、@Email 等。

2. Hibernate Validator: Spring Boot 默认使用 Hibernate Validator 作为其 Bean Validation 实现。Hibernate Validator 是对 Bean Validation 规范的一个实现，它支持 JSR-303 定义的所有校验注解，并且提供了一些扩展注解。

3. 方法参数上的校验注解: 在 Spring Boot 的控制器方法中，可以在方法参数上添加校验注解，如 @Valid、@NotNull、@Size 等。当请求到达控制器方法时，Spring Boot 会根据这些注解自动对参数进行校验。

4. 参数校验的触发时机: 参数校验是在 Spring MVC 的请求处理流程中触发的，在参数绑定到控制器方法的过程中进行校验。当请求到达控制器方法时，Spring Boot 会自动根据方法参数上的校验注解执行校验逻辑。

5. 校验结果处理: 如果参数校验失败，Spring Boot 会抛出 MethodArgumentNotValidException 异常，并返回相应的错误信息给客户端。开发者可以通过异常处理器或者全局异常处理机制来自定义校验失败时的处理逻辑。

6. 全局校验器配置: Spring Boot 允许开发者通过配置 Validator 或者 LocalValidatorFactoryBean 来自定义全局的校验器，从而实现一些更加复杂的校验逻辑或者自定义的校验器。

总的来说，Spring Boot 的参数校验机制基于 JSR-303 标准注解和 Hibernate Validator 实现，通过在方法参数上添加校验注解来实现对参数的校验，从而保证了系统接口的数据完整性和安全性。

如何实现自定义校验注解

要创建一个自定义的校验注解，你需要遵循以下步骤：

1. 创建注解类：首先，创建一个注解类，用于定义你的自定义校验注解的名称和属性。

2. 编写校验逻辑：编写一个校验器，用于实际执行校验逻辑。

3. 关联注解和校验器：将自定义的注解与校验器关联起来，以便在使用注解时触发校验器。

下面是一个简单的示例，演示如何创建一个自定义的校验注解来验证 JSON 字符串：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = JsonStringValidator.class) // 指定校验器
public @interface ValidJsonString {
    String message() default "Invalid JSON String"; // 默认错误信息

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

    Class<? extends Payload>[] payload() default {};
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

在上面的示例中，@ValidJsonString 是自定义的校验注解，它关联了一个校验器 JsonStringValidator。

接下来，我们需要编写校验器 JsonStringValidator：

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

public class JsonStringValidator implements ConstraintValidator<ValidJsonString, String> {

    @Override
    public void initialize(ValidJsonString constraintAnnotation) {
        // 初始化方法
    }

    @Override
    public boolean isValid(String jsonString, ConstraintValidatorContext context) {
        if (jsonString == null) {
            return false;
        }
        try {
            // 在这里编写你的校验逻辑，例如使用 JSON 解析器来解析 JSON 字符串，判断是否合法
            // 这里只是一个简单示例，你可以根据实际需求进行更复杂的校验逻辑
            // 这里简单地检查字符串是否可以被 JSON 解析器成功解析
            ObjectMapper objectMapper = new ObjectMapper();
            objectMapper.readTree(jsonString);
            return true;
        } catch (IOException e) {
            return false;
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

在上面的示例中，JsonStringValidator 类实现了 ConstraintValidator<ValidJsonString, String> 接口，并重写了 isValid 方法，在该方法中执行了 JSON 字符串的校验逻辑。

现在，你就可以在你的 Java Bean 中使用 @ValidJsonString 注解来校验 JSON 字符串了：

public class MyBean {
    @ValidJsonString
    private String jsonString;

    // 其他代码
}
1
2
3
4
5
6

当你在 Spring Boot 控制器或者服务中使用这个 Bean 时，Spring Boot 会自动执行 @ValidJsonString 注解定义的校验逻辑。