SpringBoot注解篇之@Validated

2023-10-14 12:28

本文主要是介绍SpringBoot注解篇之@Validated,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在这里插入图片描述

目录

  • 前言
  • @Validated作用
  • @NotNull与@NotBlank区别
  • 总结


前言

大家好,我是AK,在做新项目顺便整理SpringBoot相关内容,这里主要介绍下@Validated注解的应用,减少核心业务逻辑中一些参数判断的代码。


@Validated作用

@Validated 是 Spring Framework 中的一个注解,用于在方法或类级别上进行参数校验。

它的作用是校验方法参数或类中的字段的有效性,并能够结合 Spring Validation 框架来实现参数校验的功能。@Validated 注解可以应用于控制器层、服务层、持久层等不同的组件中。

下面是几个 @Validated 注解的使用方案:

方法参数校验:可以将 @Validated 注解应用于方法的参数上,以校验该参数的有效性。此时,需要结合其他参数校验注解(如 @NotNull、@NotBlank、@Size 等)一起使用。

public void saveUser(@Validated User user) {// 方法体
}

分组校验:通过指定校验分组,可以对不同的场景应用不同的校验规则。可以使用 @Validated 注解的 groups 属性来指定校验分组。

public void updateUser(@Validated({Group1.class, Group2.class}) User user) {// 方法体
}

类级别校验:可以将 @Validated 注解应用于类上,以校验类中的所有字段的有效性。此时,需要在字段上使用相应的参数校验注解。

@Validated
public class User {@NotNullprivate String username;@NotBlankprivate String password;// 其他字段及getter/setter
}

需要注意的是,@Validated 注解是 Spring Framework 提供的增强版验证注解,它与 JSR-303/JSR-349 中的 Bean Validation 规范相类似,但有一些不同之处。例如,Spring 的 @Validated 注解支持 Spring EL 表达式等高级功能。

总之,@Validated 注解是 Spring Framework 中用于参数校验的注解,可以应用于方法参数、类以及校验分组。它提供了一种方便的方式来实现参数校验,并能够与其他参数校验注解一起使用。

@NotNull与@NotBlank区别

@NotBlank 和 @NotEmpty 是常用的参数校验注解,用于验证字符串字段或方法参数的非空性。它们之间的主要区别在于注解的行为和适用的场景:

@NotBlank 注解:

@NotBlank 注解来自于 Hibernate Validator,它验证一个字符串字段或方法参数是否非空,并且不能只包含空格字符。这意味着字符串不能为 null,长度必须大于零,并且不能只包含空格字符。
@NotBlank 注解只适用于字符串类型,不能用于其他类型。
示例用法:@NotBlank String name;

@NotEmpty 注解:

@NotEmpty 注解来自于 JSR-303/JSR-349 Bean Validation 规范,它验证一个字段或方法参数是否非空,适用于字符串、集合、数组和 Map 等类型的字段和参数。
@NotEmpty 注解要求字段或参数不能为 null,并且其长度或大小不能为零。
示例用法:
字符串:@NotEmpty String name;
集合、数组或 Map:@NotEmpty List list;
总结:

@NotBlank 主要用于验证字符串的非空性,且不能仅包含空格字符。
@NotEmpty 可用于字符串、集合、数组和 Map 等类型的非空性验证,要求字段或参数不能为 null,且长度或大小不能为零。 注解无法直接校验空串(空字符串)。它的主要作用是验证字段或方法参数是否为空,但它不对空字符串进行验证。

在选择使用时,要根据具体情况和需求来决定使用哪个注解,以确保合适的非空性验证。

如果您需要校验空串,可以使用 @NotBlank 注解。@NotBlank 注解在校验字符串非空的同时,也会检查字符串是否只包含空格字符。

示例用法:

@NotBlank
private String name;

另外,若需要校验空串的情况,也可以使用 @NotNull 注解来实现。@NotNull 用于验证字段或方法参数是否为 null,若要同时校验空串,可以配合使用 @Size(min = 1) 注解。

示例用法:

@NotNull
@Size(min = 1)
private String name;

请注意,在使用 @NotBlank 或 @NotNull 进行校验时,需要确保使用的校验实现支持这些注解。通常,使用引入了对应实现的验证框架(如 Hibernate Validator)会对这些注解提供支持。


总结

@NotBlank对字符串校验更严格,可以校验出仅有空格字符串;@NotEmpty不仅可以校验字符串(不能校验仅有空格字符串),还能校验集合。




                                                                                                         ---- 永不磨灭的番号:我是AK



在这里插入图片描述

这篇关于SpringBoot注解篇之@Validated的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/210489

相关文章

一文详解SpringBoot中控制器的动态注册与卸载

《一文详解SpringBoot中控制器的动态注册与卸载》在项目开发中,通过动态注册和卸载控制器功能,可以根据业务场景和项目需要实现功能的动态增加、删除,提高系统的灵活性和可扩展性,下面我们就来看看Sp... 目录项目结构1. 创建 Spring Boot 启动类2. 创建一个测试控制器3. 创建动态控制器注

Java操作Word文档的全面指南

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍Java操作Word文... 目录简介段落页头与页脚页码表格图片批注文本框目录图表简介Word编程最重要的类是org.apach

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

SpringBoot+Docker+Graylog 如何让错误自动报警

《SpringBoot+Docker+Graylog如何让错误自动报警》SpringBoot默认使用SLF4J与Logback,支持多日志级别和配置方式,可输出到控制台、文件及远程服务器,集成ELK... 目录01 Spring Boot 默认日志框架解析02 Spring Boot 日志级别详解03 Sp

java中反射Reflection的4个作用详解

《java中反射Reflection的4个作用详解》反射Reflection是Java等编程语言中的一个重要特性,它允许程序在运行时进行自我检查和对内部成员(如字段、方法、类等)的操作,本文将详细介绍... 目录作用1、在运行时判断任意一个对象所属的类作用2、在运行时构造任意一个类的对象作用3、在运行时判断

java如何解压zip压缩包

《java如何解压zip压缩包》:本文主要介绍java如何解压zip压缩包问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解压zip压缩包实例代码结果如下总结java解压zip压缩包坐在旁边的小伙伴问我怎么用 java 将服务器上的压缩文件解压出来,

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具

Spring WebFlux 与 WebClient 使用指南及最佳实践

《SpringWebFlux与WebClient使用指南及最佳实践》WebClient是SpringWebFlux模块提供的非阻塞、响应式HTTP客户端,基于ProjectReactor实现,... 目录Spring WebFlux 与 WebClient 使用指南1. WebClient 概述2. 核心依

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理?二、核心注解解析1. @RestControllerAdvice2

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注