SpringBoot如何实现优雅的参数校验
ztj100 2025-05-11 19:46 5 浏览 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
- 上一篇:Java中的空指针怎么处理?
- 已经是最后一篇了
相关推荐
-
- SpringBoot如何实现优雅的参数校验
-
平常业务中肯定少不了校验,如果我们把大量的校验代码夹杂到业务中,肯定是不优雅的,对于一些简单的校验,我们可以使用java为我们提供的api进行处理,同时对于一些...
-
2025-05-11 19:46 ztj100
- Java中的空指针怎么处理?
-
#暑期创作大赛#Java程序员工作中遇到最多的错误就是空指针异常,无论你多么细心,一不留神就从代码的某个地方冒出NullPointerException,令人头疼。...
- 一坨一坨 if/else 参数校验,被 SpringBoot 参数校验组件整干净了
-
来源:https://mp.weixin.qq.com/s/ZVOiT-_C3f-g7aj3760Q-g...
- 用了这两款插件,同事再也不说我代码写的烂了
-
同事:你的代码写的不行啊,不够规范啊。我:我写的代码怎么可能不规范,不要胡说。于是同事打开我的IDEA,安装了一个插件,然后执行了一下,规范不规范,看报告吧。这可怎么是好,这玩意竟然给我挑出来这么...
- SpringBoot中6种拦截器使用场景
-
SpringBoot中6种拦截器使用场景,下面是思维导图详细总结一、拦截器基础...
- 用注解进行参数校验,spring validation介绍、使用、实现原理分析
-
springvalidation是什么在平时的需求开发中,经常会有参数校验的需求,比如一个接收用户注册请求的接口,要校验用户传入的用户名不能为空、用户名长度不超过20个字符、传入的手机号是合法的手机...
- 快速上手:SpringBoot自定义请求参数校验
-
作者:UncleChen来源:http://unclechen.github.io/最近在工作中遇到写一些API,这些API的请求参数非常多,嵌套也非常复杂,如果参数的校验代码全部都手动去实现,写起来...
- 分布式微服务架构组件
-
1、服务发现-Nacos服务发现、配置管理、服务治理及管理,同类产品还有ZooKeeper、Eureka、Consulhttps://nacos.io/zh-cn/docs/what-is-nacos...
- 优雅的参数校验,告别冗余if-else
-
一、参数校验简介...
- Spring Boot断言深度指南:用断言机制为代码构筑健壮防线
-
在SpringBoot开发中,断言(Assert)如同代码的"体检医生",能在上线前精准捕捉业务逻辑漏洞。本文将结合企业级实践,解析如何通过断言机制实现代码自检、异常预警与性能优化三...
- 如何在项目中优雅的校验参数
-
本文看点前言验证数据是贯穿所有应用程序层(从表示层到持久层)的常见任务。通常在每一层实现相同的验证逻辑,这既费时又容易出错。为了避免重复这些验证,开发人员经常将验证逻辑直接捆绑到域模型中,将域类与验证...
- SpingBoot项目使用@Validated和@Valid参数校验
-
一、什么是参数校验?我们在后端开发中,经常遇到的一个问题就是入参校验。简单来说就是对一个方法入参的参数进行校验,看是否符合我们的要求。比如入参要求是一个金额,你前端没做限制,用户随便过来一个负数,或者...
- 28个验证注解,通过业务案例让你精通Java数据校验(收藏篇)
-
在现代软件开发中,数据验证是确保应用程序健壮性和可靠性的关键环节。JavaBeanValidation(JSR380)作为一个功能强大的规范,为我们提供了一套全面的注解工具集,这些注解能够帮...
- Springboot @NotBlank参数校验失效汇总
-
有时候明明一个微服务里的@Validated和@NotBlank用的好好的,但就是另一个里不能用,这时候问题是最不好排查的,下面列举了各种失效情况的汇总,供各位参考:1、版本问题springbo...
- 这可能是最全面的Spring面试八股文了
-
Spring是什么?Spring是一个轻量级的控制反转(IoC)和面向切面(AOP)的容器框架。...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- 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)
- node卸载 (33)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- exceptionininitializererror (33)
- 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)