@Validated注解和@Valid注解区别

引入依赖

注意：spirngboot升级到2.3.0.RELEASE之后，hibernate-validator不再作为spring-boot-starter-web的默认依赖项，需要通过下面的maven坐标单独引入：

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

且它的功能被抽取出来，单独做成了一个场景启动器，可使用如下坐标导入：

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

 以上坐标，根据需要使用其中一种导入即可。

---

@Validated注解和@Valid注解区别

import org.springframework.validation.annotation.Validated;

import javax.validation.Valid;

查看注解所在的包，不难发现：@Validated是spring旗下的注解，@Valid注解时javax包下的注解，是jdk给提供的。

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

---

使用细节

1、在实体类中添加校验规则：

package org.example.entity;
 
import lombok.Data;
import org.hibernate.validator.constraints.Length;
 
import javax.validation.constraints.Email;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
 
@Data
public class User {
 
    private Long id;
 
    @NotBlank(message = "name不能为空")
    @Length(min = 5,max=10,message = "name长度不能小于5个字符,也不能超过10个字符")
    private String name;
 
    @NotNull(message = "password不能为空")
    private String password;
 
    @Min(value = 18,message = "age必须大于18")
    @NotNull(message = "age不能为空")
    private Integer age;
 
    @Email
    private String email;
}

2、使用@Validated或@Valid

/*
    在没有全局异常处理类或用BindingResult来封装校验结果时，请求校验不通过返回的报文如下：
    {
        "timestamp": "2023-06-12T06:14:47.722+00:00",
        "status": 400,
        "error": "Bad Request",
        "message": "",
        "path": "/user"
    }
*/
@PostMapping("/userV1")
// @Valid注解在这里表示,需要对封装的user对象的属性进行校验
public Object user(@Valid @RequestBody User user) {
    return user;
}

3、添加全局异常处理类

package org.example.controller;
 
import cn.hutool.json.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
 
// 处理全局异常
@RestControllerAdvice
@Slf4j
public class GlobalExceptions {
    // @ExceptionHandler注解用于指定要处理的异常
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public JSONObject handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error(e.getMessage(), e);
        FieldError fe = e.getBindingResult().getFieldError();
        String message = fe == null ? "" : fe.getDefaultMessage();
        
        JSONObject result = new JSONObject();
        result.put("code",500);
        result.put("msg",message);
        
        return result;
    }
}

4、测试请求

请求参数：

{
    "name": "zhangsan",
    "password" : "123"
}

响应结果【返回的数据是我们在全局异常处理类中定义的】：

{
    "code": 500,
    "msg": "年龄不能为空"
}

拓展

1、如果项目中已经定义了全局异常返回的参数格式不是我们想要的，可以在@Valid注解的请求参数后面可以紧跟一个BindingResult对象来封装校验结果，自己来定义返回的数据格式。

@PostMapping("/userV2")
public Object getUser(@Valid @RequestBody User user, BindingResult bindingResult) {
    boolean hasErrors = bindingResult.hasErrors();
    if (hasErrors) {
        FieldError fe = bindingResult.getFieldError();
        String message = fe == null ? "" : fe.getDefaultMessage();
        JSONObject result = new JSONObject();
        result.put("resultCode", 500);
        result.put("resultMsg", message);
        return result;
    }
    return user;
}

注意：一旦用了BindingResult来封装校验结果，那么就不会再抛出MethodArgumentNotValidException异常了。

 

2、@Pattern注解的使用

package org.example.entity;
 
import lombok.Data;
 
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
 
@Data
public class Order {
    @NotNull(message = "orderId 不能为null")
    private String orderId;
 
    /*
    使用了@Pattern注解来对orderType字段进行验证，使用正则表达式"0[1-4]+“，
    表示只允许取值为"01”、“02”、“03”、“04”。
    如果请求体中的orderType字段不符合正则表达式"0[1-4]+"，
    会抛出MethodArgumentNotValidException异常，可以在异常处理器中进行处理。
     */
    @Pattern(regexp="0[1-4]+")
    @NotNull(message = "orderType 不能为null")
    private String orderType;  
}