Spring项目中对象参数校验方法及常用注解总结

1、Validator基本用法

给需要校验的对象属性添加校验对应的属性注解@

public class Model {
    
   @NotBlank(message = "名称不能为空")
   @Length(max = 20,message = "名称长度不能超过20个字")
   private String name;

   @NotNull(message = "模型类型不能为空")
   private Integer type;
}

接口参数对象添加 @Valid注解，启用校验功能（否则校验失效）

public R<Boolean> saveModel(@Valid @RequestBody Model model){
   return R.ok(modelService.saveModel(model));
}

2、Spring Validator与SpringBoot Validator 区别

两者其实提供的注解功能基本是相同的，只是依赖不一样，可以根据使用场景可以自己选择。

Spring Validator基于validation-api和hibernate-validator两个依赖的常用注解配置

//基于validation-api
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.0.Final</version>
</dependency>
//hibernate-validator
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.4.1.Final</version>
</dependency>

SpringBoot Validator 基于封装好的spring-boot-starter-validation依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

查看源码可以知道SpringBoot Validator依赖不同于spring validator，但是提供的注解功能一致。
spring-boot-starter-validation依赖hibernate-validator

<dependency>
  <groupId>org.hibernate.validator</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>6.2.0.Final</version>
  <scope>compile</scope>
</dependency>

hibernate-validator依赖 jakarta.validation-api

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
</dependency>

3、Bean Validation与Hibernate Validation关系

Bean Validation
Jakarta Bean Validation 是一套 Java EE 规范，通过注解表达对对象模型的约束，可自定义约束。

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
</dependency>

注解目录如下图：

空值检查
@Null：验证对象是否为null
@NotNull：验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank：检查约束字符串是不是Null还有被Trim的长度是否大于0，只对字符串，且会去掉前后空格。
@NotEmpty：检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue：验证 Boolean 对象是否为 true
@AssertFalse：验证 Boolean 对象是否为 false
长度检查
**@Size(min=, max=)：验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
日期检查
@Past：验证 Date 和 Calendar 对象是否在当前时间之前
@Future：验证 Date 和 Calendar 对象是否在当前时间之后
@DateTimeFormat(pattern=“yyyy-MM-dd”)：验证日期格式
正则
@Pattern：验证 String 对象是否符合正则表达式的规则
数值检查 建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为String为"",Integer为null
@Min：验证 Number 和 String 对象是否大等于指定的值
@Max：验证 Number 和 String 对象是否小等于指定的值
@DecimalMax：被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin：被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits：验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=)：验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
其它注解
@Valid：递归的对关联对象进行校验, 如果关联对象是个集合或者数组，那么对其中的元素进行递归校验，如果是一个map，则对其中的值部分进行校验。(是否进行递归验证)，该注解使用在Action的参数上。
@Email：验证是否是邮件地址，如果为null,不进行验证，算通过验证。

HIbernate Validator
HIbernate Validator是对Bean Validator的实现，新增了部分注解

<dependency>
  <groupId>org.hibernate.validator</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>6.2.0.Final</version>
  <scope>compile</scope>
 </dependency>

注解目录如下图：

@Length(min=, max=)：Validates that the annotated string is between min and max included.（Hibernate）
@CreditCardNumber：信用卡验证
**@ScriptAssert(lang= ,script=, alias=) **验证@ScriptAssert可以访问静态方法
@URL(protocol=,host=, port=,regexp=, flags=)
范围
@Range(min=, max=)：检查被注解对象的值是否处于min与max之间，闭区间，包含min与max值
@Range(min=10000,max=50000,message=“必须介于{2}-{1}之间”)