使用 Spring Validation 优雅地进行参数校验
引言
不知道大家平时的业务开发过程中 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 优雅地校验参数的全部内容,下面重点总结一下文中提到的校验特性
内置多种常用校验注解
支持单个参数校验
结合全局异常处理自动组装校验异常
分组校验
支持递归校验
自定义校验
有道无术,术可成;有术无道,止于术
欢迎大家关注Java之道公众号
好文章,我在看❤️
使用 Spring Validation 优雅地进行参数校验相关推荐
- jsr 正则验证_使用 Bean Validation 解决业务中参数校验
痛点及现状 代码中常常见到如下代码: if (Objects.equal(0L ,repertory)){ return ApiResultMap.errorResult(-1 ,"操作数量 ...
- 企业实战之Spring拦截器《统一参数校验》
在前面的一些文章中我们有讲到,通过拦截器我们可以做很多的事情,包括接口统一的 参数校验. 登录校验.权限校验等,也可以做一些HTTP响应体写入逻辑,比如我们另一篇文章所说的<解决跨域问题> ...
- 【Spring】Spring hibernate JSR-303 Validator 自定义参数校验器
1.概述 在默认的情况下 Spring Boot 会引入关于 Hibernate Validator 机制来支持 JSR-303 验证规范:另外一方面 , 因为业务会 比较复杂,所以需要 自 定义验证 ...
- java 参数校验 优雅的,SpringBoot 如何优雅的进行参数校验
参数的合法性直接影响到程序的安全和性能,因此在进行相关操作前必须检测对象是否为null,是否为blank,是否被初始化等等. 我们先来看看SpringBoot 是如何来检验参数的. 验证总是摆在第一位 ...
- SpringBoot - 优雅的实现【参数校验】高级进阶
文章目录 Pre 概述 参数校验三部曲 Step1 搞依赖 Step2 搞参数校验的实体类 常用的校验注解 Step3 开始验证 存在的问题 使用 统一格式 + 全局异常Handler 优化 源码 P ...
- Spring Validation验证框架参数验证 @Validated 和 @Valid 的区别
参数验证 @Validated 和 @Valid 的区别 Spring Validation验证框架对参数的验证机制提供了@Validated(Spring's JSR-303 规范,是标准 JSR- ...
- Java代码简洁-validation参数校验
validation参数校验 bean validation和hibernate validator参数校验 常用注解 1.导入依赖 2.测试 3.自定义消息模板 4.分组校验 5.级联校验 6.自定 ...
- 【Spring】掌握 Spring Validation 数据校验
个人简介:Java领域新星创作者:阿里云技术博主.星级博主.专家博主:正在Java学习的路上摸爬滚打,记录学习的过程~ 个人主页:.29.的博客 学习社区:进去逛一逛~ Spring Validati ...
- SpringMVC集成Hibernate Validator进行注解式的参数校验——让代码更少、更加专注于业务逻辑
SpringMVC集成Hibernate Validator进行注解式的参数校验 --让代码更少.更加专注于业务逻辑 1 问题背景: 参数验证是一个常见的问题,例如验证用户输入的密码是否为空.邮箱是否 ...
最新文章
- 数据结构之shell排序
- 输入4个同学的姓名学号,语文数学英语信息计算平均成绩,按平均成绩高低排序输出java,c++实现
- sql server 小记——分区表(上)
- 注意设置httpclient连接数
- mongodb数据库淘汰_MongoDB 等 NoSQL 与关系型数据库相比,有什么优缺点及适用场景?...
- windows下文件共享以及通过网线在两台Windows电脑之间传数据
- 【转载】从头编写 asp.net core 2.0 web api 基础框架 (1)
- 使用transform和transition制作CSS3动画
- Linux 权限管理: 权限的概念、权限管理、文件访问权限的设置、 粘滞位
- Shell脚本监控LVS后台服务器存活状态
- 解决虎牙、斗鱼网页端P2P上传&增强虎牙、斗鱼网页端功能!
- iso镜像文件安装linux,详细解说Ubuntu iso安装镜像文件
- 三角形的几何公式大全_椰岛数学:初中数学公式大全(文末分享PDF)
- 【PHP学习】Yii2框架Gii模块使用
- 华米Amazfit GTS 2e用续航和高性价比征服外媒
- Python中Selenium模块的使用
- 计算机全能学什么,什么是全能学生本 全能学生本什么意思
- explicit的作用
- 垃圾回收与垃圾收集算法
- Template-Web
热门文章
- 华为鸿蒙车联网,华为鸿蒙上车 关于车联网的想象有多少?
- 启动mysql 1067_启动mysql遇到1067问题
- php mysql 截取字符串长度,mysql字符串截取
- cxf开发webservice服务端怎么返回固定的报文格式_Spring boot webservice怎么玩? 第277篇...
- 算法题1 大数字运算(输出时不显示前面多余的0)
- 计算机网络之数据链路层:12、CSMA/CA协议-随机访问介质访问控制
- 3-1:类与对象入门——类的引入和类的定义以及访问限定符和封装还有对面向对象的理解
- Shell生成随机uuid
- from __future__ import absolute_import的作用
- 栈应用:后缀表达式求值