脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot @Validated处理校验

SpringBoot使用@Validated处理校验的方法步骤

 更新时间：2024年08月13日 09:12:52   作者：你住过的屋檐  
@Validated 注解的主要目的是启用和利用 Spring 的验证框架,它可以用于类上也可以用于方法参数上,本文给大家介绍了SpringBoot使用@Validated优雅的处理校验的方法步骤,通过代码示例介绍的非常详细,需要的朋友可以参考下

前言

@Validated 注解的主要目的是启用和利用 Spring 的验证框架，它可以用于类上也可以用于方法参数上。用于类上时，表示该类中的所有方法参数都需要通过验证框架进行验证；用于方法参数上时，则仅表示该参数需要被验证。选择哪种方式取决于具体的业务需求和个人偏好。

步骤

1、引入依赖，这是 Spring 用来实现数据验证的基础库

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、然后我们将注解@Validated放在类上开启验证功能，将注解@Valid放在参数实体上代表对实体进行校验，例如

@RestController
@RequestMapping("/test")
@Validated
public class TestController {
    @PostMapping()
    public R test(@Valid @RequestBody TestDTO dto){
        return R.ok("响应成功");
    }
}

3、然后我们在请求体中随时用如下 注解即可通过框架自动进行验证，我这里是使用统一异常捕捉进行全局异常情况拦截，有关统一异常封装，大家可以关注我看我另一篇文章。

统一的参数异常捕捉

/**
	 *处理参数校验异常
	 * @param e
	 * @return
	 */
	@ExceptionHandler
	public R handlerException(MethodArgumentNotValidException e) {
		e.printStackTrace();
		BindingResult bindingResult = e.getBindingResult();
		return R.fail(bindingResult.getFieldErrors().get(0).getDefaultMessage());
	}

参数实体

import lombok.Data;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
@Data
public class TestDTO {
    @NotBlank(message = "a参数不能为空")
    private String a;
    @NotNull(message = "b参数不能为null")
    private String b;
    @Max(value = 10,message = "请输入正确的范围")
    private Integer c;
}

4、通过apifox工具调用测试结果如下

5、以下是常用的注解说明

注解类型说明
@NullObject校验必须为null
@NotNullObject校验必须不能是null，并且必须有一个非空格字符
@NotEmpty字符串、集合、映射等类型值不为空（即不为 null 且不为空字符串、空集合或空映射）。
@AssertTrueboolean、Boolean参数需要为true，传null允许通过，注意，当传了0时会认为是false不通过
@AssertFalseboolean、Boolean参数需要为true，传null允许通过，注意，当传了0时会认为是false允许通过
@MaxBigDecimal、BigInteger，基本数字类型及其包装类等允许的最大值，null允许通过
@MinBigDecimal、BigInteger，基本数字类型及其包装类等允许的最小值，null允许通过
@NegativeBigDecimal、BigInteger，基本数字类型及其包装类等数字类型的值必须小于零，null允许通过
@NegativeBigDecimal、BigInteger，基本数字类型及其包装类等数字类型的值必须小于等于零，null允许通过
@PositiveBigDecimal、BigInteger，基本数字类型及其包装类等数字类型的值必须大于零，null允许通过
@PositiveOrZeroBigDecimal、BigInteger，基本数字类型及其包装类等数字类型的值必须大于等于零，null允许通过
@Digits(integer = 10, fraction = 2)字符串、BigDecimal、BigInteger，基本数字类型及其包装类等整数位数和小数位数限制，null允许通过
@Pattern字符串正则表达式匹配，null允许通过
@Email字符串字符串邮箱格式校验，null允许通过
@Size字符串、集合、映射等类校验大小的范围，null允许通过，如 @Size(min = 1, max = 3, message = “最大范围为1-3”)

到此这篇关于SpringBoot使用@Validated处理校验的方法步骤的文章就介绍到这了,更多相关SpringBoot @Validated处理校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 解决mybatis plus字段为null或空字符串无法保存到数据库的问题

    解决mybatis plus字段为null或空字符串无法保存到数据库的问题

    这篇文章主要介绍了解决mybatis plus字段为null或空字符串无法保存到数据库的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • IntelliJ IDEA 2020.2.3永久破解激活教程(亲测有效)

    IntelliJ IDEA 2020.2.3永久破解激活教程(亲测有效)

    intellij idea 2022是一款市面上最好的JAVA IDE编程工具，该工具支持git、svn、github等版本控制工具，整合了智能代码助手、代码自动提示等功能，本教程给大家分享IDEA 2022最新永久激活码，感兴趣的朋友参考下吧
    2020-10-10
  • 一文搞懂Java SPI机制的原理与使用

    一文搞懂Java SPI机制的原理与使用

    Java 程序员在日常工作中经常会听到 SPI，而且很多框架都使用了 SPI 的技术，那么问题来了，到底什么是 SPI 呢？今天小编就带大家好好了解一下 SPI
    2022-10-10
  • springboot jasypt2.x与jasypt3.x的使用方式

    springboot jasypt2.x与jasypt3.x的使用方式

    在软件开发中,将配置文件中的敏感信息(如数据库密码)进行加密是保障安全的有效手段,jasypt框架提供了这一功能,支持通过加密工具类或命令行工具生成密文,并通过修改配置文件和启动参数的方式使用密文和密钥,这样即便配置文件被泄露
    2024-09-09
  • spring中@value注解需要注意的问题

    spring中@value注解需要注意的问题

    本篇文章主要介绍了spring中@value注解需要注意的问题，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-03-03
  • 详解Lombok的坑

    详解Lombok的坑

    这篇文章主要介绍了详解Lombok的坑，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • Java十分钟精通异常处理机制

    Java十分钟精通异常处理机制

    异常就是不正常，比如当我们身体出现了异常我们会根据身体情况选择喝开水、吃药、看病、等 异常处理方法。 java异常处理机制是我们java语言使用异常处理机制为程序提供了错误处理的能力，程序出现的错误，程序可以安全的退出，以保证程序正常的运行等
    2022-03-03
  • 如何解决SpringBoot 加入AOP后无法注入的问题

    如何解决SpringBoot 加入AOP后无法注入的问题

    这篇文章主要介绍了如何解决SpringBoot 加入AOP后无法注入的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-06-06
  • HttpClient 请求 URL字符集转码问题

    HttpClient 请求 URL字符集转码问题

    这篇文章主要介绍了HttpClient 请求 URL字符集转码问题,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2021-01-01
  • 详解在spring boot中配置多个DispatcherServlet

    详解在spring boot中配置多个DispatcherServlet

    本篇文章主要介绍了详解在spring boot中配置多个DispatcherServlet，具有一定的参考价值，有兴趣的可以了解一下。
    2017-03-03

最新评论