还在写一堆if语句来校验前端传过来的参数吗?来看看spring boot如何优雅的处理参数校验

本文主要是介绍还在写一堆if语句来校验前端传过来的参数吗?来看看spring boot如何优雅的处理参数校验,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 前言
  • 使用方法
  • 常用的注解类型
    • @Pattern
    • @AssertFalse
    • @AssertTrue
    • @NotNull
    • @Null
    • @NotEmpty
    • @NotBlank
    • @DecimalMax
    • @DecimalMin
    • @Max
    • @Min
    • @Negative
    • @NegativeOrZero
    • @Positive
    • @PositiveOrZero
    • @Digits
    • @Email
    • @Future
    • @FutureOrPresent
    • @Past
    • @PastOrPresent
    • @Size
    • @Valid

前言

还在为接口写一堆if语句校验参数吗?快来使用@Validated 校验你的参数吧,写法优雅,逻辑清晰,你值得拥有。

spring boot中已经引入了@Validated 的基础包,所以在spring boot项目中我们可以直接使用。

更新:

spring boot最新版已经默认去掉了参数校验的包,需要手动引入依赖。

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

使用方法

1、首先在Controller接口的参数上加上@Validated 注解,表示要校验这个参数:

/*** 添加员工信息** @param param* @return*/
@ApiOperation("添加员工信息")
@PostMapping("addEmp")
public ResponseEntity<Boolean> addEmp(@RequestBody @Validated AddEmpParam param){return ResponseEntity.success(empService.addEmp(param));
}

2、然后在Bean上声明需要被校验的字段:

/*** 添加员工参数实体* @author ZhengNC* @date 2020/5/24 16:57*/
@ApiModel("添加员工参数实体")
@Data
public class AddEmpParam {/*** 手机号*/@ApiModelProperty("手机号")@NotBlank(message = "手机号不能为空")private String phone;/*** 姓名*/@ApiModelProperty("姓名")@NotBlank(message = "姓名不能为空")private String name;/*** 性别:0 未知,1男,2女*/@ApiModelProperty("性别:0 未知,1男,2女")@NotNull(message = "性别不能为空")@Min(value = 0, message = "性别输入错误")@Max(value = 2, message = "性别输入错误")private Integer sex;/*** 年龄*/@ApiModelProperty("年龄")@Min(value = 18, message = "年龄不能低于18岁")private Integer age;/*** 身份证*/@ApiModelProperty("身份证")@Pattern(regexp = "^\\d{15}|\\d{18}|\\d{17}(\\d|X|x)$", message = "身份证号码错误")private String idCard;}

3、最后,如果校验不通过就会抛出异常,可以在统一异常处理类中处理这些异常:

/*** 全局异常处理* @author ZhengNC* @date 2020/5/24 20:17*/
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {/*** 处理实体类参数校验异常* @param e* @return*/@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity handleMethodArgumentNotValidException(MethodArgumentNotValidException e){return ResponseEntity.paramFailed(e.getBindingResult().getFieldError().getDefaultMessage());}/*** 处理方法参数校验异常* @param e* @return*/@ExceptionHandler(ConstraintViolationException.class)public ResponseEntity handleConstraintViolationException(ConstraintViolationException e){if (e.getConstraintViolations().size() > 0){return ResponseEntity.paramFailed(((ConstraintViolation)e.getConstraintViolations().toArray()[0]).getMessageTemplate());}return ResponseEntity.paramFailed();}/*** 处理SpringWeb参数校验异常* @param e* @return*/@ExceptionHandler(MissingServletRequestParameterException.class)public ResponseEntity handleMissingServletRequestParameterException(MissingServletRequestParameterException e){return ResponseEntity.paramFailed();}/*** 处理自定义响应类异常* @param e* @return*/@ExceptionHandler(ResponseException.class)public ResponseEntity handleResponseException(ResponseException e){log.error("{}", e.getStackTrace());return ResponseEntity.failed(e.getCode(), e.getMessage());}/*** 处理所有的运行时异常* @param e* @return*/@ExceptionHandler(RuntimeException.class)public ResponseEntity handleRuntimeException(RuntimeException e){log.error("{}", e.getStackTrace());e.printStackTrace();return ResponseEntity.failed();}
}

常用的注解类型

@Pattern

校验的字符串必须满足指定的正则表达式

例:@Pattern(regexp = “^\d{15}|\d{18}|\d{17}(\d|X|x)$”, message = “身份证号码错误”)

可用类型:字符串

注意: null可以校验通过

@AssertFalse

校验的元素一定是假的

可用类型:boolean、Boolean

注意: null可以校验通过

@AssertTrue

校验的元素一定是真的

可用类型:boolean、Boolean

注意: null可以校验通过

@NotNull

不能为null

可用类型:所有

@Null

必须为null

可用类型:所有

@NotEmpty

不能为null且不能为空

可用类型:字符串、集合、Map、数组

@NotBlank

不能为null且至少有一个非空白字符

可用类型:字符串

@DecimalMax

校验的元素必须是数字,小数和整数都可以,且必须小于或等于指定的最大值(value为字符串类型)

可用类型:BigDecimal、BigInteger、字符串、(byte、short、int、long)以及它们的包装类型

注意: double和float不支持,null可以校验通过

@DecimalMin

校验的元素必须是数字,小数和整数都可以,且必须大于或等于指定的最小值(value为字符串类型)

可用类型:BigDecimal、BigInteger、字符串、(byte、short、int、long)以及它们的包装类型

注意: double和float不支持,null可以校验通过

@Max

校验的元素必须是数字,小数和整数都可以,且必须小于或等于指定的最大值(value为long类型)

可用类型:BigDecimal、BigInteger、(byte、short、int、long)以及它们的包装类型

PS:经验证 字符串 也是支持的类型

注意: double和float不支持,null可以校验通过

@Min

校验的元素必须是数字,小数和整数都可以,且必须大于或等于指定的最小值(value为long类型)

可用类型:BigDecimal、BigInteger、(byte、short、int、long)以及它们的包装类型

PS:经验证 字符串 也是支持的类型

注意: double和float不支持,null可以校验通过

@Negative

校验的元素必须是数字,且必须小于0

可用类型:BigDecimal、BigInteger、(byte、short、int、long、float、double)以及它们的包装类型

注意: null可以校验通过

@NegativeOrZero

校验的元素必须是数字,且必须小于或等于0

可用类型:BigDecimal、BigInteger、(byte、short、int、long、float、double)以及它们的包装类型

注意: null可以校验通过

@Positive

校验的元素必须是数字,且必须大于0

可用类型:BigDecimal、BigInteger、(byte、short、int、long、float、double)以及它们的包装类型

注意: null可以校验通过

@PositiveOrZero

校验的元素必须是数字,且必须大于或等于0

可用类型:BigDecimal、BigInteger、(byte、short、int、long、float、double)以及它们的包装类型

注意: null可以校验通过

@Digits

校验数字的精度,参数integer为整数位最大长度,fraction为小数位最大长度。

例如:@Digits(integer = 3, fraction = 1, message = “校验未通过”) //表示整数位最多3位,小数位最多1位

可用类型:BigDecimal、BigInteger、字符串、(byte、short、int、long)以及它们的包装类型

注意: null可以校验通过,参数fraction对小数位的校验只对BigDecimal和String生效,对于其它类型这个参数无效

@Email

校验的元素必须是一个结构完整的电子邮件地址

可用类型:字符串

注意: null可以校验通过

@Future

校验的元素必须是未来的瞬间,日期或时间

可用类型:

  • java.util.Date

  • java.util.Calendar

  • java.time.Instant

  • java.time.LocalDate

  • java.time.LocalDateTime

  • java.time.LocalTime

  • java.time.MonthDay

  • java.time.OffsetDateTime

  • java.time.OffsetTime

  • java.time.Year

  • java.time.YearMonth

  • java.time.ZonedDateTime

  • java.time.chrono.HijrahDate

  • java.time.chrono.JapaneseDate

  • java.time.chrono.MinguoDate

  • java.time.chrono.ThaiBuddhistDate

注意: null可以校验通过

@FutureOrPresent

校验的元素必须是现在或是未来的瞬间,日期或时间

可用类型:和 @Future 的可用类型相同

注意: null可以校验通过

@Past

校验的元素必须是过去的瞬间,日期或时间

可用类型:和 @Future 的可用类型相同

注意: null可以校验通过

@PastOrPresent

校验的元素必须是现在或是过去的瞬间,日期或时间

可用类型:和 @Future 的可用类型相同

注意: null可以校验通过

@Size

校验元素的尺寸必须在指定的范围内(包含边界)

例:@Size(min = 1, max = 5, message = “校验未通过”)

可用类型:字符串(校验字符串长度)、集合(校验Size)、Map(校验Size)、数组(校验length)

注意: null可以校验通过

@Valid

声明对实体类校验(嵌套校验会用到)

例如:

@Valid
private AddEmpParam empParam;

注意: null可以校验通过

这篇关于还在写一堆if语句来校验前端传过来的参数吗?来看看spring boot如何优雅的处理参数校验的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

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. 方法注

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED(默认)2.2 SUPPORTS2

怎样通过分析GC日志来定位Java进程的内存问题

《怎样通过分析GC日志来定位Java进程的内存问题》:本文主要介绍怎样通过分析GC日志来定位Java进程的内存问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、GC 日志基础配置1. 启用详细 GC 日志2. 不同收集器的日志格式二、关键指标与分析维度1.