SpringBoot 巧用全局处理器，优雅的解决参数校验

目录

一、为什么使用 @Valid 来验证参数

二、@Valid 注解的作用

三、@Valid 的相关注解

四、使用 @Valid 进行参数效验步骤

• 实体类中添加 @Valid 相关注解

• 接口类中添加 @Valid 注解

• 全局异常处理类中处理 @Valid 抛出的异常

五、SpringBoot 中使用 @Valid 示例

• Maven 引入相关依赖

• 自定义个异常类

• 自定义响应枚举类

• 自定义响应对象类

• 自定义实体类中添加 @Valid 相关注解

• Controller 中添加 @Valid 注解

• 全局异常处理

• 启动类

• 示例测试

---

相关地址：

Spring Servlet 文档：https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/web/servlet

示例项目 Github：https://github.com/my-dlq/blog-example/tree/master/springboot/springboot-filter-example

系统环境：

Jdk 版本：jdk 8

SpringBoot 版本：2.2.1.RELEASE

一、为什么使用 @Valid 来验证参数

在平常通过 Spring 框架写代码时候，会经常写接口类，相信大家对该类的写法非常熟悉。在写接口时经常要写效验请求参数逻辑，这时候我们会常用做法是写大量的 if 与 if else 类似这样的代码来做判断，如下：

@RestController  
public class TestController {  
  
    @PostMapping("/user")  
    public String addUserInfo(@RequestBody User user) {  
        if (user.getName() == null || "".equals(user.getName()) {  
            ......  
        } else if(user.getSex() == null || "".equals(user.getSex())) {  
            ......  
        } else if(user.getUsername() == null || "".equals(user.getUsername())) {  
            ......  
        } else {  
            ......  
        }  
        ......  
    }  
  
}  

这样的代码如果按正常代码逻辑来说，是没有什么问题的，不过按优雅来说，简直糟糕透了。不仅不优雅，而且如果存在大量的验证逻辑，这会使代码看起来乱糟糟，大大降低代码可读性，那么有没有更好的方法能够简化这个过程呢？

答案当然是有，推荐的是使用 @Valid 注解来帮助我们简化验证逻辑。

二、@Valid 注解的作用

注解 @Valid 的主要作用是用于数据效验，可以在定义的实体中的属性上，添加不同的注解来完成不同的校验规则，而在接口类中的接收数据参数中添加 @valid 注解，这时你的实体将会开启一个校验的功能。

三、@Valid 的相关注解

下面是 @Valid 相关的注解，在实体类中不同的属性上添加不同的注解，就能实现不同数据的效验功能。

四、使用 @Valid 进行参数效验步骤

整个过程如下图所示，用户访问接口，然后进行参数效验，因为 @Valid 不支持平面的参数效验（直接写在参数中字段的效验）所以基于 GET 请求的参数还是按照原先方式进行效验，而 POST 则可以以实体对象为参数，可以使用 @Valid 方式进行效验。如果效验通过，则进入业务逻辑，否则抛出异常，交由全局异常处理器进行处理。

 

1、实体类中添加 @Valid 相关注解

使用 @Valid 相关注解非常简单，只需要在参数的实体类中属性上面添加如 @NotBlank、@Max、@Min 等注解来对该字段进限制，如下：

User：

public class User {  
    @NotBlank(message = "姓名不为空")  
    private String username;  
    @NotBlank(message = "密码不为空")  
    private String password;  
}  

如果是嵌套的实体对象，则需要在最外层属性上添加 @Valid 注解：

User：

public class User {  
    @NotBlank(message = "姓名不为空")  
    private String username;  
    @NotBlank(message = &#