@Valid 和 @Validated注解的使用

1，@Valid 和 @Validated 的作用

        现在项目大多都是分布式项目，前端往后端传数据的时候，为了保证数据的有效、可用性，需要对前端传入的数据进行校验，但是大量的校验会很繁琐，造成代码中出现大量的if else 语句的产生，所以@Valid和@Validated就很好的解决了这个问题。

        总结：@Valid和@Validated 主要用于数据的校验的。

2，@Valid 和 @Validated 的区别

        1， 所属的包不同。@Valid 是属于javax.validation.Valid 包下面的，是jdk提供的；@Validated是org.springframework.validation.annotation 包下的注解，是spring提供的。

        2，功能上不同。@Validated在功能上比@Valid强大，在@Valid的基础上又提供了分组功能和验证排序功能。

        3，使用位置不同。@Valid 可以使用在方法、构造函数、方法参数和成员属性（字段）上；@Validated可以使用在类型、方法、方法参数上，但是不可以使用在成员属性（字段）上。

3，@Valid 的使用

        首先，需要在实体类的相关字段上添加需要校验的注解。

public class User {
    private String id;  
    @NotBlank(message = "密码不能为空")
    private String password;
	@Min(value = 18,message = "未成年禁止入内")  
	private Integer age;

        其次，在controller层的方法的要校验的参数上添加@Valid注解

@PostMapping("/action/register")
    public Result registerByForm(@Valid @RequestBody User user){
        return userService.register(user);
    }

        然后，编写全局异常捕捉类。

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

    private final static String EXCEPTION_MSG_KEY = "Exception message : ";

    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleValidException(MethodArgumentNotValidException e){
                //日志记录错误信息
                log.error(Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
                //将错误信息返回给前台
                return Result.error(103, Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
    }
}

@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Result<T> {
    private Integer code;
    private String message;
    private T data;

    public Result() {
        this.code = 200;
        this.message = "操作成功";
    }

    /**
     * 用于错误处理
     * @param code 错误码 
     * @param message 错误提示信息
     */
    public Result(Integer code,String message){
        this.code = code;
        this.message = message;
    }

    public static  Result<String> error(Integer code,String msg){
        return new Result<>(code,msg);
    }
}

        此时一个demo就编写好了，如果前端传入的数据不符合后端的要求，此时会把“密码不能为空”、“未成年禁止入内”等信息传给前端。

4，@Validated 的使用

        @Validated 是 @Valid 的一次封装，在@Valid的基础上增加了分组以及验证排序的功能。

        分组功能的使用

        当一个实体类需要多种验证方式时，比如：添加时需要对姓名进行非空验证，修改时需要对id进行验证，而添加时就不需要对id进行验证。

        首先，定义两个分组的接口：

public interface Add{
}

public interface Update{
}

        其次，在实体类上使用@Validated的分组功能。

@Data
public class Person {
	@NotEmpty(groups = Update.class, message = "更新时候id不能为空")
    private Long id;
    @NotEmpty(groups = Add.class, message = "姓名不能为空")
    private String name;
}

        在controller中，使用分组进行接口验证。

@RestController
@Slf4j
public class VerifyController {

    @PostMapping(value = "/validated/add")
    public void add(@Validated(value = Add.class) @RequestBody Person person) {
       ...
    }
    @PostMapping(value = "/validated/update")
    public void update(@Validated(value = Update.class) @RequestBody Person person) {
    ...
    }
}

5，相关注解