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

雨点打透心脏的1/2处 2022-01-31 17:51 533阅读 0赞

在后端开发中，参数校验是非常普遍的，但是我觉得应该很多同学都是大概了解怎么去使用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][http_mp.weixin.qq.com_s_biz_MzUxOTc4NjEyMw_mid_2247484258_idx_1_sn_a88dd960fd183f2f834a96489d643583_chksm_f9f51886ce829190645896f86083183d69066698a1264bcdd8784dabf03f5c0b7d2c50408701_mpshare_1_scene_24_srcid_0517wvmU7j3SiGApLmBIq44I_rd]

**1****、背景介绍**

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70][]这样写并没有什么错，还挺工整的，只是看起来不是很优雅而已。

接下来，用Validation来改写这段

**2****、****Spring Boot****文档中的****Validation**

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 1][]其实，**Spring Validator**和**Hibernate Validator**是两套Validator，可以混着用，这里我们用**Hibernate Validator**

**3****、****Hibernate Validator**

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

**4****、****Spring Validator**

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

**5****、示例**

**5.1****、引入****spring-boot-starter-validation**

![2019051709313028.png][]**5.2、定义一个对象**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 2][]**5.3、适用****@Valid****校验，并将校验结果放到****BindingResult****对象中**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 3][]注意：

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

**5.4****、看效果**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 4][]

![2019051709313030.png][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 5][]仅仅只是单字段校验的话未免也太不灵活了吧，如果字段之间有关联关系，那该如何校验呢？答案是自定义

**5.5****、自定义校验规则**

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 6][]这里，以优惠券创建为例来演示如何自定义校验规则

首先，优惠券表单如下（仅仅只是演示用）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 7][]这里除了自定义了两条校验规则之外，还用到了分组。

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

下面重点看一下@CheckTimeInterval

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 8][]**第二步**、定义Validator去校验它

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 9][]顺便提一句，这里BeanWrapper去取对象的属性值，我们稍微看一下BeanWrapper是做什么的

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 10][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 11][]

言归正传

**第三步**、验证

![20190517093131682.jpeg][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 12][]

![20190517093130745.png][]

看，自定义的校验生效了

**6****、补充**

**6.1****、校验模式**

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

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

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

为此，需要这样设置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 13][]**6.2、单个参数校验**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 14][]![20190517093130702.png][]![20190517093132634.jpeg][]

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

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 15][]**6.3、错误页面**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 16][]![20190517093130614.png][]

以刚才优惠券详情为例

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

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

[http_mp.weixin.qq.com_s_biz_MzUxOTc4NjEyMw_mid_2247484258_idx_1_sn_a88dd960fd183f2f834a96489d643583_chksm_f9f51886ce829190645896f86083183d69066698a1264bcdd8784dabf03f5c0b7d2c50408701_mpshare_1_scene_24_srcid_0517wvmU7j3SiGApLmBIq44I_rd]: http://mp.weixin.qq.com/s?__biz=MzUxOTc4NjEyMw==&mid=2247484258&idx=1&sn=a88dd960fd183f2f834a96489d643583&chksm=f9f51886ce829190645896f86083183d69066698a1264bcdd8784dabf03f5c0b7d2c50408701&mpshare=1&scene=24&srcid=0517wvmU7j3SiGApLmBIq44I#rd
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70]: /images/20220131/43f70c8e392d4151ba4992f172c32202.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 1]: /images/20220131/3a834f22b27d4bbcaa9c5ad7675022ef.png
[2019051709313028.png]: /images/20220131/17a291a8c700405692811e6397889f8d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 2]: /images/20220131/77c14f21a10e41c5a260a2a1ba683f8d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 3]: /images/20220131/51befcdb731645efab6299992ac7bca2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 4]: /images/20220131/0ae144906761461783f7424c158f8416.png
[2019051709313030.png]: /images/20220131/da7d19484e4e4cb994e62d061189b287.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 5]: /images/20220131/c62c4850771d406bb9c3c8fc4279ef92.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 6]: /images/20220131/0ab6b357cca74d9d85faa07002103d7b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 7]: /images/20220131/075df840d2ff41dbad7b060eea624cc5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 8]: /images/20220131/eb87b8225e62467897e65667f306d177.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 9]: /images/20220131/15c1c3df0e2d4b478cc0e23b6a9065cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20190517093133342.jpeg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 11]: /images/20220131/0767452a8f7142e788859aa1d604733c.png
[20190517093131682.jpeg]: https://img-blog.csdnimg.cn/20190517093131682.jpeg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 12]: /images/20220131/704acc221ebd4745b5c805029b90e80f.png
[20190517093130745.png]: /images/20220131/3cc47ca74e9541209f4df82955bb4848.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 13]: /images/20220131/4e0f577111f84e9d9d52adc865972dbe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 14]: https://img-blog.csdnimg.cn/20190517093132385.jpeg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu,size_16,color_FFFFFF,t_70
[20190517093130702.png]: https://img-blog.csdnimg.cn/20190517093130702.png
[20190517093132634.jpeg]: /images/20220131/402053030c6042709c4ea93509bf50d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 15]: /images/20220131/65ef7b5862df4bf4b604fd4c4ca8f08a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu_size_16_color_FFFFFF_t_70 16]: https://img-blog.csdnimg.cn/20190517093133101.jpeg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0hvd2luZnVu,size_16,color_FFFFFF,t_70
[20190517093130614.png]: /images/20220131/d62279b57195499486f8b9706a7ab7b4.png