相关推荐recommended
springboot使用@Valid 和 @Validated 注解校验详解以及编写一个自定义全局异常类
作者:mmseoamin日期:2023-12-14
package com.test.springvalid.config;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
/**
 * 通用返回结果,服务端响应的数据最终都会封装成此对象
 * @param 
 */
@Data
public class R {
    private Integer code; //编码:1成功,0和其它数字为失败
    private String msg; //错误信息
    private T data; //数据
    private Map map = new HashMap(); //动态数据
    public static  R success(T object) {
        R r = new R();
        r.data = object;
        r.code = 1;
        return r;
    }
    public static  R error(String msg) {
        R r = new R();
        r.msg = msg;
        r.code = 0;
        return r;
    }
    public R add(String key, Object value) {
        this.map.put(key, value);
        return this;
    }
}

全局异常处理类

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@Slf4j
@RestControllerAdvice(annotations = {RestController.class, Controller.class})
public class globalException {
    /**
     * 异常处理方法
     * @return
     */
    @ExceptionHandler(Exception.class)
    public R exceptionHandler(Exception ex){
        log.error(ex.getMessage());
        System.out.println(ex.getMessage());
        return R.error("未知错误");
    }
}

验证:

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/test")
public class TestControllerException {
    @RequestMapping("/add")
    public String add() {
        int i = 1/ 0;
        return String.valueOf(i);
    }
}

==============================================

https://blog.csdn.net/sunnyzyq/article/details/103527380?spm=1001.2014.3001.5506

导入所需要的包:

如果你是 springboot 项目,那么可以不用引入了,已经引入了,他就存在于最核心的 web 开发包里面。


    org.springframework.boot
    spring-boot-starter-web
    2.0.5.RELEASE

如果你不是 springboot 项目,那么引入下面依赖即可:


    javax.validation
    validation-api
    1.1.0.Final

 

    org.hibernate
    hibernate-validator
    5.4.1.Final

新建三个实体类

实现一: 使用@Valid注解修饰

import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.NotBlank;
import java.io.Serializable;
@Data
public class Course implements Serializable {
    @NotBlank(message = "请输入课程名称")
    @Length(message = "课程名称不能超过个 {max} 字符", max = 4)
    private String courseName;
}
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.NotBlank;
import java.io.Serializable;
@Data
public class Score implements Serializable {
    @NotBlank(message = "请输入scname")
    @Length(message = "scname不能超过个 {max} 字符", max = 4)
    private String scname;
}
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;
import java.util.List;
/**
 * (Student)实体类
 *
 * @author makejava
 * @since 2023-06-24 18:39:24
 */
@Data
public class Student implements Serializable {
    private static final long serialVersionUID = 680914045608322662L;
    @NotBlank(message = "请输入")
    @Length(message = "不能超过个 {max} 字符", max = 4)
    private String stuId;
    @NotBlank(message = "请输入名称")
    @Length(message = "名称不能超过个 {max} 字符", max = 4)
    private String stuName;
    @NotNull(message = "请输入年龄")
    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)
    private int age;
    @NotEmpty(message="兴趣爱好不能为空")
    @Size(message = "兴趣爱好最多选择{max}个",max= 2)
    private List list;
    @Valid
    private Score score;
    @Valid
    private List courseList;
}

用student类来接收参数 参数使用@RequestBody修饰的student类

import com.test.springvalid.domain.Student;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
/**
 * (Student)表控制层
 *
 * @author makejava
 * @since 2023-06-24 18:39:24
 */
@RestController
@RequestMapping("student")
public class StudentController {
    @RequestMapping("/add")
    public String add(@Valid @RequestBody Student student, BindingResult bindingResult) {
       // 所有字段是否验证通过,true数据无误,false数据有误
        if(bindingResult.hasErrors()) {
        // 数据有误情况,返回第一条错误信息到前端
            return bindingResult.getAllErrors().get(0).getDefaultMessage();
        }
        return "新增成功";
    }
}

对应的json数据为:

{
    "stuId": "33",
    "stuName": "sql",
    "age": 1,
    "list": [
        "tt",
        "ii"
    ],
    "score": {
        "scname": "33"
    },
    "courseList": [
        {
            "courseName":"数学"
        },
        {
            "courseName":"数学1887979"
        }
    ]
}

实现二:使用@Validated注解实现

实体类不动

import com.test.springvalid.domain.Student;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * (Student)表控制层
 *
 * @author makejava
 * @since 2023-06-24 18:39:24
 */
@RestController
@RequestMapping("stu1")
public class Student1Controller {
    @RequestMapping("/add")
    public String add(@Validated @RequestBody Student student) {
        return "新增成功";
    }
}

定义一个全局异常处理器类:

import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class ValidExceptionHandler {
    @ExceptionHandler(Exception.class)
    public String validExceptionHandler(BindingResult bindingResult) {
        return bindingResult.getAllErrors().get(0).getDefaultMessage();
    }
}

@Valid 和 @Validated 比较

最后我们来对 @Valid 和 @Validated 两个注解进行总结下:

(1)@Valid 和 @Validated 两者都可以对数据进行校验,待校验字段上打的规则注解(@NotNull, @NotEmpty等)都可以对 @Valid 和 @Validated 生效;

(2)@Valid 进行校验的时候,需要用 BindingResult 来做一个校验结果接收。当校验不通过的时候,如果手动不 return ,则并不会阻止程序的执行;

(3)@Validated 进行校验的时候,当校验不通过的时候,程序会抛出400异常,阻止方法中的代码执行,这时需要再写一个全局校验异常捕获处理类,然后返回校验提示。

(4)总体来说,@Validated 使用起来要比 @Valid 方便一些,它可以帮我们节省一定的代码,并且使得方法看上去更加的简洁。

常用注解:

注解 说明

@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格式

@Range 被注释的元素必须在合适的范围内

@CreditCardNumber 对信用卡号进行一个大致的验证

@Validated 注解放在方法上或者是方法参数前都是可以的,@Validated 注解统一放在类上边省去了一个一个方法上或者入参上添加该注解

springboot使用@Valid 和 @Validated 注解校验详解以及编写一个自定义全局异常类,在这里插入图片描述,第1张

注:这里需要注意的是 @Validated 注解如果放在类或者放在方法参数前,UserDto 中的校验是无法生效,必须在参数前加 @Validated 注解

springboot使用@Valid 和 @Validated 注解校验详解以及编写一个自定义全局异常类,在这里插入图片描述,第2张

对 @RequestBody 注解修饰的 List(List ) 对象进行校验

该情形与上边介绍的第二种情形,主要是在接口定义那里的注解有区别,第二种情形使用的是 @Validated 注解,而这里需要使用 @Valid 注解(如果使用 @Validated 注解,则 List 中的 UserDto 里的注解(@NotEmpty、@Min 等等)将全都失效!!!! )

嵌套验证的问题

springboot使用@Valid 和 @Validated 注解校验详解以及编写一个自定义全局异常类,在这里插入图片描述,第3张

我们在 UserFacade 的 add 方法的入参(UserDto)上使用 @Validated,就能对 UserDt o内嵌的 GroupDto 的参数进行验证了,代码如下:

springboot使用@Valid 和 @Validated 注解校验详解以及编写一个自定义全局异常类,在这里插入图片描述,第4张