@Validated使用

导入依赖

首先需要导入相关的依赖才能使用该注解

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

异常处理

参数校验失败后，可以通过全局异常捕获到异常，并自定义捕获后的操作

/**
 * 全局异常处理器
 */
@RestControllerAdvice
public class GlobalExceptionHandler
{
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);


    /**
     * 自定义验证异常
     */
    @ExceptionHandler(BindException.class)
    public AjaxResult handleBindException(BindException e)
    {
        log.error(e.getMessage(), e);
        String message = e.getAllErrors().get(0).getDefaultMessage();
        return AjaxResult.error(message);
    }

    /**
     * 自定义验证异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
    {
        log.error(e.getMessage(), e);
        String message = e.getBindingResult().getFieldError().getDefaultMessage();
        return AjaxResult.error(message);
    }
}

这里使用到了@RestControllerAdvice注解，该注解为什么要使用在这儿呢？

• @RestControllerAdvice是一个组合注解，由@ControllerAdvice、@ResponseBody组成。用于定义@ExceptionHanler、@InitBinder和@ModelAttribute方法
• @ControllerAdvice：Controller增强器，作用是给Controller添加统一操作或处理
  常结合@ExceptionHandler用于全局异常处理

通过上述解释，其实我们可以理解到此处使用该注解其实就是结合@ExceptionHandler做一个全局异常处理，方便自己对捕获后的异常自定义自己的操作。

参数校验

普通校验

@Data
public class User {

    @NotBlank(message = "用户名不能为空")
    private String username;

    @Min(value = 1, message = "最小年龄不低于1岁")
    @Max(value = 120, message = "最大年龄不超过120岁")
    private int age;

    @Email(message = "邮箱有误")
    private String email;

    @Digits(integer = 2, fraction = 2)
    private BigDecimal weight;
}

嵌套校验

校验对象中的集合元素或对象

@Data
public class Team {

    @NotBlank(message = "团队名称不能为空")
    private String name;

	// 只能使用@Valid进行嵌套校验，@Validated不能使用在成员属性上
    @NotNull(message = "队伍人员不能为空")
    @Valid
    private List<User> userList;

    @NotNull(message = "队伍负责人不能为空")
    @Valid
    private User user;
}

补充：@Valid和@Validated区别

• @Validated支持分组验证（没有添加分组属性时 ，默认验证没有分组的验证属性）

• @Validated支持组序列

• 注解地方

  • @Validated可以用在类型、方法、和方法参数上，但不能用在成员属性(字段)上

  • @Valid可以用在方法、构造函数、方法参数和**成员属性(字段)**上

    是否能用于成员属性上，直接影响能否提供嵌套验证功能

分组校验

public interface Add {
}

public interface Update {
}

@Data
public class User {

    @NotNull(message = "id不能为空", groups = {Update.class})
    private int id;

    @NotBlank(message = "用户名不能为空", groups = {Add.class})
    private String username;

    @NotBlank(message = "描述不能为空")
    private String description;
}

不使用分组校验

默认验证没有分组的属性（与使用default.class效果相同）

@RequestMapping("noGroup")
public AjaxResult noGroup(@Validated @RequestBody User user) {
    return AjaxResult.success();
}
//default.class校验
@RequestMapping("default")
public AjaxResult defaultTest(@Validated(Default.class) @RequestBody User user) {
    return AjaxResult.success();
}

使用分组校验

只校验该分组下的属性

@RequestMapping("add")
public AjaxResult add(@Validated({Add.class}) @RequestBody User user) {
    return AjaxResult.success();
}

参考连接

• @Validated注解详解，分组校验，嵌套校验，@Valid和@Validated 区别，Spring Boot @Validated
• @Validated和@Valid区别