Validation 使用

之前我们验证参数使用的是 if - else 配合工具类中的 Xxxx.isNull() 等方法。这样使得代码冗余，影响美观。

现在可以优雅的使用注解进行参数验证，示例分为两种：①在形参上使用注解验证；②对形参对象中的属性进行验证

一、Maven 依赖

⚠有坑：必须导入 “hibernate-validator” 依赖，否则验证不起作用

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

若使用的是 SpringBoot 构建项目可以引入：

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

或

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

二、在形参上使用注解验证

@RestController
@Slf4j
@Validated
public class AnnotationController {
    @RequestMapping("/find")
    public String findById(
            @RequestParam(name = "id", required = false)
            @NotNull(message = "查询 ID 为空！") String id) {

        log.info("需要查询的 id ==> " + id);
        return "success ==> id:" + id;
    }
}

⚠注意点：若使用形参验证，需要在类上添加 @Validated 注解，否则验证不起作用

【测试】
1、前台未传入参数，即 id = null，此时前台出现 500 异常

2、后台异常

javax.validation.ConstraintViolationException: findById.id: 查询 ID 为空！
	at org.springframework.validation.beanvalidation.MethodValidationInterceptor.invoke(MethodValidationInterceptor.java:116) ~[spring-context-5.2.7.RELEASE.jar:5.2.7.RELEASE]
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186) ~[spring-aop-5.2.7.RELEASE.jar:5.2.7.RELEASE]
.....

三、对形参对象中的属性进行验证

1、【PersonDTO.java】

@Data
public class PersonDTO implements Serializable {
    private static final long serialVersionUID = -3565776723852112655L;

    @NotNull(message = "人员 ID 不能为空！")
    private String id;
    @NotBlank(message = "人员 name 不能为空！")
    private String name;
    private Integer age;
    /**
     * 0 ——> 男   1 ——> 女   其他 ——> 未知
     */
    private String gender;
}

2、【AnnotationController.java】

@RestController
@Slf4j
public class AnnotationController {
    @RequestMapping("/find/person")
    public String find(@Valid PersonDTO personDTO) {
        log.info("形参中的 PersonDTO ==> " + personDTO);
        return personDTO.toString();
    }
}

⚠注意点：若使用对象封装参数验证，需要在对象形参前使用 @Valid / @Validated 注解，否则验证不起作用

@Valid 和 @Validated

---

@Valid 和 @Validated 注解都用于字段校验
@Valid 所属包为：javax.validation.Valid ; @Validated 所属包为 org.springframework.validation.annotation.Validated
@Validated 是 @Valid 的一次封装，是Spring提供的校验机制使用。@Valid 不提供分组功能

【测试】
① 前台未传入参数，即 person 中各个属性均为 null，此时前台出现 400 异常

② 后台异常

Field error in object 'personDTO' on field 'name': rejected value [null]; codes 
[NotBlank.personDTO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments 
[org.springframework.context.support.DefaultMessageSourceResolvable: codes [personDTO.name,name]; 
arguments []; default message [name]]; default message [人员 name 不能为空！]

Field error in object 'personDTO' on field 'id': rejected value [null]; codes 
[NotNull.personDTO.id,NotNull.id,NotNull.java.lang.String,NotNull]; arguments 
[org.springframework.context.support.DefaultMessageSourceResolvable: codes [personDTO.id,id]; 
arguments []; default message [id]]; default message [人员 ID 不能为空！]]

四、常用注解使用

4.1 @NotNull、NotBlank、NotEmpty

@NotNull：验证对象不能为 null，可以对任何对象进行验证（包括 String、数组、集合等），只能验证该对象不能为 null，对于集合和数组 size 为 0、空字符串、字符串长度为 0 的情况不能验证；
@NotBlank：验证 字符串 不能为 null，并且使用 trim() 后字符串长度大于 0；
@NotEmpty：验证 集合、数组 不能为 null，并且 size() 大于 0。

4.2 @Length、@Size、@Max、@Min

@Length：用于验证 字符串 属性的值在指定范围内

常用属性：

• min：字符串长度大于等于该值
• max：字符串长度小于等于该值
• message：验证不通过时的异常信息
• groups：指定分组

示例：

@Length(min = 1, max = 5, message = "个人介绍不能超过 5 个字符！", groups = Groups.MyLength.class)
private String message;

@Size：用于验证 数组、集合 属性的值的 size 在指定范围内

常用属性：

• min：数组、集合 size 大于等于该值
• max：数组、集合 size 小于等于该值
• message：验证不通过时的异常信息
• groups：指定分组

示例：

@Size(max = 2, message = "个人房子不能超过 2 个！", groups = Groups.MySize.class)
private List<House> houses;

@Max：用于验证 数值型 属性的值要小于等于指定的最大值

常用属性：

• value：指定最大值
• message：验证不通过时的异常信息
• groups：指定分组

@Min：用于验证 数值型 属性的值要大于等于指定的最小值

常用属性：

• value：指定最小值
• message：验证不通过时的异常信息
• groups：指定分组

示例：

@Max(value = 25, message = "年龄不能大于 25 岁！", groups = Groups.Range.class)
@Min(value = 12, message = "年龄不能小于 12 岁！", groups = Groups.Range.class)
private Integer age;

🚨 注：以上四个注解不能验证 null，若属性值为 null，这两个注解无效，若要保证这两个注解起作用，而且不能为 null，需要配合使用 @NotNull、NotBlank、NotEmpty

示例：

@Data
public class Person {
   @NotBlank(message = "人员 ID 不能为空！", groups = Groups.All.class)
   private String id;

   @NotBlank(message = "人员 Name 不能为空！", groups = Groups.Select.class)
   private String name;

   @NotBlank(message = "人员 Gender 不能为空！", groups = Groups.Update.class)
   private String gender;

   @NotNull(message = "年龄不能为 null！", groups = Groups.Range.class)
   @Max(value = 25, message = "年龄不能大于 25 岁！", groups = Groups.Range.class)
   @Min(value = 12, message = "年龄不能小于 12 岁！", groups = Groups.Range.class)
   private Integer age;

   @NotBlank(message = "个人介绍不能为空！", groups = Groups.MyLength.class)
   @Length(min = 1, max = 5, message = "个人介绍不能超过 5 个字符！", groups = Groups.MyLength.class)
   private String message;

   // 因个人的房子数量可以为 0，即集合的 size 可以为 0，但是集合不能为 null，
   // 所以在此不能使用 @NotEmpty，而是使用 @NotNull
   @NotNull(message = "房子不能为 null！", groups = Groups.MySize.class)
   @Size(max = 2, message = "个人房子不能超过 2 个！", groups = Groups.MySize.class)
   private List<House> houses;
}

五、验证分组

现在有这么一个需求：对于前端传过来的请求参数使用一个 VO 封装，对于修改和保存使用的是相同的 VO，但这两个请求对于参数的验证是不同的，比如：保存需要所有属性不能为 null，而修改只需要保证 id 不为 null 即可。

如何使用一个 VO 根据不同的请求进行相应的验证，此时就需要使用验证的分组属性 —— groups

PersonController .class

通过 @Validated() 指定需要的分组，激活对应的验证注解

@RestController
public class PersonController {
    @PostMapping("/save")
    public String save(@Validated(Groups.Save.class) @RequestBody PersonVO person) {
        System.out.println("This is save method ......." + person);
        return "save success";
    }

    @PostMapping("/update")
    public String update(@Validated(Groups.Update.class) @RequestBody PersonVO person) {
        System.out.println("This is update method ......." + person);
        return "update success";
    }
}

PersonVO.class

通过对应的验证注解中的 groups 属性指定分组

@Data
public class PersonVO {
    @NotBlank(message = "人员 ID 不能为空！", groups = {Groups.Save.class, Groups.Update.class})
    private String id;

    @NotBlank(message = "人员 Name 不能为空！", groups = Groups.Save.class)
    private String name;

    @NotNull(message = "年龄不能为 null！", groups = Groups.Save.class)
    @Max(value = 25, message = "年龄不能大于 25 岁！", groups = Groups.Save.class)
    @Min(value = 12, message = "年龄不能小于 12 岁！", groups = Groups.Save.class)
    private Integer age;
}

Groups.class

自定义分组，分组类型必须是一个接口，若是类会出现以下异常：
javax.validation.ValidationException: HV000045: A group has to be an interface. com.example.validationbootdemo.bean.Person is not.

public class Groups {
    public interface Save {}
    public interface Update {}
}

六、常用验证注解

空检查
@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）长度是否在给定的范围之内  
@Length(min=, max=)		验证注解的元素值长度在min和max区间内

日期检查
@Past		验证 Date 和 Calendar 对象是否在当前时间之前  
@Future		验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern	验证 String 对象是否符合正则表达式的规则

数值检查，建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null
@Min			验证 Number 和 String 对象是否大等于指定的值  
@Max			验证 Number 和 String 对象是否小等于指定的值  
@DecimalMax		被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin		被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits			验证 Number 和 String 的构成是否合法  
@Digits(integer=,fraction=)		验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。

@Range(min=, max=)	验证注解的元素值在最小值和最大值之间
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email  验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)