首页 > 其他分享 >SpringBoot进行参数校验的方法详解

SpringBoot进行参数校验的方法详解

时间:2023-08-01 10:22:39浏览次数:31  
标签:SpringBoot 校验 value 详解 org import validation annotation

https://www.jb51.net/article/246275.htm

在日常的接口开发中,为了防止非法参数对业务造成影响,经常需要对接口的参数进行校验。本文通过示例详细讲解了SpringBoot如何进行参数校验的,感兴趣的可以学习一下

  +
目录

介绍

在日常的接口开发中,为了防止非法参数对业务造成影响,经常需要对接口的参数进行校验,例如登录的时候需要校验用户名和密码是否为空,添加用户的时候校验用户邮箱地址、手机号码格式是否正确。 靠代码对接口参数一个个校验的话就太繁琐了,代码可读性极差。

Validator框架就是为了解决开发人员在开发的时候少写代码,提升开发效率;Validator专门用来进行接口参数校验,例如常见的必填校验,email格式校验,用户名必须位于6到12之间等等。

接下来我们看看在SpringbBoot中如何集成参数校验框架。

1.SpringBoot中集成参数校验

1.1引入依赖

1 2 3 4 <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-validation</artifactId> </dependency>

1.2定义参数实体类

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 package com.didiplus.modules.sys.domain;   import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data;   import javax.validation.constraints.Email; import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotEmpty;   /**  * Author: didiplus  * Email: [email protected]  * CreateTime: 2022/4/25  * Desc: 字典类型领域模型  */   @Data @ApiModel(value = "字典类型") public class SysDictType {       @ApiModelProperty("ID")     private String id;       @NotBlank(message = "字典名称必填项")     @ApiModelProperty(value = "字典名称",example = "用户ID")     private String typeName;       @NotBlank(message = "字典编码不能为空")     @ApiModelProperty(value = "字典编码")     private String typeCode;       @Email(message = "请填写正确的邮箱地址")     @ApiModelProperty(value = "字典编码")     private String email;       @ApiModelProperty(value = "字典描述")     private String description;       @NotBlank(message = "字典状态不能为空")     @ApiModelProperty(value = "字典状态")     private String enable; }

常见的约束注解如下:

注解功能
@AssertFalse 可以为null,如果不为null的话必须为false
@AssertTrue 可以为null,如果不为null的话必须为true
@DecimalMax 设置不能超过最大值
@DecimalMin 设置不能超过最小值
@Digits 设置必须是数字且数字整数的位数和小数的位数必须在指定范围内
@Future 日期必须在当前日期的未来
@Past 日期必须在当前日期的过去
@Max 最大不得超过此最大值
@Min 最大不得小于此最小值
@NotNull 不能为null,可以是空
@Null 必须为null
@Pattern 必须满足指定的正则表达式
@Size 集合、数组、map等的size()值必须在指定范围内
@Email 必须是email格式
@Length 长度必须在指定范围内
@NotBlank 字符串不能为null,字符串trim()后也不能等于""
@NotEmpty 不能为null,集合、数组、map等size()不能为0;字符串trim()后可以等于""
@Range 值必须在指定范围内
@URL 必须是一个URL

1.3定义校验类进行测试

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 package com.didiplus.modules.sys.controller;   import com.didiplus.modules.sys.domain.SysDictType; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.parameters.RequestBody; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.PutMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;   /**  * Author: didiplus  * Email: [email protected]  * CreateTime: 2022/4/25  * Desc: 数据字典控制器  */ @RestController @Api(tags = "数据字典") @RequestMapping("/api/sys/dictType") public class SysDictTypeController {       @ApiOperation("字典添加")     @PostMapping("/add")     public SysDictType add(@Validated @RequestBody SysDictType sysDictType) {         return  sysDictType;     }       @ApiOperation("字典修改")     @PutMapping("/edit")     public SysDictType edit(@Validated @RequestBody SysDictType sysDictType) {         return  sysDictType;     }     }

这里我们先定义两个方法add,edit,都是使用了 @RequestBody注解,用于接受前端发送的json数据。

1.4打开接口文档模拟提交数据

通过接口文档看到前三个字段都是必填项。

由于email的格式不对就被拦截了,提示是因为邮箱地址不对。

2.参数异常加入全局异常处理器

虽然我们之前定义了全局异常拦截器,也看到了拦截器确实生效了,但是Validator校验框架返回的错误提示太臃肿了,不便于阅读,为了方便前端提示,我们需要将其简化一下。

直接修改之前定义的 RestExceptionHandler,单独拦截参数校验的三个异常:

javax.validation.ConstraintViolationException

org.springframework.validation.BindException

org.springframework.web.bind.MethodArgumentNotValidException

代码如下:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 package com.didiplus.common.web.response.Handler;   import com.didiplus.common.web.response.Result;   import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.validation.BindException; import org.springframework.validation.ObjectError; import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice;   import javax.validation.ConstraintViolation; import javax.validation.ConstraintViolationException; import javax.validation.ValidationException;   import java.util.stream.Collectors;   /**  * Author: didiplus  * Email: [email protected]  * CreateTime: 2022/4/24  * Desc:  默认全局异常处理。  */ @RestControllerAdvice public class RestExceptionHandler {     /**      * 默认全局异常处理。      * @param e the e      * @return ResultData      */     @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})     public ResponseEntity<Result<String>> handleValidatedException(Exception e) {             Result<String>  result = null;             if (e instanceof  MethodArgumentNotValidException) {                 MethodArgumentNotValidException ex =(MethodArgumentNotValidException)  e;                 result = Result.failure(HttpStatus.BAD_REQUEST.value(),                                 ex.getBindingResult().getAllErrors().stream()                                         .map(ObjectError::getDefaultMessage)                                         .collect(Collectors.joining(";"))                                 );             } else  if (e instanceof ConstraintViolationException){                 ConstraintViolationException ex = (ConstraintViolationException) e;                 result = Result.failure(HttpStatus.BAD_REQUEST.value(),                                         ex.getConstraintViolations().stream()                                                 .map(ConstraintViolation::getMessage)                                                 .collect(Collectors.joining(";"))                                         );             }else  if (e instanceof BindException) {                 BindException  ex = (BindException ) e;                 result = Result.failure(HttpStatus.BAD_REQUEST.value(),                                         ex.getAllErrors().stream()                                                 .map(ObjectError::getDefaultMessage)                                                 .collect(Collectors.joining(";"))                                         );             }             return new ResponseEntity<>(result,HttpStatus.BAD_REQUEST);     } }

美化之后错误信息提示更加友好

3.自定义参数校验

虽然Spring Validation 提供的注解基本上够用,但是面对复杂的定义,我们还是需要自己定义相关注解来实现自动校验。
比如上面实体类中添加的sex性别属性,只允许前端传递传 M,F 这2个枚举值,如何实现呢?

3.1创建自定义注解

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 package com.didiplus.common.annotation;   import javax.validation.Constraint; import javax.validation.Payload; import java.lang.annotation.Documented; import java.lang.annotation.Repeatable; import java.lang.annotation.Retention; import java.lang.annotation.Target;   import static java.lang.annotation.ElementType.*; import static java.lang.annotation.RetentionPolicy.RUNTIME;   /**  * Author: didiplus  * Email: [email protected]  * CreateTime: 2022/4/26  * Desc:  */ @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE}) @Retention(RUNTIME) @Repeatable(EnumString.List.class) @Documented @Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执行校验逻辑 public @interface EnumString {       String message() default "value not in enum values.";       Class<?>[] groups() default {};       Class<? extends Payload>[] palyload() default {};     /**      * @return date must in this value array      */     String[] value();       /**      * Defines several {@link EnumString} annotations on the same element.      *      * @see EnumString      */     @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})     @Retention(RUNTIME)     @Documented     @interface List {           EnumString[] value();     }     }

3.2自定义校验逻辑

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 package com.didiplus.common.annotation;   import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; import java.util.Arrays; import java.util.List;     /**  * Author: didiplus  * Email: [email protected]  * CreateTime: 2022/4/26  * Desc:  */ public class EnumStringValidator implements ConstraintValidator<EnumString,String> {     private List<String> enumStringList;       @Override     public void initialize(EnumString constraintAnnotation) {         enumStringList = Arrays.asList(constraintAnnotation.value());       }       @Override     public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {         if(value == null) {             return true;         }         return enumStringList.contains(value);     } }

3.3在字段上增加注解

1 2 3 @ApiModelProperty(value = "性别") @EnumString(value = {"F","M"}, message="性别只允许为F或M") private String sex;

3.4体验效果

4.分组校验

一个对象在新增的时候某些字段是必填,在更新是有非必填。如上面的 SysDictTypeid 属性在新增操作时都是必填。 面对这种场景你会怎么处理呢?

其实 Validator校验框架已经考虑到了这种场景并且提供了解决方案,就是分组校验。 要使用分组校验,只需要三个步骤:

4.1定义分组接口

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 package com.didiplus.common.base;   import javax.validation.groups.Default;   /**  * Author: didiplus  * Email: [email protected]  * CreateTime: 2022/4/26  * Desc:  */ public interface ValidGroup extends Default {       interface Crud extends ValidGroup{         interface Create extends Crud{           }           interface Update extends Crud{           }           interface Query extends Crud{           }           interface Delete extends Crud{           }     } }

4.2在模型中给参数分配分组

1 2 3 4 @Null(groups = ValidGroup.Crud.Create.class) @NotNull(groups = ValidGroup.Crud.Update.class,message = "字典ID不能为空") @ApiModelProperty("ID") private String id;

4.3体现效果

以上就是SpringBoot进行参数校验的方法详解的详细内容,

标签:SpringBoot,校验,value,详解,org,import,validation,annotation
From: https://www.cnblogs.com/zhoading/p/17595728.html

相关文章

  • Linux 6.6+ Oracle RAC 12c搭建详解
    1. RedHatEnterpriseLinuxServerrelease6.6x86_64两台2. Oracle12.1.0.13. ASM存储方式4. 软件下载:http://www.oracle.com/technetwork/database/enterprise-edition/downloads/oracle12c-linux-12201-3608234.html 5. 基础安装包yum-yinstallbinutils.x86......
  • 【SpringBoot实现两级缓存】
    springboot中使用Caffeine+Redis实现二级缓存1.依赖准备首先确认Caffeine和redis这两者的依赖已导入(springboot版本为2.4.0):<!--redis与caffeine结合使用构成多级缓存--><dependency><groupId>org.springframework.boot</groupId><artifactId>sprin......
  • Mybatis学习(1)——mybatis介绍 & 入门案例 & 全局配置文件详解 & 增删改查 + mybatis事
    Mybatis学习(1)——mybatis介绍&入门案例&全局配置文件详解&增删改查+mybatis事务&mapper.xml文件#{}和${}&动态SQL入门原文链接:https://blog.csdn.net/Pireley/article/details/131520252目录引出一、mybatis是啥1.官网&ORM(ObjectRelationMapping)对象关......
  • Java中面向对象详解
    一.定义面向对象是:将事务高度抽象化的编程模式将问题分解成一个个小步骤,对每个步骤进行抽象,形成对象,通过不同的对象之间调用,组合解决问题。在进行面向对象进行编程时,要把属性、行为等封装成对象,然后基于这些对象及对象的能力进行业务逻辑的实现。创建一次,重复使用二.面向......
  • Mapper.xml详解 一对一 多对一 多对多
    Mapper.xml详解Mapper.xml详解一对一多对一多对多原文链接:https://blog.csdn.net/qq_36850813/article/details/80037363 我们知道,每一款框架产品在实际开发中,都是通过XML文件来培训框架的相关流程的,MyBatis也不例外,主要有两个配置文件:config.xml和Mapper.xml,当然,这两种配......
  • el-form一打开就提示校验的红色文字(不能为空等)的解决办法
    原因rules没有设置trigger校验触发的方式解决办法设置上即可,如:rules:{ username:[ {required:true,message:'该项不能为空',trigger:'blur'}//trigger:'blur' ], ...}......
  • JavaScript 浅拷贝和深拷贝详解
    一、基本数据类型和引用数据类型基本数据类型:1.Number(数字类型)2.String(字符串类型)3.Boolean(布尔类型)4.Null(空类型)5.Undefined(未定义类型)6.Symbol(符号类型)引用数据类型:Object(对象类型):表示一组无序的键值对,例如{name:'张三',age:18}。基本数据类型是简单的数据类型,它......
  • java 代理(静态代理、动态代理的不同实现)详解及示例
    文章目录一、代理构成1、代理介绍2、应用场景介绍二、静态代理1、示例1)、售票服务2)、售票3)、代售点服务4)、静态代理实现1、maven依赖2、实现三、动态代理1、InvocationHandler角色2、InvocationHandler的作用3、JDK的动态代理创建机制----通过接口1)、Proxy2)、InvocationHandler3)......
  • vscode创建springboot项目
    1、安装ExtensionPackforjava2、安装jdk11环境sudoaptinstallopenjdk-11-jdk-headless3、在项目目录下创建src/main/java/com/example/app.javaimportorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplicat......
  • Spring IOC实现原理详解之IOC体系结构设计 : 关于bean的生成我自己的理解;
    1、系统根据bean的配置信息(xml文件,groovy等),经过资源加载、解析配置后生成了一个关于bean的容器。2、bean容器会根据配置信息生成一个bean实例;3、将bean实例 和 一些其他配置信息生成的一些特殊的bean实例 都放入到bean的容器中;4、其他的类需要调用这些bean的时候,根据申......