Spring Boot 项目中参数校验和异常拦截

小鱼儿 2023-09-25 19:50 86阅读 0赞

在`Spirng Boot`项目中校验前端请求参数，高效易维护的手段推荐使用`@Valid` 和 `@Validated`注解，开发时应当尽量避免使用一大堆`if else`对请求参数一个个判断校验。

## 一、`@Valid` 和 `@Validated` 对比 ##

<table> 
 <thead> 
  <tr> 
   <th>对比项</th> 
   <th><code>@Valid</code></th> 
   <th><code>@Validated</code></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>提供方</td> 
   <td>JSR-303规范，简单理解就是Java EE中定义的一套Java Bean校验规范</td> 
   <td>Spring，可以理解成是对JSR-303规范规范的二次封装</td> 
  </tr> 
  <tr> 
   <td>包路径</td> 
   <td><code>javax.validation</code></td> 
   <td><code>org.springframework.validation.annotation</code></td> 
  </tr> 
  <tr> 
   <td>标注位置</td> 
   <td>方法、对象属性、 构造方法、 参数</td> 
   <td>类、方法、参数</td> 
  </tr> 
  <tr> 
   <td>支持分组</td> 
   <td>不支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>支持嵌套</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
 </tbody> 
</table>

### 1. 关于Jar包和常用注解 ###

#### （1）@Valid ####

在 `jakarta.validation-api.jar` 中，它是一套标注的JSR-303规范的实现，主要有以下注解：

![format_png][]

#### （2）@Validated ####

在 `Spring Boot`项目中主要是依赖 `hibernate-validator.jar`，除了提供了JSR-303的规范，还扩展了一些注解，如下图所示：

![format_png 1][]

所以在 `Spring Boot` 项目里面引入 `spring-boot-starter-validation` ，就会自动引入 `hibernate-validator` 的Jar包，[hibernate-validator 官方文档。][hibernate-validator]

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
    复制代码

## 二、`@Valid` 和 `@Validated` 使用技巧 ##

### 1. 前端使用JSON串方式提交参数 ###

`Content-Type : application/json`，这种方式后端接口可以直接使用 `Java Bean` 对象来接受请求入参。

#### 1.1 单个属性校验 ####

import lombok.Getter;
    import lombok.Setter;
    
    import javax.validation.constraints.NotEmpty;
    import java.io.Serializable;
    
    @Getter
    @Setter
    public class ParamBody implements Serializable {
        @NotEmpty(message = "hour不能空")
        private String hour;
    }    
    复制代码

![format_png 2][]

我们使用 `@Validated` 来校验参数值，`@RequestBody` 接受JSON串参数。

#### 1.2 嵌套属性校验 ####

import lombok.Getter;
    import lombok.Setter;
    
    import javax.validation.Valid;
    import javax.validation.constraints.NotEmpty;
    import javax.validation.constraints.NotNull;
    import java.io.Serializable;
    import java.util.List;
    
    @Getter
    @Setter
    public class ParamBody implements Serializable {
    
        @Valid
        @NotNull(message = "用户信息不能为空")
        private User user;
    
        @NotEmpty(message = "hour不能空")
        private String hour;
    }
    复制代码

import lombok.Getter;
    import lombok.Setter;
    
    import javax.validation.constraints.NotEmpty;
    import javax.validation.constraints.Size;
    import java.io.Serializable;
    
    @Getter
    @Setter
    public class User implements Serializable {
    
        @NotEmpty(message = "用户名称不能为空")
        @Size(message = "用户名称不能超过 {max} 个字符", max = 10)
        private String username;
    }
    复制代码

![format_png 3][]

此时的嵌套意思就是校验 `ParamBody`时也要对`User`的所有属性进行校验，***实现嵌套校验注意以下几点***：

*  对要校验的嵌套属性必须使用 `@Valid` 注解标准
 *  ***被嵌套的对象，也就是案例里的 `User` 对象内部属性校验时注解请使用 `javax.validation.constraints` 包下的注解，不要使用 `org.hibernate.validator.constraints`包下的注解***，有时候会导致校验失效！！！

[format_png]: https://img-blog.csdnimg.cn/img_convert/d8278caf17be811a446b4ef02a101afb.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/3aa5a7136afca8bd980185898366a047.webp?x-oss-process=image/format,png
[hibernate-validator]: https://link.juejin.cn/?target=https%3A%2F%2Fdocs.jboss.org%2Fhibernate%2Fstable%2Fvalidator%2Freference%2Fen-US%2Fhtml_single%2F%23validator-gettingstarted
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/31b655307fa5ecc0821b3578e83d8aca.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/63b0928cd8c504cf8d1f5bac7cc62b41.webp?x-oss-process=image/format,png