SpringBoot如何实现优雅的参数校验
ztj100 2025-05-11 19:46 25 浏览 0 评论
平常业务中肯定少不了校验,如果我们把大量的校验代码夹杂到业务中,肯定是不优雅的,对于一些简单的校验,我们可以使用java为我们提供的api进行处理,同时对于一些较为复杂的关联校验,spring也为我们提供了一些处理方式。更加复杂校验的话,只能进行代码逻辑处理了。
@Valid
Java定义的一套基于注解的数据校验规范,比如@Null、@NotNull、@Pattern等,它们位于
javax.validation.constraints这个包下,它是JSR 303规范的一部分,主要用于Hibernate Validation等场景。
@Valid注解是支持嵌套验证,同时可以配合BindingResult可以直接提供参数验证结果。
@Valid注解可以用在方法、构造函数、方法参数和成员属性上(方法, 构造器, 参数,字段, 泛型)
@Validated
Spring框架特有的注解,属于Spring的一部分,也是JSR 303的一个变种。在JSR 303基础上增加了一些其他校验注解,如 @NotBlank、@NotEmpty、@Length等,它们位于
org.hibernate.validator.constraints这个包下。
@Validated注解在
org.springframework.validation.annotation包下。
@Validated注解对@Valid进行了二次封装,在使用上并没有区别。支持分组校验,不支持嵌套验证。
@Validated注解可以用在类型、方法和方法参数上(类, 方法, 参数)。但不能用于成员属性。
依赖
hibernate validator框架已经集成在 spring-boot-starter-web中,所以无需再添加其他依赖。如果不是Spring Boot项目,需要添加如下依赖。
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.9.Final</version>
</dependency>
BindingResult
BindingResult用在实体类校验信息返回结果绑定。
该类作为方法入参,要写在实体对象后面。
@PostMapping(value = "/test")
public String test(@RequestBody @Validated ValidTest validTest, BindingResult bindingResult, HttpServletResponse httpServletResponse){
if (bindingResult.hasErrors()) {
List<ObjectError> allErrors = bindingResult.getAllErrors();
for (ObjectError allError : allErrors) {
return allError.getDefaultMessage();
}
}
return "成功";
}
@Valid中的常用注解
注解 | 说明 |
@AssertFalse | 只能用在boolean类型的字段上,验证 boolean类型值是否为 false |
@AssertTrue | 只能用在boolean类型的字段上,验证 boolean 类型值是否为 true |
@DecimalMax(value) | 支持字符串和任意数字类型,验证数字的大小是否小于等于指定的值,小数存在精度,22=22.00 |
@DecimalMin(value) | 支持字符串和任意数字类型,验证数字的大小是否大于等于指定的值,小数存在精度 |
@Digits(integer, fraction) | 验证数字是否符合指定格式。integer代表整数位置的最大位数;fraction代表小数位置的最大数位 |
验证字符串是否符合电子邮件地址的格式 | |
@Future | 验证一个日期或时间是否在当前时间之后,支持Date、Calendar、Instant、LocalDate、LocalDateTime、LocalTime、MonthDay、OffsetDateTime、 OffsetTime、Year、YearMonth、ZonedDateTime、HijrahDate、JapaneseDate、MinguoDate、 ThaiBuddhistDate |
@past | 支持Date、Calendar、Instant、LocalDate、LocalDateTime、LocalTime、MonthDay、OffsetDateTime、OffsetTime、Year、YearMonth、ZonedDateTime、HijrahDate、JapaneseDate、MinguoDate、ThaiBuddhistDate |
@PastOrPresent | 验证一个日期或时间是否在当前时间之前或等于当前时间 |
@FutureOrPresent | 验证一个日期或时间是否在当前时间之后或等于当前时间 |
@Max(value) | 验证数字的大小是否小于等于指定的值 |
@Min(value) | 验证数字的大小是否大于等于指定的值 |
@Negative | 验证数字是否是负整数,0无效 |
@NegativeOrZero | 验证数字是否是负整数 |
@NotBlank | 验证字符串不能为空null或"",只能用于字符串验证 |
@NotEmpty | 验证对象不得为空,可用于Map和数组 |
@NotNull | 验证对象不为 null |
@Null | 验证对象必须为 null |
@Pattern(value) | 验证字符串是否符合正则表达式的规则 |
@Positive | 验证数字是否是正整数,0无效 |
@PositiveOrZero | 验证数字是否是正整数 |
@Size(max, min) | 验证对象(字符串、集合、数组)长度是否在指定范围之内 |
@Digits(integer, fraction)举例:
//最大支持99.99,因为整数位最多两位,小数位最多两位
@Digits(integer = 2,fraction = 2)
private Integer name;
@Validate中的常用注解
注解 | 说明 |
@Range | @Max+@Min的范围 |
@Length | 字符串长度在指定范围内 |
@DecimalMin(value) | 支持字符串和任意数字类型,验证数字的大小是否大于等于指定的值,小数存在精度 |
自定义校验
分组校验
这一篇文章里写的是我们动态的指定那些校验生效
《使用Hibernate的validator做多字段联合校验》
实际上我们可以在校验入库处指定哪个分组的校验生效,在每一个校验注解中,都有一个Class<?>[] groups() default { }字段,这个字段不写呢默认就是Default分组,但是我们也可以对这些校验指定分组,然后在校验入口处@Validated注解中指定校验的分组。
使用
- 单参数校验
@RestController
//
@Validated
public class ValidController {
@GetMapping(value = "/test1")
public String test(@NotBlank(message = "name字段不能为空") String name){
return "success";
}
}
- 多参数校验
被校验参数实体类
public class ValidTest {
@Length
private String name;
//注意这里要使用@Valid而不是@Validated
//@Validated不支持嵌套校验
@Valid
private Inner inner;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public static class Inner{
@NotBlank(message = "地址不能为空!")
private String address;
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
}
}
@RestController
public class ValidController {
@PostMapping(value = "/test")
//这里使用@Validated或者@Valid都可以
public String test(@RequestBody @Validated ValidTest validTest, BindingResult bindingResult, HttpServletResponse httpServletResponse){
httpServletResponse.setHeader("content-type","application/json;charset=UTF-8");
if (bindingResult.hasErrors()) {
List<ObjectError> allErrors = bindingResult.getAllErrors();
for (ObjectError allError : allErrors) {
return allError.getDefaultMessage();
}
}
return "success";
}
}
- 分组校验
//新建新增分组
public interface Add {
}
//新建变更分组
public interface Update {
}
被校验参数实体类
public class ValidTest {
//只有新增分组的时候校验
@Length(groups = Add.class,max = 3,message = "name length is too long")
private String name;
//只有变更分组的时候校验
@NotBlank(message = "path is blank!",groups = Update.class)
private String path;
@Valid
private Inner inner;
public String getPath() {
return path;
}
public void setPath(String path) {
this.path = path;
}
public Inner getInner() {
return inner;
}
public void setInner(Inner inner) {
this.inner = inner;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public static class Inner{
//只有变更分组的时候校验
@NotBlank(message = "address is blank!",groups = Update.class)
private String address;
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
}
}
@RestController
public class ValidController {
@PostMapping(value = "/group")
//增加变更分组
public String group(@RequestBody @Validated(Update.class) ValidTest validTest, BindingResult bindingResult, HttpServletResponse httpServletResponse){
httpServletResponse.setHeader("content-type","application/json;charset=UTF-8");
if (bindingResult.hasErrors()) {
List<ObjectError> allErrors = bindingResult.getAllErrors();
for (ObjectError allError : allErrors) {
return allError.getDefaultMessage();
}
}
return "success";
}
}
- 统一字段多个校验
public class ValidTest {
//大部分注解都是支持这么做的,在同一个字段上使用集合进行多次校验
@Length.List(value = {
@Length(min = 1,message = "name length is too short"),
@Length(max = 4,message = "name length is too long")
})
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
- 组序列
默认情况下 不同级别的约束验证是无序的,但是在一些情况下,顺序验证却是很重要。一个组可以定义为其他组的序列,使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候,如果序列前边的组验证失败,则后面的组将不再给予验证。
举个例子,这三个参数校验,我想先校验不能为空,如果再校验正则信息,一般情况下,校验是无序的,可能会先校验格式错误,在校验不能为空,这是不符合规定的,那么我们该怎么办呢?
//使用@GroupSequence定义分组顺序,校验执行顺序先执行Default分组,再执行Order1分组
@GroupSequence({Default.class,Order1.class})
public interface IGroup {
}
@Pattern(regexp = "^[0-9]+(\\.[0-9]{1,2})?#34;,message = "视联网能力收入金额(含税)(万元)格式错误",groups = Order1.class)
@NotBlank(message = "视联网能力收入金额(含税)(万元) 不能为空")
private String videoNetInfoAmount;
@Pattern(regexp = "^[0-9]+(\\.[0-9]{1,2})?#34;,message = "视联网能力收入占比 格式错误",groups = Order1.class)
@NotBlank(message = "视联网能力收入占比 不能为空")
private String incomeRate;
@Pattern(regexp = "^[0-9]{1,12}#34;,message = "连接数 格式错误",groups = Order1.class)
@NotBlank(message = "连接数 不能为空")
private String connectionsNum;
这样的话,会先校验Default分组的,校验通过以后,再校验Order1分组的。
获取校验器
如果我们不想使用注解@Valid或者@Validate进行校验的话,可以使用Validator进行编程式校验。
- spring
//使用spring注入一个Validator
@Bean
public Validator validator() {
LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
factoryBean.setProviderClass(HibernateValidator.class);
factoryBean.afterPropertiesSet();
return factoryBean.getValidator();
}
@Autowired
private Validator validator;
//然后进行校验,默认分组下可以使用Default.class分组
validator.validate(videoNetInfo, IGroup.class);
- 自定义
public class ValidationUtils {
//创建一个校验器
private final static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
public static <T> void validate(T t) {
validate(t,Default.class);
}
public static <T> void validate(T t,Class<?> clazz) {
if (t != null) {
Set<ConstraintViolation<T>> validationSet = validator.validate(t, clazz);
if (validationSet != null && validationSet.size() > 0) {
ConstraintViolation<T> violation = validationSet.iterator().next();
String errorMsg = "[" + violation.getPropertyPath() + "]" + violation.getMessage();
throw new BusinessException(BusiOpportunityEnum.BUSI_OPPORTUNITY_ENUM_99.getCode(), errorMsg);
}
}
}
}
备注:
org.hibernate.validator.internal.metadata.core.ConstraintHelper
相关推荐
- 人生苦短,我要在VSCode里面用Python
-
轻沉发自浅度寺量子位出品|公众号QbitAI在程序员圈子里,VisualStudioCode(以下简称VSCode)可以说是目前最火的代码编辑器之一了。它是微软出品的一款可扩展的轻量...
- 亲测可用:Pycharm2019.3专业版永久激活教程
-
概述随着2020年的到来,又有一批Pycharm的激活码到期了,各位同仁估计也是在到处搜索激活方案,在这里,笔者为大家收录了一个永久激活的方案,亲测可用,欢迎下载尝试:免责声明本项目只做个人学习研究之...
- Python新手入门很简单(python教程入门)
-
我之前学习python走过很多的歧途,自学永远都是瞎猫碰死耗子一样,毫无头绪。后来心里一直都有一个做头条知识分享的梦,希望自己能够帮助曾经类似自己的人,于是我来了,每天更新5篇Python文章,喜欢的...
- Pycharm的设置和基本使用(pycharm运行设置)
-
这篇文章,主要是针对刚开始学习python语言,不怎么会使用pycharm的童鞋们;我来带领大家详细了解下pycharm页面及常用的一些功能,让大家能通过此篇文章能快速的开始编写python代码。一...
- 依旧是25年最拔尖的PyTorch实用教程!堪比付费级内容!
-
我真的想知道作者到底咋把PyTorch教程整得这么牛的啊?明明在内容上已经足以成为付费教材了,但作者偏要免费开源给大家学习!...
- 手把手教你 在Pytorch框架上部署和测试关键点人脸检测项目DBFace
-
这期教向大家介绍仅仅1.3M的轻量级高精度的关键点人脸检测模型DBFace,并手把手教你如何在自己的电脑端进行部署和测试运行,运行时bug解决。01.前言前段时间DBFace人脸检测库横空出世,...
- 进入Python的世界02外篇-Pycharm配置Pyqt6
-
为什么这样配置,要开发带UI的python也只能这样了,安装过程如下:一安装工具打开终端:pipinstallPyQt6PyQt6-tools二打开设置并汉化点击plugin,安装汉化插件,...
- vs code如何配置使用Anaconda(vscode调用anaconda库)
-
上一篇文章中(Anaconda使用完全指南),我们能介绍了Anaconda的安装和使用,以及如何在pycharm中配置Anaconda。本篇,将继续介绍在vscode中配置conda...
- pycharm中conda解释器无法配置(pycharm配置anaconda解释器)
-
之前用的好好的pycharm正常配置解释器突然不能用了?可以显示有这个环境然后确认后可以conda正在配置解释器,但是进度条结束后还是不成功!!试过了pycharm重启,pycharm重装,anaco...
- Volta:跨平台开发者的福音,统一前端js工具链从未如此简单!
-
我们都知道现在已经进入了Rust时代,不仅很多终端常用的工具都被rust重写了,而且现在很多前端工具也开始被Rust接手了,这不,现在就出现了一款JS工具管理工具,有了它,你可以管理多版本的js工具,...
- 开发者的福音,ElectronEgg: 新一代桌面应用开发框架
-
今天给大家介绍一个开源项目electron-egg。如果你是一个JS的前端开发人员,以前面对这项任务桌面应用开发在时,可能会感到无从下手,甚至觉得这是一项困难的挑战。ElectronEgg的出现,它能...
- 超强经得起考验的低代码开发平台Frappe
-
#挑战30天在头条写日记#开始进行管理软件的开发来讲,如果从头做起不是不可以,但选择一款免费的且经得起时间考验的低代码开发平台是非常有必要的,将大幅提升代码的质量、加快开发的效率、以及提高程序的扩展性...
- 一文带你搞懂Vue3 底层源码(vue3核心源码解析)
-
作者:妹红大大转发链接:https://mp.weixin.qq.com/s/D_PRIMAD6i225Pn-a_lzPA前言vue3出来有一段时间了。今天正式开始记录一下梗vue3.0.0-be...
- 基于小程序 DSL(微信、支付宝)的,可扩展的多端研发框架
-
Mor(发音为/mr/,类似more),是饿了么开发的一款基于小程序DSL的,可扩展的多端研发框架,使用小程序原生DSL构建,使用者只需书写一套(微信或支付宝)小程序,就可以通过Mor...
你 发表评论:
欢迎- 一周热门
- 最近发表
-
- 人生苦短,我要在VSCode里面用Python
- 亲测可用:Pycharm2019.3专业版永久激活教程
- Python新手入门很简单(python教程入门)
- Pycharm的设置和基本使用(pycharm运行设置)
- 依旧是25年最拔尖的PyTorch实用教程!堪比付费级内容!
- 手把手教你 在Pytorch框架上部署和测试关键点人脸检测项目DBFace
- 进入Python的世界02外篇-Pycharm配置Pyqt6
- vs code如何配置使用Anaconda(vscode调用anaconda库)
- pycharm中conda解释器无法配置(pycharm配置anaconda解释器)
- Volta:跨平台开发者的福音,统一前端js工具链从未如此简单!
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)
- vmware17pro最新密钥 (34)
- mysql单表最大数据量 (35)