@Valid注解的作用及@Valid注解与@Validated的区别

2023-09-20 15:37:21

1.@Valid注解

导入依赖

  <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
  </dependency>

用于验证注解是否符合要求，直接加在变量user之前，在变量中添加验证信息的要求，当不符合要求时就会在方法中返回message 的错误提示信息。

@ApiOperation(value = "Shipping receive completion request from shiphub frontend or app client like OMS", tags = {"Completion APIs"})
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "OK"),
            @ApiResponse(code = 401, message = "You are not authorized to access to this API"),
            @ApiResponse(code = 403, message = "Accessing the resource you were trying to reach is forbidden"),
            @ApiResponse(code = 404, message = "The resource you were trying to reach is not found")
    })
    @PostMapping(value = "/completion", produces = {"application/json"}, consumes = {"application/json"})
    public ResponseEntity<ApiResponseDto> actionCompletionShippingOrder(
            @ApiParam(value = "request body", required = true) @RequestBody @Valid CompletionOrderRequestDto completionOrderRequestDto, 
            BindingResult bindingResult) throws Exception {
 
        ApiResponseDto apiResponseDto = shippingCompletionService.requestActionToOrder(bindingResult, completionOrderRequestDto);
        if (!AppClientResponse.GENERAL_SUCC.getStatus().equals(apiResponseDto.getStatus())) {
            return new ResponseEntity<>(apiResponseDto, HttpStatus.BAD_REQUEST);
        }
        return new ResponseEntity<>(apiResponseDto, HttpStatus.OK);
    }

然后在 CompletionOrderRequestDto 类中添加验证信息的要求：

public class CompletionOrderRequestDto implements Serializable, IShiphubRequestDto {
  private static final long serialVersionUID = -6593240841146979248L;
  @JsonProperty("client_name")
  @ICheckAppClientName
  private String clientName;
  @JsonProperty("ship_group_id")
  @NotBlank(message = "shipGroupId不能为空")
  private String shipGroupId;
}

@NotBlank 注解所指的 password 字段，表示验证密码不能为空，如果为空的话，上面 Controller 中的 create 方法会将message 中的"密码不能为空"返回。
当然也可以添加其他验证信息的要求：

限制说明
@Null限制只能为null
@NotNull限制必须不为null
@AssertFalse限制必须为false
@AssertTrue限制必须为true
@DecimalMax(value)限制必须为一个不大于指定值的数字
@DecimalMin(value)限制必须为一个不小于指定值的数字
@Digits(integer,fraction)限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future限制必须是一个将来的日期
@Max(value)限制必须为一个不大于指定值的数字
@Min(value)限制必须为一个不小于指定值的数字
@Past限制必须是一个过去的日期
@Pattern(value)限制必须符合指定的正则表达式
@Size(max,min)限制字符长度必须在min到max之间
@Past验证注解的元素值（日期类型）比当前时间早
@NotEmpty验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

除此之外还可以自定义验证信息的要求，例如上面的 @ICheckAppClientName：
注解的具体内容：

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {CheckActionNameCompletionOrderValidator.class})
public @interface ICheckActionNameCompletionOrder {
    String message() default "1102";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

这是校验器：

public class CheckActionNameCompletionOrderValidator implements ConstraintValidator<ICheckActionNameCompletionOrder, String> {
    private static final Logger logger = LoggerFactory.getLogger(CheckActionNameCompletionOrderValidator.class);
    @Value("#{'${Action.completionName}'.split(',')}")
    private List<String> actionCompletionOrderList;
    @Override
    public boolean isValid(String actionName, ConstraintValidatorContext context) {
         logger.info("Action completion order name validator: enter action name is { {} }", actionName);
        return actionName != null && actionCompletionOrderList.stream().anyMatch(x -> actionName.toLowerCase().equals(x.toLowerCase()));
    }
}

2.@Valid与@Validated的区别

  • @Valid是使用Hibernate validation的时候使用
  • @Validated是只用Spring Validator校验机制使用
    说明：
  • validation-api是一套标准，hibernate-validator实现了此标准
  • JSR-303 是Java EE 6 中的一项子规范，叫做BeanValidation，官方参考实现是hibernate-validator
  • java的JSR303声明了@Valid这类接口，而Hibernate-validator实现了JSR-303规范
  • @Validated org.springframework.validation.annotation.Validated jar包：spring-context
  • @Valid javax.validation.Valid jar包：javax.validation
  • Spring Validation验证框架对参数的验证机制提供了@Validated（Spring’s JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。其中对于字段的特定验证注解比如@NotNull，@Validation对@Valid进行了二次封装，使用@Validated或者@Valid在校验Controller入参时并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同，这里主要就这几种情况进行说明。

注解位置

  • @Validated：用在类型、方法和方法参数上。但不能用于成员属性（field）
  • @Valid：可以用在方法、构造函数、方法参数和成员属性（field）上

分组校验

  • @Validated：提供分组功能，可以在参数验证时，根据不同的分组采用不同的验证机制
  • @Valid：没有分组功能
    举例：
    定义分组接口：
public interface IGroupA {
} 
public interface IGroupB {
}

定义需要检验的参数bean：

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    //只在分组为IGroupB的情况下进行验证
    @Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupB.class})
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint
    private String className;

测试代码：
检验分组为IGroupA的情况

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

这里对分组IGroupB的就没检验了

如果把测试代码改成下面这样，就会检验B了

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

说明：
1、不分配groups，默认每次都要进行验证
2、对一个参数需要多种验证方式时，也可通过分配不同的组达到目的。

组序列

默认情况下 不同级别的约束验证是无序的，但是在一些情况下，顺序验证却是很重要。
一个组可以定义为其他组的序列，使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候，如果序列前边的组验证失败，则后面的组将不再给予验证。
举例：
定义组序列：

@GroupSequence({Default.class, IGroupA.class, IGroupB.class})
public interface IGroup {
}

需要校验的Bean，分别定义IGroupA对age进行校验，IGroupB对className进行校验：

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁", groups = IGroupA.class)
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint(groups = IGroupB.class)
    private String className;

测试代码：

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroup.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

测试发现，如果age出错，那么对组序列在IGroupA后的IGroupB不进行校验，即例子中的className不进行校验，结果如下：
在这里插入图片描述
在这里插入图片描述

嵌套校验

一个待验证的pojo类，其中还包含了待验证的对象，需要在待验证对象上注解@Valid，才能验证待验证对象中的成员属性，这里不能使用@Validated。
举例：
需要约束校验的bean：

public class TeacherBean {
    @NotEmpty(message = "老师姓名不能为空")
    private String teacherName;
    @Min(value = 1, message = "学科类型从1开始计算")
    private int type;

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁")
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint
    private String className;
 
    @NotNull(message = "任课老师不能为空")
    @Size(min = 1, message = "至少有一个老师")
    private List<TeacherBean> teacherBeans;

注意：
这里对teacherBeans只校验了NotNull, 和 Size，并没有对teacher信息里面的字段进行校验，具体测试如下：
在这里插入图片描述
这里teacher中的type明显是不符合约束要求的，但是能检测通过，是因为在student中并没有做 嵌套校验
可以在teacherBeans中加上 @Valid，具体如下：

    @Valid
    @NotNull(message = "任课老师不能为空")
    @Size(min = 1, message = "至少有一个老师")
    private List<TeacherBean> teacherBeans;
更多推荐

JAVA面经整理(2)

一)解决哈希冲突的方法有哪些？哈希冲突指的是在哈希表中，不同的键值映射到了相同的哈希桶，也就是数组索引，导致键值对的冲突1)设立合适的哈希函数:通过哈希函数计算出来的地址要均匀的分布在整个空间中2)负载因子调节:2.1)开放地址法:1)当发生哈希冲突时，如果哈希表中没有装满，说明哈希表中一定还有空余位置，那么可以把ke

基于Python Django的公务员考试信息管理系统

文章目录1简介2.技术栈3功能分析4功能具体设计4.1软件功能模块设计4.2数据库设计与实现4.2.1概念模型设计4.2.2数据库逻辑结构设计5系统详细设计5.1系统功能模块5.2管理员功能模块六源码咨询1简介公务员考试信息管理系统的开发运用Python技术，MIS的总体思想，以及MYSQL等技术的支持下共同完成了该系

Linux系统编程（信号处理 sigacation函数和sigqueue函数 )

文章目录前言一、sigaction二、sigqueue函数三、代码示例总结前言本篇文章我们来介绍一下sigacation函数和sigqueue函数。一、sigactionsigaction是一个用于设置和检查信号处理程序的函数。它允许我们指定信号的处理方式，包括指定一个函数作为信号处理程序、设置标志位以及指定信号处理程

Linux系统编程（信号处理机制）

文章目录前言一、中断，异常，信号的区别二、信号在Linux中的标识三、信号处理相关函数四、代码实验总结前言本篇文章我们来讲解信号的处理机制，信号处理在Linux操作系统中必不可少，这一点值得大家注意，信号又会与中断，异常一起讨论，那么下面我们就来看看到底什么是信号吧。一、中断，异常，信号的区别中断、异常和信号是计算机系

MAC MINI 2012安装Montery折腾笔记

MACMINI2012安装Montery折腾笔记（作为电视盒子/远程开发机）起因：手头有个macmini，2018年买的2手。一直都是10.12系统，处理python和苹果开发都受制于旧系统，很多软件也装不上，于是有了升级的需求，打算折腾下再战3年直接升级使用因特网恢复系统模式，恢复到最新适配的版本开机时，按Win+A

一些docker笔记

一些docker笔记docker是一个跨平台，可迁移的应用虚拟化,容器化服务平台Docker口号1：Build,ShipandRun(构建，发送和运行)Docker口号2:Buildonce,Runanywhere(构建一次，到处能用)docker一些概念docker仓库官方有dockeHub仓库，也可以使用阿里、网易

Spring Authorization Server入门 (十八) Vue项目使用PKCE模式对接认证服务

Vue单页面项目使用授权码模式对接流程说明以下流程摘抄自官网在本例中为授权代码流程。授权码流程的步骤如下：客户端通过重定向到授权端点来发起OAuth2请求。对于公共客户端，此步骤包括生成code_verifier并计算code_challenge，然后将其作为查询参数发送。如果用户未通过身份验证，授权服务器将重定向到登

PostgreSQL16源码包编译安装

一、安装环境操作系统：CentOSLinuxrelease7.8.2003(Core)PostgreSQL版本：16服务器IP地址：192.168.0.244Firewalld关闭、selinux关闭笔者本次选用最新v16版本进行部署二、pg数据库安装包下载下载地址：https://www.postgresql.org

第八章 排序

一、插入排序不带哨兵voidInsertSort(intA[],intn){inti,j,temp;for(i=1;i<n;i++){if(A[i]<A[i-1]){temp=A[i];for(j=i-1;j>=0&&A[j]>temp;--j){A[j+1]=A[j];}A[j+1]=temp;}}}带哨兵voidI

二分与前缀和

目录🍈前言❤二分🌹二分🌼数的范围🌼数的三次方根🌼特殊数字🌼机器人跳跃问题🌼四平方和🌼分巧克力🌹前缀和🌼前缀和🌼子矩阵的和🌼激光炸弹🌼K倍区间🍈前言❤二分整数二分模板中，一个比较坑的点，就是C++整数向下取整的机制，考虑到这点，你才能写出AC100%的代码关键在于1，对if()后面条件的判断2

SAP CRM 模块：概述，体系结构

前言CRM代表“客户关系管理”，是一组有助于以有组织的方式管理客户关系的方法和工具。在当今竞争激烈的商业环境中，顶级公司的注意力越来越集中于其最有价值的资产–客户。因此，这些公司需要一种合适的软件解决方案来迎合其客户，该解决方案易于使用，易于定制，完全集成并且可以灵活实施。客户关系管理是一种用于优化客户互动的业务策略。

热文推荐
  1. 面试官：你是怎么理解ES6中Proxy的？使用场景?

    🎬岸边的风：个人主页🔥个人专栏:《VUE》《javaScript》⛺️生活的理想，就是为了理想的生活!目录一、介绍二、用法参数handler解析Reflectget()set()deleteProperty()取消代理三、使用场景一、介绍定义：用于定义基本操作的自定义行为本质：修改的是程序默认形为，就形同于在编程语

  2. ConfigMaps-1

    文章目录主要内容一.使用YAML文件创建1.在data节点创建了一些键值：代码如下（示例）:2.解释二.使用命令行创建1.创建了一个名为person的键值：代码如下（示例）:2.解释3.创建了一个index.html文件，然后用--from-file来引用代码如下（示例）:4.解释总结主要内容使用YAML文件创建使用命

  3. Python 缓存库

    文章目录缓存库缓存库的类型Python中有用的缓存库Python中的Redis缓存库Python中的lru_cache库Python中的其他缓存库总结缓存是一种可以存储数据以供快速访问的内存类型。它是一个小而快速的内存，用于保存经常访问的数据。缓存是至关重要的，因为它可以通过减少系统访问缓慢的主存储器的次数来提高系统性

  4. 【从入门到起飞】JavaAPI—System，Runtime，Object，Objects类

    🎊专栏【JavaSE】🍔喜欢的诗句：更喜岷山千里雪三军过后尽开颜。🎆音乐分享【如愿】🎄欢迎并且感谢大家指出小吉的问题🥰文章目录🍔System类⭐exit()⭐currentTimeMillis()🎄用处⭐arraycopy()🍔Runtime类⭐创建对象⭐exit()⭐availableProcesso

  5. 写一篇nginx配置指南

    nginx.conf配置找到Nginx的安装目录下的nginx.conf文件，该文件负责Nginx的基础功能配置。配置文件概述Nginx的主配置文件(conf/nginx.conf)按以下结构组织：配置块功能描述全局块与Nginx运行相关的全局设置events块与网络连接有关的设置http块代理、缓存、日志、虚拟主机等

  6. 【计算机网络】网络编程接口 Socket API 解读（6）

    Socket是网络协议栈暴露给编程人员的API，相比复杂的计算机网络协议，API对关键操作和配置数据进行了抽象，简化了程序编程。本文讲述的socket内容源自Linuxman。本文主要对各API进行详细介绍，从而更好的理解socket编程。recvrecv()遵循POSIX.1-20081.库标准c库，libc,-lc

  7. Ubuntu 安装 CUDA 与 CUDNN GPU加速引擎

    一、NVIDIA（英伟达）显卡驱动安装NVIDIA显卡驱动可以通过指令sudoaptpurgenvidia*删除以前安装的NVIDIA驱动版本，重新安装。1.1.关闭系统自带驱动nouveau注意！在安装NVIDIA驱动以前需要禁止系统自带显卡驱动nouveau：可以先通过指令lsmod|grepnouveau查看no

  8. 嵌入式笔试面试刷题(day11)

    文章目录前言一、字节流，数据报，报文二、makefile怎么引入库和模块三、多次free一块内存空间会怎么样四、字符操作函数越界会发生什么五、QT中一个信号可以连接多个槽函数吗六、QT中一个槽函数可以对应多个信号吗总结前言本篇文章继续刷题。一、字节流，数据报，报文1.数据报（Datagram）：数据报是一种独立的、特定

  9. Linux：基础开发工具之Makefile和缓冲区的基本概念

    文章目录动静态库自动化构建代码缓冲区原理实现具体实现动静态库首先要知道什么是链接：C程序中，并没有定义printf的函数实现,且在预编译中包含的stdio.h中也只有该函数的声明,而没有定义函数的实现系统把这些函数实现都被做到名为libc.so.6的库文件中去了,在没有特别指定时,gcc会到系统默认的搜索路径“/usr