Spring Validation实践及其实现原理

政采云技术2023-11-22 9:50

背景

Spring 框架，广泛应用于 JAVA 企业级开发中，包含了一套实用的字段校验机制： Spring Validation。这个机制融合了 JSR380 规范，即 Bean Validation 2.0。本文将介绍 Spring Validation 的使用方法，包括基础注解的应用以及进阶使用技巧。

常用注解

Bean Validation 2.0 注解

校验空值

  • @Null：验证对象是否为 null
  • @NotNull：验证对象是否不为 null
  • @NotEmpty：验证对象不为 null，且长度（数组、集合、字符串等）大于 0
  • @NotBlank：验证字符串不为 null，且去除两端空白字符后长度大于 0

校验大小

  • @Size(min=, max=)：验证对象（数组、集合、字符串等）长度是否在给定的范围之内
  • @Min(value)：验证数值（整数或浮点数）是否大于等于指定的最小值
  • @Max(value)：验证数值是否小于等于指定的最大值

校验布尔值

  • @AssertTrue：验证 Boolean 对象是否为 true
  • @AssertFalse：验证 Boolean 对象是否为 false

校验日期和时间

  • @Past：验证 Date 和 Calendar 对象是否在当前时间之前
  • @Future：验证 Date 和 Calendar 对象是否在当前时间之后
  • @PastOrPresent：验证日期是否是过去或现在的时间
  • @FutureOrPresent：验证日期是否是现在或将来的时间

正则表达式

  • @Pattern(regexp=, flags=)：验证 String 对象是否符合正则表达式的规则

Hibernate Validation 拓展

  • @Length(min=, max=)：验证字符串的大小是否在指定的范围内
  • @Range(min=, max=)：验证数值是否在合适的范围内
  • @UniqueElements：校验集合中的值是否唯一，依赖于 equals 方法
  • @ScriptAssert：利用脚本进行校验

@Valid 和 @Validated

这两个注解是校验的入口，作用相似但用法上存在差异。 @Validated

less 复制代码 
// 用于类/接口/枚举，方法以及参数
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})  
@Retention(RetentionPolicy.RUNTIME)
@Documented  
public @interface Validated {  
  // 校验时启动的分组  
  Class<?>[] value() default {};  
}

@Valid

less 复制代码 
// 用于方法，字段，构造函数，参数，以及泛型类型  
@Target({ METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USE })  
@Retention(RUNTIME)  
@Documented
public @interface Valid {  
  // 未提供其他属性  
}
  1. 作用范围不同 ：@Validated 无法作用在于字段， @Valid 无法作用于类；
  2. 注解中的属性不同 ：@Validated 中提供了指定校验分组的属性，而 @Valid 没有这个功能，因为 @Valid 不能进行分组校验。

字段校验场景及使用示例

常见的校验场景有三种： Controller 层的校验、编程式校验、 Dubbo 接口校验。

Controller层 的校验

使用方式

  1. 当方法入参为 @RequestBody 注解的 JavaBean，可在入参前使用 @Validated 或 @Valid 注解开启校验。
less 复制代码 
@PostMapping("/save")
public Response<Boolean> saveNotice(@Validated @RequestBody NoticeDTO noticeDTO) {
  // noticeDTO中各字段校验通过，才会执行后续业务逻辑
  return Response.ok(true);
}
  1. 当方法入参为 @PathVariable、 @RequestParam 注解的简单参数时，需要在 Controller 加上 @Validated 注解开启校验。
less 复制代码 
@RequestMapping("/notice")
@RestController
// 必须加上该注解
@Validated
public class UserController {
  // 路径变量
  @GetMapping("{id}")
  public Reponse<NoticeDTO> detail(@PathVariable("id") @Min(1L) Long noticeId) {
    // 参数noticeId校验通过，执行后续业务逻辑
    return Reponse.ok();
  }
​
  // 请求参数
  @GetMapping("getByTitle")
  public Result getByTitle(@RequestParam("title") @Length(min = 1, max = 20) String  title) {
    // 参数title校验通过，执行后续业务逻辑
    return Result.ok();
  }
}

原理

  1. Spring 框架中的 HandlerMethodArgumentResolver 策略接口，负责将方法参数解析为特定请求中的参数值。
less 复制代码 
public interface HandlerMethodArgumentResolver {  
  // 判断当前解析器是否支持给定的方法参数
  boolean supportsParameter(MethodParameter var1);  
​
  @Nullable  
  // 实际解析参数的方法
  Object resolveArgument(MethodParameter var1, @Nullable ModelAndViewContainer var2, NativeWebRequest var3, @Nullable WebDataBinderFactory var4) throws Exception;
}
  1. 上述接口针对 @RequestBody 的实现类 RequestResponseBodyMethodProcessor 中，存在字段校验逻辑，调用 validateIfApplicable 方法校验参数。
less 复制代码 
// RequestResponseBodyMethodProcessor
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {  
  // 前置处理
  // 校验逻辑
  if (binderFactory != null) {  
    WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);  
    if (arg != null) {
      //调用校验函数
      this.validateIfApplicable(binder, parameter);  
      if (binder.getBindingResult().hasErrors() && this.isBindExceptionRequired(binder, parameter)) {  
          throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());  
      }  
    }
    // 数据绑定逻辑
  }
  // 返回处理结果
  return this.adaptArgumentIfNecessary(arg, parameter);  
}
  1. validateIfApplicable 方法中，根据方法参数上的注解，决定是否进行字段校验：当存在 @Validated 或以 Valid 开头的注解时，进行校验。
ini 复制代码 
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
  // 获取参数上的注解
  Annotation[] annotations = parameter.getParameterAnnotations();  
  Annotation[] var4 = annotations;  
  int var5 = annotations.length;  
​
  // 遍历注解
  for(int var6 = 0; var6 < var5; ++var6) {  
    Annotation ann = var4[var6];  
    // 获取 @Validated 注解
    Validated validatedAnn = (Validated)AnnotationUtils.getAnnotation(ann, Validated.class); 
    // 或者注解以 Valid 开头 
    if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {
      // 开启校验
      Object hints = validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann);  
      Object[] validationHints = hints instanceof Object[] ? (Object[])((Object[])hints) : new Object[]{hints};  
      binder.validate(validationHints);  
      break;  
    }  
  }  
}
  1. @PathVariable 和 @RequestParam 对应的实现类中，则没有相应字段校验逻辑，因此需要在 Controller 上使用 @Validated，开启字段校验。

编程式校验

  1. 配置 Validator
kotlin 复制代码 
@Configuration  
public class ValidatorConfiguration {  
  @Bean  
  public Validator validator() {  
    ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)  
            .configure()  
            // 设置是否开启快速失败模式  
            //.failFast(true)  
            .buildValidatorFactory();  
    return validatorFactory.getValidator();  
  }  
}
  1. 获取 validator 并校验
typescript 复制代码 
public class TestValidator {
  // 注入验证器
  @Resource
  private javax.validation.Validator validator;

  public String testMethod(TestRequest request) {
    // 进行校验，获取校验结果
    Set<ConstraintViolation<TestRequest>> constraintViolations = validator.validate(request);
    // 组装校验信息并返回
    return res;
  }
}

Dubbo 接口校验

  1. 可在 @DubboService 注解中，设置 validation 参数为 true，开启生产者的字段验证。
kotlin 复制代码 
@DubboService(version = "1.0.0", validation="true")
public class DubboApiImpl implements DubboApi {
  ....
}
  1. 该方式返回的信息对使用者不友好，可通过 Dubbo 的 filter 自定义校验逻辑和返回信息。需要注意的是，在 Dubbo 中有自己的 IOC 实现来控制容器，因此需提供 setter 方法，供 Dubbo 调用。
kotlin 复制代码 
@Activate(  
        group = {"provider"},  
        value = {"customValidationFilter"},  
        order = 10000  
)  
@Slf4j  
public class CustomValidationFilter implements Filter {  
  
  private javax.validation.Validator validator;  

  // duubo会调用setter获取bean
  public void setValidator(javax.validation.Validator validator) {  
    this.validator = validator;  
  } 

  public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {  
    if (this.validator != null && !invocation.getMethodName().startsWith("$")) {  
      // 补充字段校验，返回信息的组装以及异常处理
    }  
    return invoker.invoke(invocation);  
  }  
}

进阶使用

分组校验

对于同一个 DTO， 不同场景下对其校验规则可能不同， @Validted 支持按照分组分别验证，示例代码如下：

  1. 校验注解的 groups 属性中添加分组
less 复制代码 
@Data
public class NoticeDTO {

  @Min(value = 0L, groups = Update.class)
  private Long id;

  @NotNull(groups = {Save.class, Update.class})
  @Length(min = 2, max = 10, groups = {Save.class, Update.class})
  private String title;

  // 保存的时候校验分组
  public interface Save {
  }

  // 更新的时候校验分组
  public interface Update {
  }
}
  1. @Validted 上指定分组
less 复制代码 
@PostMapping("/save")
public Response<Boolean> saveNotice(@RequestBody @Validated(NoticeDTO.Save.class) NoticeDTO noticeDTO) {
  // 分组为Save.class的校验通过，执行后续逻辑
  return Response.ok();
}

@PostMapping("/update")
public Response<Boolean> updateNotice(@RequestBody @Validated(NoticeDTO.Update.class) NoticeDTO noticeDTO) {
  // 分组为Update.class的校验通过，执行后续逻辑
  return Response.ok();
}

自定义校验注解

如果我们想自定义实现一些验证逻辑，可以使用自定义注解，主要包括两部分：实现自定义注解，实现对应的校验器 validator。下面尝试实现一个注解，用于校验集合中的指定属性是否存在重复，代码如下：

  1. 实现校验注解，主要需要包含 message()、 filed()、 groups() 三个方法，功能如注释所示。
less 复制代码 
@Target({ElementType.FIELD, ElementType.PARAMETER})  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
// 指定校验器
@Constraint(validatedBy = UniqueValidator.class)  
public @interface Unique {  

  // 用于自定义验证信息
  String message() default "字段存在重复";  

  // 指定集合中的待校验字段
  String[] field();  

  // 指定分组
  Class<?>[] groups() default {};  
}
  1. 实现对应的校验器，主要校验逻辑在 isValid 方法：获取集合中指定字段，并组装为 set，比较 set 和集合的长度，以判断集合中指定字段是否存在重复。
kotlin 复制代码 
// 实现ConstraintValidator<T, R>接口，T为注解的类型，R为注解的字段类型
public class UniqueValidator implements ConstraintValidator<Unique, Collection<?>> {  
  
  private Unique unique;  

  @Override  
  public void initialize(Unique constraintAnnotation) {  
      this.unique = constraintAnnotation;  
  }  

  @Override  
  public boolean isValid(Collection collection, ConstraintValidatorContext constraintValidatorContext) {
    // 集合为空直接校验通过
    if (collection == null || collection.size() == 0) {  
        return Boolean.TRUE;  
    }  
    // 从集合中获取filed中指定的待校验字段，看是否存在重复
    return Arrays.stream(unique.field())  
          .filter(fieldName -> fieldName != null && !"".equals(fieldName.trim()))  
          .allMatch(fieldName -> {
            // 收集集合collection中字段为fieldName的值，存入set并计算set的元素个数count
            int count = (int) collection.stream()  
                  .filter(Objects::nonNull)  
                  .map(item -> {  
                      Class<?> clazz = item.getClass();  
                      Field field;  
                      try {  
                          field = clazz.getField(fieldName);  
                          field.setAccessible(true);  
                          return field.get(item);  
                      } catch (Exception e) {  
                          return null;  
                      }  
                  })  
                  .collect(Collectors.collectingAndThen(Collectors.toSet(), Set::size)); 
            // set中元素个数count与集合长度比较，若不相等则说明collection中字段存在重复，校验不通过
            if (count != collection.size()) {  
              return false;  
            }  
            return true;  
          });  
  }  
}

总结

通过本文我们得以了解 Spring Validation 的机理及其在实际项目中的应用。无论是标准的校验注解，还是自定义的校验逻辑， Spring Validation 都为开发者提供了高效且强大的校验工具。总的来说， Spring Validation 是任何 Spring 应用不可或缺的一部分，对于追求高质量代码的 JAVA 开发者而言，掌握其用法和最佳实践至关重要。

参考文献

推荐阅读

ThreadPoolExecutor杂谈

浅谈软件架构

你是否真的需要实现一个3D地图

深入分析 RocketMQ 的 push 消费方式实现

浅谈MySQL分页查询的工作原理

招贤纳士

政采云技术团队（Zero），Base 杭州，一个富有激情和技术匠心精神的成长型团队。规模 500 人左右，在日常业务开发之外，还分别在云原生、区块链、人工智能、低代码平台、中间件、大数据、物料体系、工程平台、性能体验、可视化等领域进行技术探索和实践，推动并落地了一系列的内部技术产品，持续探索技术的新边界。此外，团队还纷纷投身社区建设，目前已经是 google flutter、scikit-learn、Apache Dubbo、Apache Rocketmq、Apache Pulsar、CNCF Dapr、Apache DolphinScheduler、alibaba Seata 等众多优秀开源社区的贡献者。

如果你想改变一直被事折腾，希望开始折腾事；如果你想改变一直被告诫需要多些想法，却无从破局；如果你想改变你有能力去做成那个结果，却不需要你；如果你想改变你想做成的事需要一个团队去支撑，但没你带人的位置；如果你想改变本来悟性不错，但总是有那一层窗户纸的模糊......如果你相信相信的力量，相信平凡人能成就非凡事，相信能遇到更好的自己。如果你希望参与到随着业务腾飞的过程，亲手推动一个有着深入的业务理解、完善的技术体系、技术创造价值、影响力外溢的技术团队的成长过程，我觉得我们该聊聊。任何时间，等着你写点什么，发给 [email protected]

微信公众号

文章同步发布，政采云技术团队公众号，欢迎关注

相关推荐
豌豆花下猫35 分钟前
Python 潮流周刊#102：微软裁员 Faster CPython 团队（摘要）
后端·python·ai
秋野酱43 分钟前
基于javaweb的SpringBoot驾校预约学习系统设计与实现(源码+文档+部署讲解）
spring boot·后端·学习
北辰浮光1 小时前
[springboot]SSM日期数据转换易见问题
java·spring boot·后端
木梓辛铭1 小时前
Spring Cache的详细使用
java·后端·spring
bing_1582 小时前
Spring MVC 拦截器 (HandlerInterceptor) 是什么？ 它与 Servlet Filter 有什么区别？
spring·servlet·mvc
薯条不要番茄酱3 小时前
【SpringBoot】从零开始全面解析SpringMVC (二)
java·spring boot·后端
小林学习编程3 小时前
Springboot考研信息平台
spring boot·后端·考研
长勺4 小时前
Spring Security vs Shiro vs Sa-Token
java·后端·spring
yezipi耶不耶4 小时前
Rust入门之高级Trait
开发语言·后端·rust
qq_12498707534 小时前
原生小程序+springboot+vue+协同过滤算法的音乐推荐系统（源码+论文+讲解+安装+部署+调试）
java·spring boot·后端·小程序·毕业设计·课程设计·协同过滤
热门推荐
01YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】02KGG转MP3工具|非KGM文件|解密音频03从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑04【SpeedAI科研小助手】2分钟极速解决知网维普重复率、AIGC率过高，一键全文降！文件格式不变，公式都保留的！05DeepSeek各版本说明与优缺点分析06Coze扣子平台完整体验和实践（附国内和国际版对比）07深度学习基础--ResNet网络的讲解，ResNet50的复现(pytorch)以及用复现的ResNet50做鸟类图像分类08苍穹外卖面试总结09yolov8，yolo11，yolo12 服务器训练到部署全流程 笔记10【解决】Android Gradle Sync 报错 Could not read workspace metadata