SpringBoot 优雅的参数效验!
引言
不知道大家平时的业务开发过程中 controller 层的参数校验都是怎么写的?是否也存在下面这样的直接判断?
public String add(UserVO userVO) {if(userVO.getAge() == null){return "年龄不能为空";}if(userVO.getAge() > 120){return "年龄不能超过120";}if(userVO.getName().isEmpty()){return "用户名不能为空";}// 省略一堆参数校验...return "OK";
}
业务代码还没开始写呢,光参数校验就写了一堆判断。这样写虽然没什么错,但是给人的感觉就是:不优雅,不专业。
其实Spring
框架已经给我们封装了一套校验组件:validation。其特点是简单易用,自由度高。接下来咱使用springboot-2.3.1.RELEASE
搭建一个简单的 Web 工程,给大家一步一步讲解在开发过程中如何优雅地做参数校验。
1. 环境搭建
从springboot-2.3
开始,校验包被独立成了一个starter
组件,所以需要引入如下依赖:
<!--校验组件-->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!--web组件-->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
而springboot-2.3
之前的版本只需要引入 web 依赖就可以了。
2.小试牛刀
参数校验非常简单,首先在待校验字段上增加校验规则注解
public class UserVO {@NotNull(message = "age 不能为空")private Integer age;
}
然后在controller
方法中添加@Validated
和用于接收错误信息的BindingResult
就可以了,于是有了第一版:
public String add1(@Validated UserVO userVO, BindingResult result) {List<FieldError> fieldErrors = result.getFieldErrors();if(!fieldErrors.isEmpty()){return fieldErrors.get(0).getDefaultMessage();}return "OK";
}
通过工具(postman)去请求接口,如果参数不符合规则,会将相应的 message
信息返回:
age 不能为空
内置的校验注解有很多,罗列如下:
注解 | 校验功能 |
---|---|
@AssertFalse | 必须是false |
@AssertTrue | 必须是true |
@DecimalMax | 小于等于给定的值 |
@DecimalMin | 大于等于给定的值 |
@Digits | 可设定最大整数位数和最大小数位数 |
校验是否符合Email格式 | |
@Future | 必须是将来的时间 |
@FutureOrPresent | 当前或将来时间 |
@Max | 最大值 |
@Min | 最小值 |
@Negative | 负数(不包括0) |
@NegativeOrZero | 负数或0 |
@NotBlank | 不为null并且包含至少一个非空白字符 |
@NotEmpty | 不为null并且不为空 |
@NotNull | 不为null |
@Null | 为null |
@Past | 必须是过去的时间 |
@PastOrPresent | 必须是过去的时间,包含现在 |
@PositiveOrZero | 正数或0 |
@Size | 校验容器的元素个数 |
3. 规范返回值
待校验参数多了之后我们希望一次返回所有校验失败信息,方便接口调用方进行调整,这就需要统一返回格式,常见的就是封装一个结果类。
public class ResultInfo<T>{private Integer status;private String message;private T response;// 省略其他代码...
}
改造一下controller
方法,第二版:
public ResultInfo add2(@Validated UserVO userVO, BindingResult result) {List<FieldError> fieldErrors = result.getFieldErrors();List<String> collect = fieldErrors.stream().map(o -> o.getDefaultMessage()).collect(Collectors.toList());return new ResultInfo<>().success(400,"请求参数错误",collect);
}
请求该方法时,所有的错误参数就都返回了:
{"status": 400,"message": "请求参数错误","response": ["年龄必须在[1,120]之间","bg 字段的整数位最多为3位,小数位最多为1位","name 不能为空","email 格式错误"]
}
4. 全局异常处理
每个Controller
方法中如果都写一遍BindingResult
信息的处理,使用起来还是很繁琐。可以通过全局异常处理的方式统一处理校验异常。
当我们写了@validated
注解,不写BindingResult
的时候,Spring 就会抛出异常。由此,可以写一个全局异常处理类来统一处理这种校验异常,从而免去重复组织异常信息的代码。
全局异常处理类只需要在类上标注@RestControllerAdvice
,并在处理相应异常的方法上使用@ExceptionHandler
注解,写明处理哪个异常即可。
@RestControllerAdvice
public class GlobalControllerAdvice {private static final String BAD_REQUEST_MSG = "客户端请求参数错误";// <1> 处理 form data方式调用接口校验失败抛出的异常 @ExceptionHandler(BindException.class)public ResultInfo bindExceptionHandler(BindException e) {List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();List<String> collect = fieldErrors.stream().map(o -> o.getDefaultMessage()).collect(Collectors.toList());return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);}// <2> 处理 json 请求体调用接口校验失败抛出的异常 @ExceptionHandler(MethodArgumentNotValidException.class)public ResultInfo methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();List<String> collect = fieldErrors.stream().map(o -> o.getDefaultMessage()).collect(Collectors.toList());return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);}// <3> 处理单个参数校验失败抛出的异常@ExceptionHandler(ConstraintViolationException.class)public ResultInfo constraintViolationExceptionHandler(ConstraintViolationException e) {Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();List<String> collect = constraintViolations.stream().map(o -> o.getMessage()).collect(Collectors.toList());return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);}}
事实上,在全局异常处理类中,我们可以写多个异常处理方法,我总结了三种参数校验时可能引发的异常:
使用form data方式调用接口,校验异常抛出 BindException
使用 json 请求体调用接口,校验异常抛出 MethodArgumentNotValidException
单个参数校验异常抛出ConstraintViolationException
注:单个参数校验需要在参数上增加校验注解,并在类上标注
@Validated
。
全局异常处理类可以添加各种需要处理的异常,比如添加一个对Exception.class
的异常处理,当所有ExceptionHandler
都无法处理时,由其记录异常信息,并返回友好提示。
5.分组校验
如果同一个参数,需要在不同场景下应用不同的校验规则,就需要用到分组校验了。比如:新注册用户还没起名字,我们允许name
字段为空,但是不允许将名字更新为空字符。
分组校验有三个步骤:
定义一个分组类(或接口)
在校验注解上添加
groups
属性指定分组Controller
方法的@Validated
注解添加分组类
public interface Update extends Default{
}
public class UserVO {@NotBlank(message = "name 不能为空",groups = Update.class)private String name;// 省略其他代码...
}
@PostMapping("update")
public ResultInfo update(@Validated({Update.class}) UserVO userVO) {return new ResultInfo().success(userVO);
}
细心的同学可能已经注意到,自定义的Update
分组接口继承了Default
接口。校验注解(如:@NotBlank
)和@validated
默认都属于Default.class
分组,这一点在javax.validation.groups.Default
注释中有说明
/*** Default Jakarta Bean Validation group.* <p>* Unless a list of groups is explicitly defined:* <ul>* <li>constraints belong to the {@code Default} group</li>* <li>validation applies to the {@code Default} group</li>* </ul>* Most structural constraints should belong to the default group.** @author Emmanuel Bernard*/
public interface Default {
}
在编写Update
分组接口时,如果继承了Default
,下面两个写法就是等效的:
@Validated({Update.class})
@Validated({Update.class,Default.class})
请求一下/update
接口可以看到,不仅校验了name
字段,也校验了其他默认属于Default.class
分组的字段
{"status": 400,"message": "客户端请求参数错误","response": ["name 不能为空","age 不能为空","email 不能为空"]
}
如果Update
不继承Default
,@Validated({Update.class})
就只会校验属于Update.class
分组的参数字段,修改后再次请求该接口得到如下结果,可以看到, 其他字段没有参与校验:
{"status": 400,"message": "客户端请求参数错误","response": ["name 不能为空"]
}
6.递归校验
如果 UserVO 类中增加一个 OrderVO 类的属性,而 OrderVO 中的属性也需要校验,就用到递归校验了,只要在相应属性上增加@Valid
注解即可实现(对于集合同样适用)
OrderVO类如下
public class OrderVO {@NotNullprivate Long id;@NotBlank(message = "itemName 不能为空")private String itemName;// 省略其他代码...
}
在 UserVO 类中增加一个 OrderVO 类型的属性
public class UserVO {@NotBlank(message = "name 不能为空",groups = Update.class)private String name;//需要递归校验的OrderVO@Validprivate OrderVO orderVO;// 省略其他代码...
}
调用请求验证如下:
7. 自定义校验
Spring 的 validation 为我们提供了这么多特性,几乎可以满足日常开发中绝大多数参数校验场景了。但是,一个好的框架一定是方便扩展的。有了扩展能力,就能应对更多复杂的业务场景,毕竟在开发过程中,唯一不变的就是变化本身。
Spring Validation允许用户自定义校验,实现很简单,分两步:
自定义校验注解
编写校验者类
代码也很简单,结合注释你一看就能懂
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {HaveNoBlankValidator.class})// 标明由哪个类执行校验逻辑
public @interface HaveNoBlank {// 校验出错时默认返回的消息String message() default "字符串中不能含有空格";Class<?>[] groups() default { };Class<? extends Payload>[] payload() default { };/*** 同一个元素上指定多个该注解时使用*/@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })@Retention(RUNTIME)@Documentedpublic @interface List {NotBlank[] value();}
}
public class HaveNoBlankValidator implements ConstraintValidator<HaveNoBlank, String> {@Overridepublic boolean isValid(String value, ConstraintValidatorContext context) {// null 不做检验if (value == null) {return true;}if (value.contains(" ")) {// 校验失败return false;}// 校验成功return true;}
}
自定义校验注解使用起来和内置注解无异,在需要的字段上添加相应注解即可,同学们可以自行验证
回顾
以上就是如何使用 Spring Validation 优雅地校验参数的全部内容,下面重点总结一下文中提到的校验特性
内置多种常用校验注解
支持单个参数校验
结合全局异常处理自动组装校验异常
分组校验
支持递归校验
自定义校验
参考资料
[1]
Java课代表的 GitHub: https://github.com/zhengxl5566/springboot-demo
往期推荐
SpringBoot 中的 3 种条件装配!
批处理框架 Spring Batch 这么强,你会用吗?
厉害了,Spring中bean的12种定义方法!
SpringBoot 优雅的参数效验!相关推荐
- springboot 优雅的参数校验_SpringBoot 2.x 开发案例之优雅的校验参数
前言 参数如何校验?撸主很久很久之前的项目都是在前端页面一个个 if else 的,后来就用了一系列的前端校验框架,比如 layui iview 等等,几个样式属性就可以轻松搞定,的确是美滋滋. 后端 ...
- Springboot优雅的参数校验(一)
目录 前言 1. 依赖引入 2. 参数形式 3. 常用到的约束注解 4. 参数基础校验 4.1 @RequestBody参数 4.2 @RequestParam参数/@PathVariable参数 4 ...
- SpringBoot 中使用 @Valid 注解 + Exception 全局处理器优雅处理参数验证
作者:超级小豆丁 http://www.mydlq.club/article/49/ 目录 一.为什么使用 @Valid 来验证参数 二.@Valid 注解的作用 三.@Valid 的相关注解 四.使 ...
- SpringBoot从入门到精通教程(二十七)- @Valid注解用法详解+全局处理器Exception优雅处理参数验证用法
问题痛点 用 Spring 框架写代码时,写接口类,相信大家对该类的写法非常熟悉.在写接口时要写效验请求参数逻辑,这时候我们会常用做法是写大量的 if 与 if else 类似这样的代码来做判断,如下 ...
- SpringBoot - 优雅的实现【参数分组校验】高级进阶
文章目录 Pre 需求 实现三部曲 Step1 定义分组接口 Step2 给参数分配分组 Step3 指定分组 Step4 验证 源码 Pre SpringBoot - 优雅的实现[参数校验]高级进阶 ...
- SpringBoot - 优雅的实现【自定义参数校验】高级进阶
文章目录 Pre 概述 三部曲 Step1 搞自定义注解 Step2 搞校验逻辑 Step3 使用 Step4 验证 附 int 类型的判断 源码 Pre SpringBoot - 优雅的实现[参数校 ...
- SpringBoot - 优雅的实现【参数校验】高级进阶
文章目录 Pre 概述 参数校验三部曲 Step1 搞依赖 Step2 搞参数校验的实体类 常用的校验注解 Step3 开始验证 存在的问题 使用 统一格式 + 全局异常Handler 优化 源码 P ...
- SpringBoot Validation优雅的参数校验
前言:大多数项目中都需要后台对传过来的对象进行校验,所以经常需要写一些字段校验的代码,比如特殊字段非空.字段长度限制和邮箱格式验证等等.之前我们可能都是使用if-else-,写这些与业务逻辑关系不大的 ...
- SpringBoot优雅编码之:Lombok加持
概述 Lombok 通过提供简单的语法注解形式来帮助简化消除一些必须有但显得很臃肿的 java 代码.典型的是对于 POJO对象的简化(如自动帮我们生成Setter和Getter等),有了Lombok ...
最新文章
- Java8新特性-接口中的静态方法与默认方法
- 自动化运维工具Saltstack详细介绍
- ubuntu14.04的键盘失灵解决方案
- Reverse for '**' with arguments '('',)' not found. 1 pattern(s) tried(topic_id与topic.id)
- 《Android游戏开发详解》一3.5 继承
- 网管必须熟悉的几个网络DOS命令
- 无法获得锁 /var/lib/dpkg/lock - open (11: 资源暂时不可用) ...ubuntu 18.04 安装vim遇到的错误...
- 小白错误三——Collider存在,刚体存在情况下,不能触发OnCollisionEnter函数
- python : sha256 、ripemd160
- 网络工程师--网络规划和设计案例分析(5)
- 利用VMM建立基于事务的层次化验证平台
- 如何运营出一个有吸引力的微信公众号?
- 2021-02-05仅供自己参考:多态使用
- 求逆序数-第12届蓝桥杯Scratch省赛3真题第3题
- Qt编写地图综合应用60-覆盖物坐标和搜索
- Java实现LDAP认证(上)
- 服务细分--服务电商的发展趋势与未来!
- CSS让子容器超出父元素(子容器悬浮在父容器效果)
- 信号坐骑之导引型传输介质
- 张学友十大粤语十大国语金曲赏析
热门文章
- 苹果7手机严重卡顿_苹果手机仅配备4GB运存都不会卡顿,安卓系统为何要更多内存?...
- 介绍一下再Apache下的Tomcat负载均衡的一些使用问题
- 饶军:Apache Kafka的过去,现在,和未来
- 用户反馈:对 Rafy 开发框架的一些个人建议
- java实现的简单程序登录界面
- SQL随机生成6位数字
- JAVA反射系列之Field,java.lang.reflect.Field使用获取方法。
- grunt使用小记之uglify:最全的uglify使用DEMO
- 教你如何去淘便宜机票
- Exposing Windows Forms Controls as ActiveX controls