Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)

    在后端开发中,参数校验是非常普遍的,但是我觉得应该很多同学都是大概了解怎么去使用Spring Validator或者Hibernate Validator去校验,其中使用Hibernate Validator的同学应该占绝大多数,毕竟它拥有分组的概念,对于校验来说绝对是神器。但是呢,如果我们要使用嵌套校验,这时候就必须得使用@Valid注解来配合了。下面的文章是我今早在地铁上看到的,写得非常的不错,还包含了自定义校验,实在是干货,大家可以多看看~

转载自:http://mp.weixin.qq.com/s?__biz=MzUxOTc4NjEyMw==&mid=2247484258&idx=1&sn=a88dd960fd183f2f834a96489d643583&chksm=f9f51886ce829190645896f86083183d69066698a1264bcdd8784dabf03f5c0b7d2c50408701&mpshare=1&scene=24&srcid=0517wvmU7j3SiGApLmBIq44I#rd

1、背景介绍

开发过程中,后台的参数校验是必不可少的,所以经常会看到类似下面这样的代码

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第1张图片这样写并没有什么错,还挺工整的,只是看起来不是很优雅而已。

接下来,用Validation来改写这段

2Spring Boot文档中的Validation

Spring Boot的官网中,关于Validation只是简单的提了一句,如下

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第2张图片其实,Spring ValidatorHibernate Validator是两套Validator,可以混着用,这里我们用Hibernate Validator

3Hibernate Validator

https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#preface

4Spring Validator

https://docs.spring.io/spring/docs/5.0.5.RELEASE/spring-framework-reference/core.html#validation

5、示例

5.1、引入spring-boot-starter-validation

5.2、定义一个对象

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第3张图片5.3、适用@Valid校验,并将校验结果放到BindingResult对象中

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第4张图片注意:

  • 默认情况下,如果校验失败会抛javax.validation.ConstraintViolationException异常,可以用统一异常处理去对这些异常做处理
  • An Errors/BindingResult argument is expected to be declared immediately after the model attribute

5.4、看效果

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第5张图片

如果在校验的对象后面再加上Model对象的话,如果返回的是ModelAndView就可以将这个Model设置到其中,这样在页面就可以取到错误消息了

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第6张图片仅仅只是单字段校验的话未免也太不灵活了吧,如果字段之间有关联关系,那该如何校验呢?答案是自定义

5.5、自定义校验规则

https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#validator-customconstraints

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第7张图片这里,以优惠券创建为例来演示如何自定义校验规则

首先,优惠券表单如下(仅仅只是演示用):

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第8张图片这里除了自定义了两条校验规则之外,还用到了分组。

为什么要有分组这一说呢?因为,举个例子,添加的时候不需要校验id,而修改的时候id不能为空,有了分组以后,就可以添加的时候校验用组A,修改的时候校验用组B

下面重点看一下@CheckTimeInterval

第一步、定义一个注解叫CheckTimeInterval

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第9张图片第二步、定义Validator去校验它

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第10张图片顺便提一句,这里BeanWrapper去取对象的属性值,我们稍微看一下BeanWrapper是做什么的

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第11张图片Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第12张图片

言归正传

第三步、验证

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第13张图片Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第14张图片

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第15张图片

看,自定义的校验生效了

6、补充

6.1、校验模式

https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#section-fail-fast

下面补充一点,关于校验模式

默认会校验完所有属性,然后将错误信息一起返回,但很多时候不需要这样,一个校验失败了,其它就不必校验了

为此,需要这样设置

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第16张图片6.2、单个参数校验

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第17张图片

如果是调整页面的时候参数校验失败的话,这时可以不做处理,让其调到错误页面。

如果是接口参数校验失败的话,可以在这里进行统一处理,并返回。例如:

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第18张图片6.3、错误页面

Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第19张图片Spring Boot 参数校验(@Validated和@Valid的区别、自定义校验、如何使用嵌套校验)_第20张图片

以刚才优惠券详情为例

http://localhost:8080/coupon/detail.html      400

http://localhost:8080/coupon/detail.html?id=    400

http://localhost:8080/coupon/detail.html?id=abc   400

http://localhost:8080/coupon/detail222.html?id=123  404

无权限  403

int a = 1 / 0;  500

6.4@Valid@Validated

https://blog.csdn.net/qq_27680317/article/details/79970590

这里会提及到两者的区别,和如果使用嵌套校验

你可能感兴趣的:(Spring,Hibernate,Springboot)