@Valid和@validated用法与自定义验证注解

@Valid

作用：用于验证注解是否符合要求，直接加在变量user之前，在变量中添加验证信息的要求，当不符合要求时就会在方法中返回message 的错误提示信息。

用法：

@RequestMapping("/valid")
public Object valid(@Valid Person person, BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
    	//获取错误信息
    	FieldError fieldError = bindingResult.getFieldError();
    	//获取验证失败字段名
        String field = fieldError.getField();
        //获取验证失败的message
        String defaultMessage=fieldError.getDefaultMessage();
        return defaultMessage;
    }
    return "success";
}
@Valid:加在需要校验的实体类中
BindingResult:controller控制层写参数接收的入口，需要注意的是@Valid和BindingResult是一一对应的，如果有多个@Valid，那么每个@Valid后面都需要添加BindingResult用于接收bean中的校验信息

实体类：

public class Person {
    @NotBlank(message = "用户名不能为空")
    private String name;
    @NotBlank(message = "id不能为空")
    private String id;
    @NotNull(message = "日期不能为空")
    private Date data;
}

下面注解可以在实体类字段上面定义：

限制	说明
@Null	限制只能为null
@NotNull	限制必须不为null
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Past	限制必须是一个过去的日期
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max,min)	限制字符长度必须在min到max之间
@Past	验证注解的元素值（日期类型）比当前时间早
@NotEmpty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

自定义校验注解：

创建注解：

@Target({ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {MyConstraintValidator.class})//引入自定义验证规则文件
public @interface MyValid {

    //自定义属性,最小长度，可以设置默认值，也可以不设置
    int min() default 3;

    String message() default "{javax.validation.constraints.NotBlank.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };
}

创建自定义验证规则文件，简单的实现：

/*
 *需要实现ConstraintValidator<A extends Annotation, T>
 *A extends Annotation:需要设置为自定义注解类型
 *T:需要校验数据的类型
 **/
public class MyConstraintValidator implements ConstraintValidator<MyValid, Object> {
	/**
	  *初始化验证器，可以初始化验证注解
	  *@param constraintAnnotation 验证注解的实例
	  */
    @Override
    public void initialize(MyValid constraintAnnotation) {
        int min = constraintAnnotation.min();
        System.out.println("Exception");
    }
	/**
	  *实现验证逻辑，判断name长度是否大于min()中定义的长度
	  *@param  o 需要验证的对象
	  *@param constraintValidatorContext 约束验证器的上下文
	  */
    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        if (o.toString().length()>min){
            return true;
        }
        return false;
    }
}

实体类：

public class Person {
    @MyValid(min = 3,message = "姓名长度不能低于3")
    private String name;
}

@Validated

作用：用于验证注解是否符合要求，直接加在变量user之前，在变量中添加验证信息的要求，当不符合要求时就会在方法中返回message的错误提示信息。比@Valid多了分组功能
用法和@Valid相同，并且自定义注解也一样

分组功能：

​ 扩展性高，可以根据不同的业务需求，根据设置分组进行校验

public class Person {
    @NotBlank(message = "name不能为空",groups = aa.class)
    private String name;
    @NotBlank(message = "id不能为空",groups = bb.class)
    private String id;
}

@RequestMapping("/valid")
public void valid(@RequestBody @Validated(aa.class) Person person,BindingResult bindingResult) {
   Map<String, Object> model = bindingResult.getModel();
}
只会校验name
    
@RequestMapping("/valid")
public void valid(@RequestBody @Validated(bb.class) Person person,BindingResult bindingResult) {
   Map<String, Object> model = bindingResult.getModel();
}
只会校验id
    
@RequestMapping("/valid")
public void valid(@RequestBody @Validated(aa.class,bb.class) Person person,BindingResult bindingResult) {
    Map<String, Object> model = bindingResult.getModel();
}
会校验id和name

注意：分组的class只能为接口

@Valid和@Validated 区别

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制
@Valid：作为标准JSR-303规范，还没有吸收分组的功能。

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上
@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上
两者是否能用于成员属性（字段）上直接影响能否提供嵌套验证的功能

嵌套验证：

public class Person {
    @NotBlank(message = "name不能为空")
    private String name;
    @NotBlank(message = "id不能为空")
    private String id;
    @NotNull(message = "stus不能为空")
    private List<Stu> stus;
}

嵌套类就是一个类中包含另一个类

public class Stu {
    @NotBlank(message = "stu_name不能为空")
    private String stu_name;
    @NotBlank(message = "stu_id不能为空")
    private String stu_id;
}

如上图Person类中只能校验stus，不能校验Stu类中的stu_name和stu_id

如果想要嵌套验证，必须在Person的stus字段上面标明这个字段的实体也要进行验证，由于@Validated不能用在成员属性（字段）上，但是@Valid能加在成员属性（字段）上，而且@Valid类注解上也说明了它支持嵌套验证功能，那么我们能够推断出：@Valid加在方法参数时并不能够自动进行嵌套验证，而是用在需要嵌套验证类的相应字段上，来配合方法参数上@Validated或@Valid来进行嵌套验证。

例如：

就可以校验实体类Person中字段stus对应实体类中的属性了。

public class Person {
    @NotBlank(message = "name不能为空")
    private String name;
    @NotBlank(message = "id不能为空")
    private String id;
    @Valid
    @NotNull(message = "stus不能为空")
    private List<Stu> stus;
}

	@RequestMapping("/valid")
    public void valid(@RequestBody @Valid Person person,BindingResult bindingResult) {
            Map<String, Object> model = bindingResult.getModel();
    }

@Validated： 用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性（字段）上，也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

@Valid： 用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性（字段）上，提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。