JSR303基本使用以及整合springboot统一异常处理

Promise_J_Z

已于 2023-02-20 10:31:00 修改

阅读量813

点赞数

分类专栏： Java 文章标签： java 开发语言

于 2023-02-20 10:30:00 首次发布

本文链接：https://blog.csdn.net/Promise_J_Z/article/details/129088318

版权

Java 专栏收录该内容

16 篇文章 0 订阅

订阅专栏

本文介绍了JSR303（BeanValidation）在JavaEE6中的作用，以及如何使用HibernateValidator进行普通和分组参数校验。通过引入相关jar包，对实体类进行校验注解，并在控制器中使用@Valid和BindingResult进行验证。此外，还展示了如何通过统一异常拦截器处理校验异常，提高代码的健壮性和可维护性。

摘要由CSDN通过智能技术生成

一、前言

在之前，我对参数进行校验的时候，都是通过StringUtills.isblank方法将参数进行是否为空判断，需要不断的使用if对前端传递过来的数值进行判断以及是很麻烦，更不用说rul，email等格式的判断，并且这对于性能以及代码的美观都是很严重的减分项。现在使用了JSR303做参数校验，发现颇为顺手，再次记下笔记以便以后用时回顾

什么是JSR303

JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation，Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constrain


@NotNull	任何类型	属性不能为null
@NotEmpty	集合	集合不能为null，且size大于0
@NotBlanck	字符串、字符	字符类不能为null，且去掉空格之后长度大于0
@AssertTrue	Boolean	布尔属性必须是true
@Min	数字类型	限定数字的最小值（整型）
@Max	同@Min	限定数字的最大值（整型）
@DecimalMin	同@Min	限定数字的最小值（字符串，可以是小数）
@DecimalMax	同@Min	限定数字的最大值（字符串，可以是小数）
@Range	数字类型	限定数字范围（长整型）
@Length	字符串	限定字符串长度
@Size	集合	限定集合大小
@Past	时间、日期	必须是一个过去的时间或日期
@Future	时期、时间	必须是一个未来的时间或日期
@Email	字符串	必须是一个邮箱格式
@Pattern	字符串、字符	正则匹配字符串

JSR-303 是JAVA EE 6 中的一项子规范，叫n V

二、JSR303基本使用（普通使用）

1）、引入jar包

<dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>

2）、实体类对需要校验的数据进行校验



import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

import java.io.Serializable;

import lombok.Data;
import org.hibernate.validator.constraints.URL;

import javax.validation.constraints.*;

/**
 * 品牌
 *
 * @author jjs
 * @email 
 * @date 2021-07-26 14:51:27
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * 品牌id
     */
    @TableId
    private Long brandId;
    /**
     * 品牌名
     */
    @NotBlank(message = "品牌名不能为空")  //至少包含一个非空字符
    private String name;
    /**
     * 品牌logo地址
     */
    @URL(message = "logo必须是一个合法的url")
    @NotBlank(message = "品牌名不能为空")
    private String logo;
    /**
     * 介绍
     */
    private String descript;
    /**
     * 显示状态[0-不显示；1-显示]
     */
    private Integer showStatus;
    /**
     * 检索首字母
     */
    @Pattern(regexp =  "^[a-zA-Z]$",message = "检索首字母必须是一个字母")
    @NotBlank(message = "检索首字母不能为空")
    private String firstLetter;
    /**
     * 排序
     */
    @Min(value = 0,message = "sort的最小值是0")
    @org.hibernate.validator.constraints.NotBlank(message = "排序不能为空" )//org.hibernate.validator.constraints下的NotBlank可以支持数值类型，javax.validation.constraints下的NotBlank是不支持数值类型的校验的
    private Integer sort;

}

其中message是校验不通过的提示语句，有默认值。

3)、对前端传递过来的参数进行限制

  @RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand,BindingResult result) {
            if(result.hasErrors()){
                Map m = new HashMap();
                result.getFieldErrors().forEach(item->{
                    //获取到校验不通过错误消息
                    String message = item.getDefaultMessage();
                    //获取到校验不通过字段名称
                    String field= item.getField();
                    m.put(field,message);

                });
                return  R.error(400,"提交的数据不合法").put("data",m);
            }
        brandService.save(brand);

        return R.ok();
    }

* 在校验的对象前添加注解@Valid打开JSR303数据校验，在校验的对象后面紧跟着BindingResult对象，用于保存校验的结构
* ！！！BindingResult必须跟在校验的对象后面！！！（如果添加了BindingResult，会将异常值存入其中，否则会直接抛出异常）

三、JSR303基本使用（分组校验）

在实体类上标注校验注解的时候，可以给groups属性进行赋值，然后在需要校验的controller类的方法中的实体类前加上@Validated注解，先附上代码再细细说明

1)、创建分组

只需要创建两个空的接口用于做标记即可，不需要有内容。

2)、实体类

@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * 品牌id
     * POSTman：{"name":"aaa","logo":"abc","brandId":1}
     */
    @NotNull(message = "修改必须定制品牌id", groups = {UpdateGroup.class})
    @Null(message = "新增不能指定id", groups = {AddGroup.class})
    @TableId
    private Long brandId;
    /**
     * 品牌名
     */
    @NotBlank(message = "品牌名必须提交", groups = {AddGroup.class, UpdateGroup.class})
    private String name;

    /**
     * 品牌logo地址 修改可以不带上logoURL
     */
    @NotBlank(groups = {AddGroup.class})
    @URL(message = "logo必须是一个合法的URL地址", groups={AddGroup.class, UpdateGroup.class})
    private String logo;
    /**
     * 介绍
     */
    private String descript;
    /**
     * 显示状态[0-不显示；1-显示]
     */
    @NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
//    @ListValue(vals = {0,1}, groups = {AddGroup.class, UpdateGroup.class, UpdateStatusGroup.class})
    private Integer showStatus;

    /**
     * 检索首字母  修改可以不带, 不管是新增还是修改都必须是一个字母
     */
    @NotEmpty(groups = {AddGroup.class})
    @Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
    private String firstLetter;
    /**
     * 排序
     */
    @NotNull(groups = {AddGroup.class})
    @Min(value = 0, message = "排序必须是一个正整数" , groups = {AddGroup.class, UpdateGroup.class})
    private Integer sort;

}

由代码不难看出，每个注解后面我都加上了分组，groups里可以添加多个.class文件，标记对应分组，例如

/**
     * 品牌id
     * POSTman：{"name":"aaa","logo":"abc","brandId":1}
     */
    @NotNull(message = "修改必须定制品牌id", groups = {UpdateGroup.class})
    @Null(message = "新增不能指定id", groups = {AddGroup.class})
    @TableId
    private Long brandId;

这段代码中，@notNull对应了当分组时UpdateGroup的时候，触发该校验，当接收到的brandId字段为空时，就会出现校验异常。@null则对应AddGroup分组。

3）、controller代码

    @RequestMapping("/save")
    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand) {
        brandService.save(brand);

        return R.ok();
    }

在需要校验的对象前面加上@Validated({AddGroup.class})表明这个对象要进行数据校验，并且仅对分组时AddGroup的分组进行校验。

特别说明:

JSR303对注释要求相对较为严格，controller类的方法中，需要校验的字段前面可以添加两种注解:

1、@Validated。

对应分组校验，并且仅当对该注解配置分组，实体类也配置分组时才起作用，如果@Validated注解不对它的参数添加分组信息，则默认不校验。一一对应关系十分严格。
2、@Valid。

对应非分组校验，仅当实体类的注释中没有配置分组时才会起作用

四、统一异常拦截器配合使用

代码：


import com.atguigu.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
 
import java.util.HashMap;
import java.util.Map;
 
/**
 * 集中处理所有异常
 */
@Slf4j
//@ResponseBody//最终以json的格式返回
//@ControllerAdvice(basePackages ="com.product.controller" ) 标准该类是统一异常处理类，basePackages标注的包都是我们设置异常处理的作用域
@RestControllerAdvice(basePackages ="com.product.controller" )//该注解等于上面两个注解结合
public class GulimallExceptionControllerAdvice {
 
    @ExceptionHandler(value = MethodArgumentNotValidException.class)//该注解用于表明这个方法要用来处理哪些异常
    public R handleVaildException(MethodArgumentNotValidException e){
            log.error("数据校验出现问题{},异常类型",e.getMessage(),e.getClass());
        BindingResult bindingResult = e.getBindingResult();//获取到数据校验的错误结果
        Map<String,String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach(fieldError->{
                errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        });
 
        return R.error(400,"校验出现问题").put("data",errorMap);
 
 
    }
    @ExceptionHandler(value = Throwable.class)
    public R handleVaildOtheException(Throwable e){
        return R.error(401,"未知异常");
 
    }
 
}

说明：

@RestControllerAdvice注解标志了该类会拦截所有异常（具体异常由@ExceptionHandler注解指定，有它注解的方法执行异常处理）并最终以JSON的数据格式返回，参数'basePackages'写明了从哪些包中拦截异常
@ExceptionHandler注解表明该方法用来拦截哪些异常，上面代码中创建了两个方法，第一个方法'handleVaildException（)'用来专门处理数据校验异常，而第二个方法handleVaildOtheException 用来处理其他所有异常
如果某个方法标记了特地的处理某个异常，当出现异常时，会由该方法处理，如果没有特定指定某个异常，则会往下跟大范围的方法中去处理，例如Throwable。（第二个方法写的较为粗略，可以根据自己想要返回的数据格式进行封装代码)