@Validated注解和@Valid注解区别

大忽悠爱学习

发布于 2021-12-07 18:03:12

1.5K0

@Validated注解和@Valid注解详解

引入依赖

        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>5.2.4.Final</version>
        </dependency>

在之前的Spring Boot 版本中，hibernate-validator是作为默认引入的web开发的集成package，但是在我最新使用的Spring Boot 2.3.0.RELEASE已经不是默认引入的了，所以需要通过上面的maven坐标单独引入。

@Validated注解和@Valid注解区别

import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;

@Validated是spring旗下的注解,@Valid注解时javax包下的注解，是jdk给提供的

@Validated：是spring提供的对@Valid的封装，常见用在方法上进行校验，@Validated要比@Valid更加强大，@Validated在@Valid之上提供了分组功能和验证排序功能

//@Valid注解可以用在方法上，成员属性上，构造函数上，参数上
// ElementType.TYPE_USE:jdk8新出类型，表示可以在任意地方使用该注解
@Target({ElementType.METHOD, ElementType.FIELD, 
ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Valid {
}

//@Validated注解可以用在类上，方法上，参数上
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {
    Class<?>[] value() default {};
}

@Valid：没有分组的功能。

@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上

两者是否能用于成员属性（字段）上直接影响能否提供嵌套验证的功能

显然@Valid注解可以提供嵌套校验的功能

@Validated除了没有嵌套校验的功能只能，其他@Valid注解有的功能，它都有，@Valid注解没有的功能，它也有

@Valid注解使用场景演示

嵌套校验和controller层请求参数校验

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class User
{
    @NotBlank(message = "名字不能为空")
    String name;
    @Pattern(regexp= "123456",message ="手机号必须是123456" )
    String phone;
    @Min(value = 18,message = "年龄必须大于18")
    Integer age;
    @Valid //嵌套校验
    Peo peo;
}

@Data
public class Peo
{
    @Length(min = 5,max=10,message = "名字长度不能小于5个字符,也不能超过10个字符")
    String name;
}

controller层:

@RestController
public class UserController
{
    @GetMapping("/user")
    //@Valid注解在这里表示,需要对封装的user对象的属性进行校验
    public User getUser(@Valid @RequestBody User user)
    {
       return user;
    }
}

测试:

{
    "name":"超级大忽悠",
    "phone":"123456",
    "age":18,
    "peo":
    {
        "name":"小朋友"
    }
}

嵌套校验成功

@Valid注解校验不通过会抛出MethodArgumentNotValidException异常

如何处理抛出的异常，两种方式:

@Valid注解的请求参数后面紧跟一个BindingResult对象，来封装校验结果

也可以跟一个Errors对象，因为BindingResult继承至Errors对象

@RestController
public class UserController
{
    @GetMapping("/user")
    //@Valid注解在这里表示,需要对封装的user对象的属性进行校验
    public Object getUser(@Valid @RequestBody User user, BindingResult result)
    {
        boolean hasErrors = result.hasErrors();
        if(hasErrors)
        {
            List<ObjectError> allErrors = result.getAllErrors();
            return allErrors;
        }
        return user;
    }
}

返回结果:

[
    {
        "codes": [
            "Length.user.peo.name",
            "Length.peo.name",
            "Length.name",
            "Length.java.lang.String",
            "Length"
        ],
        "arguments": [
            {
                "codes": [
                    "user.peo.name",
                    "peo.name"
                ],
                "arguments": null,
                "defaultMessage": "peo.name",
                "code": "peo.name"
            },
            10,
            5
        ],
        "defaultMessage": "名字长度不能小于5个字符,也不能超过10个字符",
        "objectName": "user",
        "field": "peo.name",
        "rejectedValue": "小朋友",
        "bindingFailure": false,
        "code": "Length"
    }
]

这个方法使用的时候需要注意，一旦用了BindingResult来封装校验结果，那么就不会再抛出MethodArgumentNotValidException异常了

全局处理异常MethodArgumentNotValidException

//处理全局异常
@RestControllerAdvice
public class WholeException
{
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException ex)
    {
    //获取异常的参数名字
        MethodParameter parameter = ex.getParameter();
       //结果为user
        System.out.println(parameter.getParameterName());
      return ex.getBindingResult().getAllErrors();
    }
}

结果与上面一致

@Validated使用场景演示

controller请求参数校验

@RestController
public class UserController
{
    @GetMapping("/user")
    //@Valid注解在这里表示,需要对封装的user对象的属性进行校验
    public Object getUser(@Validated @RequestBody User user)
    {
        return user;
    }
}

这个用法和@Valid相同，因为本来就是对@Valid注解的封装

对于异常的抛出处理，也和上面一致

对配置文件的装配进行校验

application.yaml

user:
  name: 大忽悠
  phone: 12356
  age: 16

@Data
@NoArgsConstructor
@AllArgsConstructor
@Validated
@ConfigurationProperties(prefix = "user")
@Component
public class User
{
    @NotBlank(message = "名字不能为空")
    String name;
    @Pattern(regexp= "123456",message ="手机号必须是123456" )
    String phone;
    @Min(value = 18,message = "年龄必须大于18")
    Integer age;
    @Valid //嵌套校验
    Peo peo;
}

绑定配置类和对应配置文件里面的前缀属性，本质是生成一个json文件，让idea能够获得提示信息

   <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>

测试

说明:

配置文件里面属性是通过配置类的setter方法注入进去的，只有在配置文件中声明的属性，才回去调用对应的配置类中属性的setter方法进行赋值操作，这个时候才会进行数据校验，因此如果没有在配置文件中声明的属性，那么其对应的setter方法不会被调用，自然也就不会进行数据校验

所以上面的peo的name属性的setter方法没有被调用，自然也就不会进行name属性的校验

@Valid注解没有对配置类和配置文件绑定属性进行校验的功能

正常运行，没有报错，说明@Valid注解没有用处

分组校验

校验分组1和2的接口类

public interface Gropu1 {
}

public interface Gropu2 {
}

实体类

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User
{
    @Min(groups = Gropu1.class,value=18,message = "age1必须大于等于18")
    Integer age1;
    @Min(groups = Gropu2.class,value = 16,message = "age2必须大于等于16")
    Integer age2;
    @Pattern(regexp= "123456",message ="手机号必须是123456" )
    String phone;
}

controller层

@RestController
public class UserController
{
    @GetMapping("/age1")
    //@Valid注解在这里表示,需要对封装的user对象的属性进行校验
    public Object getUser1(
            //group1的分组规则进行校验
            @Validated(Gropu1.class) @RequestBody User user)
    {
        return user;
    }

    @GetMapping("/age2")
    //@Valid注解在这里表示,需要对封装的user对象的属性进行校验
    public Object getUser2(
            //group1的分组规则进行校验
            @Validated(Gropu2.class) @RequestBody User user)
    {
        return user;
    }
}