怎么使用Spring Validation

本篇内容主要讲解“怎么使用Spring Validation”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“怎么使用Spring Validation”吧!

首先添加POM依赖

新建一个Spring Boot项目,并在pom.xml文件添加依赖:

怎么使用Spring Validation

需要特别注意的一点是:如果我们项目中引入了spring-boot-starter-web依赖,那么它会自动依赖spring-boot-starter-validation,无需我们再手动添加依赖,防止出现一些版本兼容的问题。

添加约束注解

在接收参数的UserReq实体类对应的属性上加上约束注解:

怎么使用Spring Validation

注意点:

  • 每个约束注解都有一个message元素,用于校验失败时的提示信息

  • 一个属性可以添加多个约束注解,所有注解是与的关系,必须全部验证通过

  • 可以使用正则表达式校验参数

眼尖的同学可能会发现上面代码中用到的一些约束注解一些是引用自javax.validation.constraints包下,还有一些引用自org.hibernate.validator.constraints包下,这是怎么一回事呢?

说到这里,不得不提一下JSR-303,JSR-303是JAVA EE(现改名为:Jakarta EE)中的一项子规范,叫Bean Validation,它定义了一些实体和方法验证的约束和接口规范,而Hibernate Validator对Bean Validation规范中所有内置约束注解都提供了实现,并且还添加了一些额外的约束注解。

Bean Validation中内置的约束注解:

怎么使用Spring Validation

Hibernate Validator中添加的约束注解:

怎么使用Spring Validation

值得一提的是:在Hibernate Validator中额外添加的一些优秀的约束注解比如@Email@NotEmpty@NotBlank已经被吸收到Bean Validation标准约束注解中,所有我们在代码中Import时应尽量使用javax.validation.constraints包下的约束注解。

怎么使用呢?

接收参数的实体类我们已经改造好了,但是还不能实现校验的功能,还需要对Controller进行改造:

怎么使用Spring Validation

  • 在接收方法的参数前面加上@Validated注解,当然也可以加@Valid注解

  • 想要获取参数校验的结果,则需要进行校验的参数后面紧跟一个BingingResult类型的参数,用来绑定校验结果

关于第一点,@Validated注解由Spring框架提供,可以说是对JSR-303规范标准注解@Valid的封装,可以提供额外的例如分组校验的功能。实际上任何以"Valid"开头的注解都可以实现同样的效果(至于原因有机会专门写一篇讲一下,感兴趣的可以关注一下)

至于第二点,为什么校验结果会自动绑定到后面紧跟的BingingResult对象,这里面涉及到Spring DataBinder数据绑定相关的知识(以后会专门讲解,感兴趣的可以关注一下),现在我们只需要知道这样写就行。

请求测试

现在我们使用Postman工具来请求我们的接口:

怎么使用Spring Validation

然后我们打上断点来调试一下bindingResult对象:

可以看到bindingResult对象成功绑定并返回了三个属性校验失败的结果。

分组校验

我们写业务时通常会存在一种情况:新增操作时通常不需要校验参数Id,而在修改或删除操作时我们又需要校验参数Id,那么对于同一个参数接收类UserReq,我们要怎么处理呢?

很简单,首先我们新建一个更新分组,只需要一个普普通通的接口类就行:

怎么使用Spring Validation

接着我们在UserReq类里新增一个id属性,同时加上@NotNull分组校验:

怎么使用Spring Validation

groups支持传入一个数组,可以传入多个分组,对于id属性来说,在更新和删除操作时我们都需要校验该属性。

最后,在Controller里更新接口方法中添加校验分组:

怎么使用Spring Validation

我们只需要在注解中加上需要校验的Update分组就行啦。

到此,相信大家对“怎么使用Spring Validation”有了更深的了解,不妨来实际操作一番吧!这里是亿速云网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!