备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

《SpringBoot篇》12.@Valid与@Validated的区别

2022-10-24 413
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 《SpringBoot篇》12.@Valid与@Validated的区别

1.介绍

说明： 其实@Valid 与 @Validated都是做数据校验的，只不过注解位置与用法有点不同。


不同点：

（1）

@Valid是使用Hibernate validation的时候使用。@Validated是只用Spring Validator校验机制使用。


（2）

@Valid 可以嵌套验证

@Validation 不能进行嵌套验证


（3）

@Valid：可以用在方法、构造函数、方法参数和成员属性（field）上。

@Validated：用在类、方法和方法参数上。但不能用于成员属性（field）。

（如果@Validated注解在成员属性上，则会报不适用于field的错误。）


（4）

@Valid：没有分组功能。

@Validated：提供分组功能，可以在参数验证时，根据不同的分组采用不同的验证机制。


2.用法

（1）@Valid用法

a.导入依赖

SpringBoot项目：


<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.4.1.Final</version>
</dependency>

b.使用前提是实体类中属性使用注解进行校验

package com.example.demo.pojo;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;
import javax.persistence.*;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Date;
//lombok
@Data
public class User implements Serializable {
    //用户名
    @NotBlank(message = "请输入名称")
    @Length(message = "名称不能超过个 {max} 字符", max = 10)
    private String username;
    //年龄
    @NotNull(message = "请输入年龄")
    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)
    private String age;
}

c.在Controller方法参数中加上@Valid注解

package com.example.demo.controller;
import com.example.demo.pojo.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.util.List;
@RestController
public class UserController {
    public static final Logger logger = LoggerFactory.getLogger(UserController.class.getName());
    @PostMapping("/add")
    @ResponseBody
    public String add(@Validated User user, BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            allErrors.forEach( v ->{
                logger.error(v.getObjectName()+"======"+v.getDefaultMessage());
            });
            return "添加失败";
        }
        return "添加成功";
    }
}

经过测试填写错误数据，会在控制台输出报错信息。


image.png


（2）@Validated用法

a.开启校验框架（与上面一样）

<!--1.导入JSR303规范-->

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
</dependency>
<!--使用hibernate框架提供的校验器做实现-->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

c.在需要开启校验功能的类上使用注解@Validated开启校验功能，对具体的字段设置校验规则,这里讲的是可以在类上使用@Validated注解，配合xml数据绑定。

@Component
@Data
@ConfigurationProperties(prefix = "servers")
//开启对当前bean的属性注入校验
@Validated
public class ServerConfig {
    //设置具体的规则
    @Max(value = 8888,message = "最大值不能超过8888")
    @Min(value = 202,message = "最小值不能低于202")
    private int port;
}

（3）@Validated实现分组校验

注意 分组校验就是把条件加入组中，可以自由选择开启那些组的校验方式。


a.分组接口

package com.example.demo.pojo;
public interface Group {
    interface Update{};
    interface FindAll{};
}


b.实体类

package com.example.demo.pojo;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;
import javax.persistence.*;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Date;
//lombok
@Data
public class User implements Serializable {
    //用户名
    @NotBlank(message = "请输入用户名不能为空",groups = {Group.FindAll.class})
    @Length(message = "名称不能超过个 {max} 字符", max = 10 ,groups = {Group.FindAll.class})
    private String username;
    //年龄
    @NotBlank(message = "请输入年龄不能为空",groups = {Group.Update.class})
    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100,groups = {Group.Update.class})
    private String age;
}

c.controller接口：

注意 @Validated有参数 value中写分组名称


package com.example.demo.controller;
import com.example.demo.pojo.Group;
import com.example.demo.pojo.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.util.List;
@RestController
public class UserController {
    public static final Logger logger = LoggerFactory.getLogger(UserController.class.getName());
    @PostMapping("/add")
    @ResponseBody
    //注意@Validated有参数 value中写分组名称
    public String add(@Validated(value = {Group.Update.class}) User user, BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            allErrors.forEach( v ->{
                logger.error(v.getObjectName()+"======"+v.getDefaultMessage());
            });
            return "添加失败";
        }
        return "添加成功";
    }
}


（4）@Valid 实现嵌套校验

注: 嵌套检测就是在一个User类中，存在另外一个User2类的属性。嵌套检测User同时也检测User2。


a.实体类User

package com.example.demo.pojo;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;
import javax.persistence.*;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Date;
//lombok
@Data
public class User implements Serializable {
    //用户名
    @NotBlank(message = "请输入用户名不能为空1")
    private String username;
    //年龄
    @NotBlank(message = "请输入年龄不能为空1")
    private String age;
    @Valid
    @NotNull(message = "user2不能为空1")
    private User2 user2;
}
}


b.实体类User2

package com.example.demo.pojo;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;
import javax.persistence.*;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Date;
package com.example.demo.pojo;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
//lombok
@Data
public class User2 implements Serializable {
    //用户名
    @Length(message = "名称不能超过个 {max} 字符2", max = 10 )
    private String username2;
    //年龄
    @Range(message = "年龄范围为 {min} 到 {max} 之间2", min = 1, max = 100)
    private String age2;
}


c.Controller类（这里使用@Valid）

package com.example.demo.controller;
import com.example.demo.pojo.Group;
import com.example.demo.pojo.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.util.List;
@RestController
public class UserController {
    public static final Logger logger = LoggerFactory.getLogger(UserController.class.getName());
    @PostMapping("/add")
    @ResponseBody
    public String add(@Valid User user, BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            allErrors.forEach( v ->{
                logger.error(v.getObjectName()+"======"+v.getDefaultMessage());
            });
            return "添加失败";
        }
        return "添加成功";
    }
}


文章标签：
Java
Spring
数据格式
XML
数据库连接
关键词：
Spring Boot@validated
Spring Boot@valid@validated
Spring Boot@valid
陈老老老板
目录
相关文章
喜欢猪猪
|
5天前
|
Java API 数据安全/隐私保护
掌握Spring Boot中的@Validated注解
【4月更文挑战第23天】在 Spring Boot 开发中，@Validated 注解是用于开启和利用 Spring 的验证框架的一种方式，特别是在处理控制层的输入验证时。本篇技术博客将详细介绍 @Validated 注解的概念和使用方法，并通过实际的应用示例来展示如何在项目中实现有效的数据验证
喜欢猪猪
19 3
一只牛博
|
2月前
|
JSON Java 数据格式
springboot全局异常实现以及@Valid和@Validated优雅实现入参验证
springboot全局异常实现以及@Valid和@Validated优雅实现入参验证
一只牛博
72 0
马丁玩编程
|
Java 测试技术
SpringBoot 与注解 @Validated 结合对数据进行验证
SpringBoot 与注解 @Validated 结合对数据进行验证
马丁玩编程
270 0
SpringBoot 与注解 @Validated 结合对数据进行验证
小阿杰.
|
前端开发 Java Spring
【Spring Boot 快速入门】十四、Spring Boot集成@Valid注解的接口参数合法性校验
【Spring Boot 快速入门】十四、Spring Boot集成@Valid注解的接口参数合法性校验
小阿杰.
457 0
java开发-郭老师
|
19天前
|
Java Linux
Springboot 解决linux服务器下获取不到项目Resources下资源
Springboot 解决linux服务器下获取不到项目Resources下资源
java开发-郭老师
37 0
风水道人
|
27天前
|
Java API Spring
SpringBoot项目调用HTTP接口5种方式你了解多少？
SpringBoot项目调用HTTP接口5种方式你了解多少？
风水道人
80 2
风水道人
|
27天前
|
前端开发 JavaScript Java
6个SpringBoot 项目拿来就可以学习项目经验接私活
6个SpringBoot 项目拿来就可以学习项目经验接私活
风水道人
34 0
zhishijike
|
1月前
|
前端开发 Java 关系型数据库
SpringBoot+MyBatis 天猫商城项目
SpringBoot+MyBatis 天猫商城项目
zhishijike
57 1
hhzz
|
1月前
|
JSON JavaScript 前端开发
解决js中Long类型数据在请求与响应过程精度丢失问题（springboot项目中）
解决js中Long类型数据在请求与响应过程精度丢失问题（springboot项目中）
hhzz
42 0
风水道人
|
30天前
|
Java Maven 微服务
springboot项目开启远程调试-jar包
springboot项目开启远程调试-jar包
风水道人
20 0

热门文章

最新文章

  • 1
    SpringBoot集成Redis
  • 2
    SpringBoot-Run启动流程
  • 3
    SpringBoot 企业级简化开发（一）
  • 4
    基于 java + Springboot + vue +mysql 大学生实习管理系统（含源码）
  • 5
    SpringBoot项目调用HTTP接口5种方式你了解多少？
  • 6
    SpringBoot3集成Swagger出现错误Error starting ApplicationContext. To display the condition evaluation repor
  • 7
    SpringBoot集成Redis解决表单重复提交接口幂等（亲测可用）
  • 8
    Springboot+Spring security +jwt认证+动态授权
  • 9
    【mybatis】第一篇，Springboot中使用插件PageHelper不生效解决方案
  • 10
    SpringBoot实现多线程定时任务动态定时任务配置文件配置定时任务
  • 1
    SpringBoot启动后出现Please sign in页面
    46
  • 2
    Spring Boot的定时任务与异步任务
    53
  • 3
    SpringBoot整合Mybatis连接Oracle数据库
    65
  • 4
    通用Shell脚本执行Spring Boot项目Jar包
    29
  • 5
    【SpringBoot系列】SpringBoot集成Fast Mybatis
    173
  • 6
    Spring Boot集成Redis启动失败【Caused by: java.lang.ClassNotFoundException: org.apache.commons.pool2.impl.G】
    66
  • 7
    Spring Boot 整合xxl-job实现分布式定时任务
    73
  • 8
    【二十二】springboot整合拦截器实战并对比过滤器
    33
  • 9
    【二十一】springboot整合过滤器实战
    15
  • 10
    【二十】springboot整合ElasticSearch实战（万字篇）
    216

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • introduction to Apache Bean
  • In-Flux Limiting for a Multi-Tenant Logging Service
  • 低代码开发师（初级）实战教程
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）