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处理校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring FactoriesLoader机制实例详解

    Spring FactoriesLoader机制实例详解

    这篇文章主要介绍了Spring FactoriesLoader机制实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • mybatis update set 多个字段实例

    mybatis update set 多个字段实例

    这篇文章主要介绍了mybatis update set 多个字段实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • Java日常练习题,每天进步一点点(57)

    Java日常练习题,每天进步一点点(57)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-08-08
  • javaweb判断当前请求是否为移动设备访问的方法

    javaweb判断当前请求是否为移动设备访问的方法

    这篇文章主要为大家详细介绍了javaweb判断当前请求是否为移动设备访问的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • 在java代码中获取JVM参数的方法

    在java代码中获取JVM参数的方法

    下面小编就为大家带来一篇在java代码中获取JVM参数的方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01
  • Java 自定义注解在登录验证的应用示例

    Java 自定义注解在登录验证的应用示例

    本文主要介绍了Java 自定义注解在登录验证的应用示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • Spring Security图形验证码的实现代码

    Spring Security图形验证码的实现代码

    本文介绍了如何在SpringSecurity自定义认证中添加图形验证码,首先需要在maven中添加相关依赖并创建验证码对象,然后通过Spring的HttpSessionSessionStrategy对象将验证码存储到Session中,感兴趣的朋友跟随小编一起看看吧
    2024-10-10
  • Java Map的compute方法举例详解

    Java Map的compute方法举例详解

    Java中的Map是一种用于存储键值对的数据结构,它提供了一系列的方法来操作和访问其中的元素,下面这篇文章主要给大家介绍了关于Java Map的compute方法举例详解的相关资料,需要的朋友可以参考下
    2024-06-06
  • 走进SpringBoot之配置文件与多环境详解

    走进SpringBoot之配置文件与多环境详解

    这篇文章主要介绍了走进SpringBoot之配置文件与多环境,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-05-05
  • Swing常用组件之多行文本区JTextArea

    Swing常用组件之多行文本区JTextArea

    这篇文章主要为大家详细介绍了Swing常用组件之多行文本区JTextArea,感兴趣的朋友可以参考一下
    2016-05-05

最新评论