Spring Validation 的进阶使用( 根据条件动态添加是否需要 verify 某个字段 )

Spring Validation 介绍

是Spring框架提供的一种验证机制，用于对数据进行验证和校验。通过Spring Validation，我们可以轻松地对用户输入的数据进行验证，确保数据的合法性。

Spring Validation的核心是约束注解和验证器接口。约束注解用于在数据模型中定义验证规则，而验证器接口用于实现验证规则的具体逻辑。

在使用Spring Validation时，我们需要定义一个包含验证规则的数据模型，并为其添加约束注解。然后，通过编写验证器实现验证规则的具体逻辑，并将其注册到Spring的验证器链中。

Spring Validation使用的是Java标准的注解验证机制，如@NotNull、@NotEmpty、@Size等，同时也支持自定义注解。

使用Spring Validation的好处包括：

• 增强数据的准确性和完整性，避免无效数据的进入系统。
• 降低了代码的冗余性，使得验证逻辑更加清晰和易于维护。
• 提供了统一的验证机制，使得验证逻辑可以在不同层次的应用中共享和复用。

总之，Spring Validation是Spring框架提供的一种强大的验证机制，可以有效地对数据进行验证和校验，提高系统的稳定性和安全性。

相信会找到这篇文章的你们应该对 Spring Validation 的使用也相当熟练了，我这里就不一一介绍了。
🙏 感谢文章: https://juejin.cn/post/6844903920699965447

需求

我有一个 POST 请求的请求体：

@Data
public class SubmitReq {

  @NotEmpty(message = "需要上传的月份信息不能为空")
  private List<String> months;

  @NotNull(message = "提交的数据类型不能为空")
  private Integer submitType;
 
  @NotBlank(message = "病种 CODE 不能为空")
  private String diseaseCode;
  
  private String skillCode;

  @Min(value = 1, message = "上传数据的最大限制不能小于 1")
  @NotNull(message = "上传数据最大限制不能为空")
  private Integer uploadLimitSize;
}

其实我的 skillCode 也需要做非空的校验的，但是它是否需要校验需要依赖于 submitType 的值，如果我的 submitType 的值为 1 那么我的 skillCode 就不能为空。

当然我们可以像下面这样实现我们的功能：

public ResponseEntity<Void> submitData(
      @RequestBody @Validated SubmitReq submitReq,
      @RequestHeader("Authorization") String userId) {
    if (submitReq.getSubmitType().equals(DataUploadType.SKILL.ordinal()) && StrUtil.isEmpty(
        submitReq.getSkillCode())) {
      return ResponseEntity.badRequest().build();
    }
    dataUploader.startUploadData(userId, submitReq);
    return ResponseEntity.ok().build();
  }

但是这样做不够优雅，不是吗 🤒

下面是解决方案，简单的原理呢我放在了最后：

@Data
// 1. 加上分组校验的提供者
@GroupSequenceProvider(SubmitReqGroupSequenceProvider.class)
public class SubmitReq {

  @NotEmpty(message = "需要上传的月份信息不能为空")
  private List<String> months;

  @NotNull(message = "提交的数据类型不能为空")
  @EnumValue(value = DataUploadType.class, message = "提交的数据类型的值不合法")
  private Integer submitType;
 
  @NotBlank(message = "病种 CODE 不能为空")
  private String diseaseCode;

  // 2. 加上 validate 的注解，并且配置它代表某个校验组
  @NotBlank(groups = { SkillSubmitGroup.class })
  private String skillCode;

  @Min(value = 1, message = "上传数据的最大限制不能小于 1")
  @NotNull(message = "上传数据最大限制不能为空")
  private Integer uploadLimitSize;
	
  // 3. 添加一个分组规则(一个空的接口)
  public interface SkillSubmitGroup {}
}

import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;

public class SubmitReqGroupSequenceProvider implements DefaultGroupSequenceProvider<SubmitReq> {

  @Override
  public List<Class<?>> getValidationGroups(final SubmitReq submitReq) {
    final List<Class<?>> defaultGroupSequence = new ArrayList<>();
    // every bean validate should have a default self group
    // 注意这个一定要加，不然连默认的规则都没了会失败的
    defaultGroupSequence.add(SubmitReq.class);

    // 这里避免一些空指针
    if (Objects.nonNull(submitReq)) {
      // 在这里添加一些我们自己的动态规则
      final Integer submitType = submitReq.getSubmitType();
      if (submitType.equals(1)) {
        defaultGroupSequence.add(SubmitReq.SkillSubmitGroup.class);
      }
    }

    return defaultGroupSequence;
  }
}

然后这样就好啦，当你的 submitType 是 1 的时候，会给他加上SkillSubmitGroup 分组校验的规则，校验就生效啦，当为 0 的时候就只有默认的分组校验规则，默认就是不校验。

简单阐述一下原理

其实就还是利用了 Spring Validation 的分组原理，只不过我们的 SubmitReqGroupSequenceProvider 会动态的根据我们自己的业务来动态编排好我此次的校验规则，然后就是跟平常我们的写死的那种分组操作一样了，这样就更加灵活。