三、@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