文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

参数校验Spring的@Valid注解有什么用

2023-06-20 20:00

关注

小编给大家分享一下参数校验Spring的@Valid注解有什么用,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!

参数校验Spring的@Valid注解

@Valid 注解通常用于对象属性字段的规则检测。

以新增一个员工为功能切入点,以常规写法为背景,慢慢烘托出 @Valid 注解用法详解。

那么,首先,我们会有一个员工对象 Employee,如下 :

public class Employee {         public String name;         public Integer age;     public String getName() {        return name;    }     public void setName(String name) {        this.name = name;    }     public Integer getAge() {        return age;    }     public void setAge(Integer age) {        this.age = age;    } }

然后 Cotroller 中会有一个对应都新增方法 add():

@Controllerpublic class TestController {     @RequestMapping("/add")    @ResponseBody    public String add(Employee employee) {        // TODO 保存到数据库        return "新增员工成功";    } }

需求变更,要求员工名称不能为空,且长度不超过10个字符

我们的原始写法:

参数校验Spring的@Valid注解有什么用

现在规定年龄也是必填项,且范围在1到100岁,那么此时,我们需要增加判定

参数校验Spring的@Valid注解有什么用

现在员工对象 Employee 就 2 个字段,我们就写了 10 多行的代码验证,要是有20个字段,岂不是要写 100 多行代码?

如何解决呢?

将验证过程抽成一个验证方法:

参数校验Spring的@Valid注解有什么用

但这种方式只是抽了一个方法,有一种换汤不换药的感觉,虽然业务方法看起来清爽了很多,但书写代码量并没有下降,反而还多出了一个方法。

此时引出 Spring 的 @valid 注解即可:

首先,我们在 Maven 配置中引入 @valid 的依赖:

如果你是 springboot 项目,那么可以不用引入了,已经引入了,他就存在于最核心的 web 开发包里面。

<dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-web</artifactId>    <version>2.0.5.RELEASE</version></dependency>

代码优化

首先在 Employee 类的属性上打上如下注解:

import javax.validation.constraints.NotBlank;import javax.validation.constraints.NotNull; import org.hibernate.validator.constraints.Length;import org.hibernate.validator.constraints.Range;public class Employee {         @NotBlank(message = "请输入名称")    @Length(message = "名称不能超过个 {max} 字符", max = 10)    public String name;         @NotNull(message = "请输入年龄")    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)    public Integer age;     public String getName() {        return name;    }     public void setName(String name) {        this.name = name;    }     public Integer getAge() {        return age;    }     public void setAge(Integer age) {        this.age = age;    } }

然后再 Controller 对应方法上,对这个员工标上 @Valid 注解,表示我们对这个对象属性需要进行验证

参数校验Spring的@Valid注解有什么用

用一个东西来存放验证结果,做法也很简单,在参数直接添加一个BindingResult:

参数校验Spring的@Valid注解有什么用

对应获取验证结果的代码如下:

参数校验Spring的@Valid注解有什么用

@Valid与@Validated注解

之前项目中参数的校验,都是自己写的判断方法进行校验,这次采用了spring提供的注解进行参数的校验,更为的方便,简洁。

@Valid:常见用在方法,类中字段上进行校验

参数校验Spring的@Valid注解有什么用

参数校验Spring的@Valid注解有什么用

@Validated:是spring提供的对@Valid的封装,常见用在方法上进行校验

参数校验Spring的@Valid注解有什么用

定义的校验类型

@Null 验证对象是否为null

@NotNull 验证对象是否不为null, 无法查检长度为0的字符串

@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.

@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

@CreditCardNumber信用卡验证

@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。

@URL(protocol=,host=, port=,regexp=, flags=) ip地址校验

Booelan检查

@AssertTrue 验证 Boolean 对象是否为 true

@AssertFalse 验证 Boolean 对象是否为 false

长度检查

@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内

@Length(min=, max=) Validates that the annotated string is between min and max included.
日期检查

@Past 验证 Date 和 Calendar 对象是否在当前时间之前

@Future 验证 Date 和 Calendar 对象是否在当前时间之后

@Pattern 验证 String 对象是否符合正则表达式的规则

数值检查,建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为""时无法转换为int,但可以转换为Stirng为"",Integer为null

@Min 验证 Number 和 String 对象是否大等于指定的值

@Max 验证 Number 和 String 对象是否小等于指定的值

@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度

@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度

@Digits 验证 Number 和 String 的构成是否合法

@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。

@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.
注意的几点:

(1)如果一个bean中包含第二个bean

这时要检验第二个bean中某个字段,即嵌套校验,必须要在第一个bean对象中使用@Valid标注到表示第二个bean对象的字段上,然后再第二个bean对象里面的字段上加上校验类型

参数校验Spring的@Valid注解有什么用

参数校验Spring的@Valid注解有什么用

(2)@Validated支持分组注解

先定义一个空接口:GroupA

参数校验Spring的@Valid注解有什么用

对bean对象中校验类型,添加分组信息,这里我对version字段进行了分组校验信息添加

参数校验Spring的@Valid注解有什么用

方法入参中进行分组信息添加

参数校验Spring的@Valid注解有什么用

参数校验Spring的@Valid注解有什么用

如上图所示,则shelveProject方法由于添加了分组信息会校验DeleteProjectRequest对象中的version字段是否为空,而offShelveProject方法没有添加分组信息,不会校验version是否为空。

@Validated没有添加groups属性时,默认验证没有分组的验证属性。

以上是“参数校验Spring的@Valid注解有什么用”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注编程网行业资讯频道!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯