当前位置:首页 > 英文周记 > 正文内容

validated注解 validate 注解

更新时间:2026-07-18 16:35:48 周记网3年前 (2023-05-04)英文周记81

@Validated和@Valid校验

一般情况下,若不需要分组校验的话:使用@Valid和大蔽@Validated并无特殊差异。

在参数前加 @Valid 注解,滚庆州如下:

此情况发生,是由于 方法参数是JavaBean,参数的某一个属性 也是JavaBean

validated注解 validate 注解

若校验的参数是ListUser样式的,用级联嵌套的方法就会失效。因为@Valid只能校验JavaBean,而List不是JavaBean。采用以下2个方法可完差散善:

controller对应的方法参数,使用ValidList

@validated注解实现

在spring项目中,@validated和@valid功能很类似芦冲,都可以在controller层开启数据校验功能。

但是@validated和@valid又陪毕歼不尽相同。有以下不同点:

看MethodValidationPostProcessor类继承图谱

实现了InitializingBean和BeanPostProcessor。所以我们重点看生命周期的2个节点方法数祥。

BeanPostProcessor.postProcessAfterInitialization

InitializingBean.afterPropertiesSet

根据生命周期的顺序,先执行afterPropertiesSet方法。

然后再看postProcessAfterInitialization。实现是在MethodValidationPostProcessor的祖父类AbstractAdvisingBeanPostProcessor上

小结:

validated表单验证时为何注解无效

在springboot中 很多人使用到了表单验证,

表单验证的使闹李用也很简单

一个实体item 其中notnull之类的注解这里不过多介绍 网上可以自己搜索,但是当使用到嵌套表单验证时,比如我上述item实体中的props属性中又套有属性

这时会发现prop中的注解都没有生效此时需要在item实体中的props上加@Valid注解

@validated 和毕猜 @valid的主要区别:

后手弯型者可以用在成员属性上 实现嵌套验证 。

@validated注解怎么用

springmvc实现jsp界面回显的三种方式总结者改: 第一种:controller处理方法的形参pojo定义的对象与此类型同名 ,首字母小写没悄,此时枯嫌渣spring能自动将该 对象名为key,此对象作为value,保存到request中。(必须注意:方法形参必须定义HttpServletRequest对象) 形如: controller中的方法: public ModelAndView insertItemsXXXX(HttpServletRequest request,Modelmodel,@Validated ItemsCustom itemsCustom,BindingResult bindingResult)throws Exception jsp的处理: input type="text" name="name" value="${itemsCustom.name}"第二种:通过注解 @ModelAttribute来定义request中保存的key的名字,如下: controller: public ModelAndView insertItemsXXXXX(HttpServletRequest request,Model model,@ModelAttribute(value="items") @Validated ItemsCustom itemsCustom,BindingResult bindingResult)throws Exceptionjsp: input type="text" name="name" value="${items.name}"第三种(最直观):通过model方式在request中存储指定key与value,如下: controller: @RequestMapping("/insertItemsXXXXX") public String insertItemsXXXXX(HttpServletRequest request,Model model,@Validated ItemsCustom itemsCustom,BindingResult bindingResult)throws Exception{if(bindingResult.hasErrors()){model.addAttribute("allErrors", bindingResult.getAllErrors());model.addAttribute("items", itemsCustom);return ....;}.......return ....; }jsp调用同上。

SpringBoot Validation参数校验 详解自定义注解规则和分组校验

Hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现,除此之外还有一些附加的 constraint

在日常开发中,Hibernate Validator经常用来验证bean的字段,基于注解,方便快捷高效。

在SpringBoot中可以使用@Validated,注解Hibernate Validator加强版,也可以使用@Valid原来Bean Validation java版本

Bean Validation 中内置的 constraint

colgroup style="box-sizing: border-box;"col style="box-sizing: border-box;"col style="box-sizing: border-box;"/colgroup

Hibernate Validator 附加的 constraint

message支持表达式和EL表达式 ,比如message = "姓名长度限制为{min}到{max} ${1+2}")

想把错误描述统一写到properties的话,在classpath下面新建

ValidationMessages_zh_CN.properties文件(注意value需要转换为unicode编码),然后用{}格式的占位符

hibernate补充的注解中,最后3个不常用,可忽略。

主要区分下@NotNull @NotEmpty @NotBlank 3个注解的区别:

如果同一个参数,需要在不同场景下应用不同的校验规则,就需要用到分组校验了汪帆。比如:新注册用户还没起名字,我们允许name字段为空念陵迹,但是在更新时候不允许将名字更新为空字符。

分组校验有三个步骤:

自定义的Update分组接口继承了Default接口。校验注解(如: @NotBlank)和@validated默认其他注解都属于Default.class分组,这一点在

javax.validation.groups.Default注释中有说明

在编写Update分组接口时,如果继承了Default,下面两个写法就是等效的:

@Validated({Update.class}),@Validated({Update.class,Default.class})

如果Update不继承Default,@Validated({Update.class})就只会校验属于Update.class分组的参数字段

如果 UserVO 类中增加一个 OrderVO 类的属性,而 OrderVO 中的属性也需要校验,就用到递归校验了,只要在相应属性上增加@Valid注解即可实现(对于**同样适用)

validation 为我们提供了这么多特性,几乎可以满足日常开发中绝大多数参数校验场景了。但是,一个好的框架一定是方便扩展的。有了扩展能力仔并,就能应对更多复杂的业务场景,毕竟在开发过程中,唯一不变的就是变化本身。 Validation允许用户自定义校验

实现很简单,分两步:

注意:message用于显示错误信息这个字段是必须的,groups和payload也是必须的

@Constraint(validatedBy = {

HandsomeBoyValidator.class})用来指定处理这个注解逻辑的类

注意这里验证逻辑我抽出来单独写了一个工具类,ValidatorUtil

我自定义了补充了很多验证器,包括日期验证,枚举验证,手机号验证,金额验证

自定义校验注解使用起来和内置注解无异,在需要的字段上添加相应注解即可

使用 Validation API 进行参数效验步骤整个过程如下图所示,用户访问接口,然后进行参数效验 ,如果效验通过,则进入业务逻辑,否则抛出异常,交由全局异常处理器进行处理

全局异常出来请参考我这篇文章SpringBoot优雅的全局异常处理

SpringBoot 参数校验,高级特性,非常实用

之前也写过一篇关于 Spring Validation 使用的文章,不过自我感觉还是浮于表面,本次打算彻底搞懂 Spring Validation 。

本文会详细介绍 Spring Validation 各种场景下的最佳实践及其实现原理,死磕到底!

Java API 规范 ( JSR303 ) 定义了 Bean 校验的标准 validation-api ,但没有提供实现。 hibernate validation 是对这个规范的实现,并增加了校验注解如 @Email 、 @Length 等。 Spring Validation 是对 hibernate validation 的二次封装,用于支持 spring mvc 参数自动校验。接下来,我们以 spring-boot 项目为例,介绍 Spring Validation 的使用。

如果 spring-boot 版本小于 2.3.x , spring-boot-starter-web 会自动传入 hibernate-validator 依赖。如果 spring-boot 版本大于 2.3.x ,则需要手动引入依赖:

对于 web 服务来说,为防止非法参数对业务造成影响,在 Controller 层一定要做参数校验的!大部分情况下,请求参数分为如下两种形式:

下面我们简单介绍下 requestBody 和 requestParam/PathVariable 的参数校验实战!

POST 、 PUT 请求一般会使用 requestBody 传递参数,这种情况下,后端使用** DTO 对象 进行接收。 只要给 DTO 对象加上 @Validated 注解就能实现自动参数校验**。比如,有一个保存 User 的接口,要求 userName 长度是 2-10 , account 和 password 字段长度是 6-20 。如果校验失败,会抛出 MethodArgumentNotValidException 异常, Spring 默认会将其转中闭为 400(Bad Request) 请求。

DTO 表示数据传输对象(Data Transfer Object),用于服务器和客户端之间交互传输使用的 。在 spring-web 项目中可以表示用于接收请求参数的 Bean 对象。

这种情况下, 使用 @Valid 和 @Validated 都可以 。

前面说过,如果校验失败,会抛出 MethodArgumentNotValidException 或者 ConstraintViolationException 异常。在实际项目开发中,通常会用 统一异常处理 来返回一个更友好的提示。比如我们系统要求无论发戚让送什么异常, http 的状态码必须返回 200 ,由业务码去区分系统的异常情况。

在实际项目中,可能多个方法需要使用同一个 DTO 类来接收参数,而不同方法的校验规则很可能是不一样的。这个时候,简单地在 DTO 类的字段上加约束注解无法解决这个问题。因此, spring-validation 支持了 分组校验 的功能,专门用来解决这类问题。还是上面的例子,比如保存 User 的时候, UserId 是可空的,但是更新 User 的时候, UserId 的值必须 =10000000000000000L ;其它字段的校验规则在两种情况下一样。这个时候卖仔裂使用 分组校验 的代码示例如下:

前面的示例中, DTO 类里面的字段都是 基本数据类型 和 String 类型。但是实际场景中,有可能某个字段也是一个对象,这种情况先,可以使用 嵌套校验 。

比如,上面保存 User 信息的时候同时还带有 Job 信息。需要注意的是, 此时 DTO 类的对应字段必须标记 @Valid 注解 。

嵌套校验可以结合分组校验一起使用。还有就是 嵌套**校验 会对**里面的每一项都进行校验,例如 List 字段会对这个 list 里面的每一个 Job 对象都进行校验。

如果请求体直接传递了 json 数组给后台,并希望对数组中的每一项都进行参数校验。此时,如果我们直接使用 java.util.Collection 下的 list 或者 set 来接收数据,参数校验并不会生效!我们可以使用自定义 list **来接收参数:

@Delegate 注解受 lombok 版本限制, 1.18.6 以上版本可支持。如果校验不通过,会抛出 NotReadablePropertyException ,同样可以使用统一异常进行处理。

比如,我们需要一次性保存多个 User 对象, Controller 层的方法可以这么写:

业务需求总是比框架提供的这些简单校验要复杂的多,我们可以自定义校验来满足我们的需求。自定义 spring validation 非常简单,假设我们自定义 加密id (由数字或者 a-f 的字母组成, 32-256 长度)校验,主要分为两步:

这样我们就可以使用 @EncryptId 进行参数校验了!

上面的示例都是基于 注解 来实现自动校验的,在某些情况下,我们可能希望以 编程方式 调用验证。这个时候可以注入 javax.validation.Validator 对象,然后再调用其 api 。

Spring Validation 默认会校验完所有字段,然后才抛出异常。可以通过一些简单的配置,开启 Fali Fast 模式,一旦校验失败就立即返回。

在 spring-mvc 中, RequestResponseBodyMethodProcessor 是用于解析 @RequestBody 标注的参数以及处理 @ResponseBody 标注方法的返回值的。显然,执行参数校验的逻辑肯定就在解析参数的方法 resolveArgument() 中:

可以看到, resolveArgument() 调用了 validateIfApplicable() 进行参数校验。

看到这里,大家应该能明白为什么这种场景下 @Validated 、 @Valid 两个注解可以混用。我们接下来继续看 WebDataBinder.validate() 实现。

最终发现底层最终还是调用了 Hibernate Validator 进行真正的校验处理。

接着看一下 MethodValidationInterceptor :

实际上,不管是 requestBody参数校验 还是 方法级别的校验 ,最终都是调用 Hibernate Validator 执行校验, Spring Validation 只是做了一层封装 。

本人花费2个月时间,整理了一套JAVA开发技术资料,内容涵盖java基础,分布式、微服务等主流技术资料,包含大厂面经,学习笔记、源码讲义、项目实战、讲解视频。

java面试资料

私信回复【2022面试资料】

领取更多学习资料

标签: validated注解

“validated注解 validate 注解” 的相关文章

validated注解 validator注解

validated注解 validator注解

Validated校验在springboot框架中的应用(教程版) 在日常开发中,Hibernate Validator经常用来验证bean的字段,基于注解,方便快捷高效。Validated 分组:...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。