SpringBoot Validation参数校验 详解自定义注解规则和分组校验

Posted 2023-03-14

参考技术A Hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint
在日常开发中，Hibernate Validator经常用来验证bean的字段，基于注解，方便快捷高效。

在SpringBoot中可以使用@Validated，注解Hibernate Validator加强版，也可以使用@Valid原来Bean Validation java版本

Bean Validation 中内置的 constraint

<colgroup style="box-sizing: border-box;"><col style="box-sizing: border-box;"><col style="box-sizing: border-box;"></colgroup>

Hibernate Validator 附加的 constraint

message支持表达式和EL表达式 ，比如message = "姓名长度限制为min到max $1+2")

想把错误描述统一写到properties的话，在classpath下面新建
ValidationMessages_zh_CN.properties文件(注意value需要转换为unicode编码)，然后用格式的占位符

hibernate补充的注解中，最后3个不常用，可忽略。
主要区分下@NotNull @NotEmpty @NotBlank 3个注解的区别：

如果同一个参数，需要在不同场景下应用不同的校验规则，就需要用到分组校验了。比如：新注册用户还没起名字，我们允许name字段为空，但是在更新时候不允许将名字更新为空字符。

分组校验有三个步骤：

自定义的Update分组接口继承了Default接口。校验注解(如： @NotBlank)和@validated默认其他注解都属于Default.class分组，这一点在
javax.validation.groups.Default注释中有说明

在编写Update分组接口时，如果继承了Default，下面两个写法就是等效的：
@Validated(Update.class),@Validated(Update.class,Default.class)
如果Update不继承Default，@Validated(Update.class)就只会校验属于Update.class分组的参数字段

如果 UserVO 类中增加一个 OrderVO 类的属性，而 OrderVO 中的属性也需要校验，就用到递归校验了，只要在相应属性上增加@Valid注解即可实现（对于集合同样适用）

validation 为我们提供了这么多特性，几乎可以满足日常开发中绝大多数参数校验场景了。但是，一个好的框架一定是方便扩展的。有了扩展能力，就能应对更多复杂的业务场景，毕竟在开发过程中，唯一不变的就是变化本身。 Validation允许用户自定义校验

实现很简单，分两步：

注意:message用于显示错误信息这个字段是必须的，groups和payload也是必须的
@Constraint(validatedBy =
HandsomeBoyValidator.class)用来指定处理这个注解逻辑的类

注意这里验证逻辑我抽出来单独写了一个工具类，ValidatorUtil

我自定义了补充了很多验证器，包括日期验证，枚举验证，手机号验证，金额验证

自定义校验注解使用起来和内置注解无异，在需要的字段上添加相应注解即可

使用 Validation API 进行参数效验步骤整个过程如下图所示，用户访问接口，然后进行参数效验 ，如果效验通过，则进入业务逻辑，否则抛出异常，交由全局异常处理器进行处理

全局异常出来请参考我这篇文章SpringBoot优雅的全局异常处理