AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

必须拿下的Springboot参数校验

2022-06-18 2085
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 参数校验

实际项目中不仅仅前端需要做必填项等校验，为防止非法参数对业务造成影响，后端也需要对相关参数做校验，接下来就学习一下在Springboot项目中如何对参数进行校验。本文Springboot版本为2.6.8


引入依赖

如果Springboot版本小于2.3.x，spring-boot-starter-web会自动传入hibernate-validator依赖。如果Springboot版本大于2.3.x，则需要手动引入依赖： 温馨提示：7.x.x版本可能会不起效

<!--https://mvnrepository.com/artifact/org.hibernate/hibernate-validator --><dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.2.0.Final</version></dependency>

或者直接引入springboot的场景启动器

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

@Validated和@Valid区别

@Validated对@Valid进行了二次封装，但是二者有以下的区别：


  1. @Validated提供分组功能，可以在参数验证时，根据不同的分组采用不同的验证机制。@Valid没有分组功能
  2. @Validated用在类型、方法和方法参数上。但不能用于成员属性（field），@Valid可以用在方法、构造函数、方法参数和成员属性（field）上
  3. 一个待验证的pojo类，其中还包含了待验证的对象属性，需要在待验证对象上注解@Valid，才能验证待验证对象中的成员属性，这里不能使用@Validated

统一异常处理

如果校验不通过会报MethodArgumentNotValidException或者 ConstraintViolationException】

@RestControllerAdvicepublicclassParamException {
@ExceptionHandler({MethodArgumentNotValidException.class})
@ResponseStatus(HttpStatus.BAD_REQUEST)
publicResultReturnhandleMethodArgumentNotValidException(MethodArgumentNotValidExceptionex) {
BindingResultbindingResult=ex.getBindingResult();
StringBuildersb=newStringBuilder("校验失败:");
for (FieldErrorfieldError : bindingResult.getFieldErrors()) {
sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
Stringmsg=sb.toString();
returnResultReturnUtil.fail(ErrorCodeEnum.PARAM_ERROR.getCode(),msg);
    }
@ExceptionHandler({ConstraintViolationException.class})
@ResponseStatus(HttpStatus.BAD_REQUEST)
publicResultReturnhandleConstraintViolationException(ConstraintViolationExceptionex) {
returnResultReturnUtil.fail(ErrorCodeEnum.PARAM_ERROR.getCode(),ex.getMessage());
    }
}

我们可以把要返回的错误信息定义在枚举中

@Getter@ToStringpublicenumErrorCodeEnum {
PARAM_ERROR(10001,"参数错误");
privateIntegercode;
privateStringmsg;
ErrorCodeEnum(Integercode, Stringmsg) {
this.code=code;
this.msg=msg;
    }
}

再来个统一返回格式

@DatapublicclassResultReturnimplementsSerializable {
privatestaticfinallongserialVersionUID=5805792987639183304L;
privateIntegercode;
privateStringmsg;
privateObjectdata;
publicResultReturn(){
super();
    }
publicResultReturn(Integercode, Stringmsg){
this.code=code;
this.msg=msg;
    }
publicResultReturn(Integercode, Stringmsg, Objectdata){
this.code=code;
this.msg=msg;
this.data=data;
    }
}
publicclassResultReturnUtil {
/*** 成功 返回默认码值* @param msg* @return*/publicstaticResultReturnsuccess(Stringmsg){
returnnewResultReturn(0,msg);
    }
/*** 成功  返回自定义码值* @param code* @param msg* @return*/publicstaticResultReturnsuccess(Integercode, Stringmsg){
returnnewResultReturn(code,msg);
    }
publicstaticResultReturnsuccess(Stringmsg, Objectdata){
returnnewResultReturn(0,msg,data);
    }
publicstaticResultReturnfail(Stringmsg){
returnnewResultReturn(-1,msg);
    }
publicstaticResultReturnfail(Integercode, Stringmsg){
returnnewResultReturn(code,msg);
    }
}

RequestBody参数校验

当我们使用POST、PUT请求时会使用 @RequestBody+实体类 来接收参数。此时只需要给实体类加上@Validated注解就能实现自动参数校验。

@RestControllerpublicclassTestController {
@PostMapping("/addUser")
publicBooleanaddUser(@RequestBody@ValidatedUseruser){
//忽略service处理相关业务returntrue;
    }
}

那么具体到每个参数的校验则需要在实体类中处理。

@DatapublicclassUser {
privateLongid;
@NotBlank(message="用户账号不能为空")
@Length(min=4, max=10,message="账号长度为4-10位")
privateStringuserName;
@NotBlank(message="密码不能为空")
@Length(min=6,max=12,message="密码长度为6-12位")
privateStringpassword;
@NotNull(message="邮箱不能为空")
@Email(message="邮箱格式错误")
privateStringemail;
/*** 性别 1为男生  2为女生*/@Min(value=1,message="最小值为1")
@Max(value=2,message="最大值为2")
privateIntegersex;
}

先请求一次试试

image.png

requestParam/PathVariable参数校验

这种方式下参数都较少，必须在Controller类上标注@Validated注解，并在入参上声明约束注解

image.png

接下来请求试一下

image.png

特殊情况

也是上文提到的，pojo参数中有对象属性，那么要对这个对象中的属性校验该怎么做？

比如我这里有个学生类

@DatapublicclassStudent {
@NotBlank(message="用户名不能为空")
privateStringname;
@Min(value=10, message="年龄不能小于10岁")
privateIntegerage;
@Email(message="邮箱格式错误")
privateStringemail;
@NotBlank(message="班级名不能为空")
privateStringclassName;
@NotEmpty(message="任课老师不能为空")
@Size(min=1, message="至少有一个老师")
privateList<Teacher>teachers;
}
@DatapublicclassTeacher {
@NotBlank(message="老师姓名不能为空")
privateStringteacherName;
@Min(value=1, message="学科类型从1开始计算")
privateIntegertype;
}

测试一下

image.png

很明显这个type的值并不符合要求， 需要在学生类的教师属性上加上@Valid注解

image.png

image.png

参数校验注解大全

 

注解 作用类型 解释

null是否

能通过验证
@AssertFalse Boolean、boolean 该字段值为false时，验证才能通过 YES
@AssertTrue Boolean、boolean 该字段值为true时，验证才能通过 YES
@DecimalMax  数字类型（原子和包装） 验证小数的最大值
@DecimalMax(value="12.35")privatedouble money;

 

 YES
@DecimalMin 数字类型（原子和包装） 验证小数的最小值 YES
@Digits 数字类型（原子和包装） 验证数字的整数位和小数位的位数是否超过指定的长度
@Digits(integer =2, fraction =2)privatedouble money;

 

 YES
@Email String 该字段为Email格式，才能通过 YES
@Future 时期、时间 验证日期是否在当前时间之后，否则无法通过校验
@FutureprivateDate date;

 

 YES
@FutureOrPresent 时期、时间 时间在当前时间之后 或者等于此时 YES
@Max 数字类型（原子和包装） 
//该字段的最大值为18，否则无法通过验证@Max(value=18)privateInteger age;

 

 YES
@Min 数字类型（原子和包装） 同上，不能低于某个值否则无法通过验证 YES
@Negative   数字<0 YES
@NegativeOrZero   数字=<0 YES
@NotBlank String 该注解用来判断字符串或者字符，只用在String上面

字符串不能为null,字符串trim()后也不能等于“”

 NO
@NotEmpty String、集合、数组、Map、链表List

不能为null，不能是空字符，集合、数组、map等size()不能为0；字符串trim()后可以等于“”

 NO
@NotNull 任何类型 使用该注解的字段的值不能为null，否则验证无法通过 NO
@Null   修饰的字段在验证时必须是null，否则验证无法通过 YES
@Past 时间、日期 验证日期是否在当前时间之前，否则无法通过校验,必须是一个过去的时间或日期 YES
@PastOrPresent 时间、日期 验证日期是否在当前时间之前或等于当前时间 YES
@Pattern   用于验证字段是否与给定的正则相匹配
@Pattern(regexp ="正则")privateString name;

 

 YES
@Positive   数字>0 YES
@PositiveOrZero   数字>=0 YES
@Size 字符串String、集合Set、数组Array、Map，List
 
修饰的字段长度不能超过5或者低于1@Size(min =1, max =5)privateString name;

集合、数组、map等的size()值必须在指定范围内

//只能一个@Size(min =1, max =1)privateList<String> names;

 

  YES
文章标签：
Java
前端开发
关键词：
Spring Boot参数
Spring Boot校验
Spring boot参数校验
springboot参数校验
LoneWalker、
目录
相关文章
2的n次方_
|
3月前
|
JSON 前端开发 Java
Spring MVC——获取参数和响应
本文介绍了如何在Spring框架中通过不同的注解和方法获取URL参数、上传文件、处理cookie和session、以及响应不同类型的数据。具体内容包括使用`@PathVariable`获取URL中的参数，使用`MultipartFile`上传文件，通过`HttpServletRequest`和`@CookieValue`获取cookie，通过`HttpSession`和`@SessionAttribute`获取session，以及如何返回静态页面、HTML代码片段、JSON数据，并设置HTTP状态码和响应头。
2的n次方_
83 1
Spring MVC——获取参数和响应
运营研究坊
|
4月前
|
缓存 前端开发 Java
springboot 的单体服务 字典参数转译
本文介绍了如何在Spring Boot项目中使用缓存来管理字典参数，并确保前后端数据一致性。首先，通过`@EnableCaching`启用缓存功能，接着创建一个自定义的字典缓存类`DicCache`。然后，通过配置类将`DicCache`添加到`cacheManager`中。此外，对字典服务进行改造，使用`@CachePut`和`@CacheEvict`注解保证数据一致性。最后，实现自定义注解`@DicSerializer`和序列化处理类`DictSerializerHandel`，用于在序列化过程中自动转换字典值。通过这种方式，可最小化代码改动并提高系统性能。
运营研究坊
58 6
springboot 的单体服务 字典参数转译
明弟有理想
|
3月前
|
JSON NoSQL Java
springBoot:jwt&redis&文件操作&常见请求错误代码&参数注解 (九)
该文档涵盖JWT（JSON Web Token）的组成、依赖、工具类创建及拦截器配置，并介绍了Redis的依赖配置与文件操作相关功能，包括文件上传、下载、删除及批量删除的方法。同时，文档还列举了常见的HTTP请求错误代码及其含义，并详细解释了@RequestParam与@PathVariable等参数注解的区别与用法。
明弟有理想
38 2
椰椰椰耶
|
3月前
|
前端开发 Java Spring
【Spring】“请求“ 之传递单个参数、传递多个参数和传递对象
【Spring】“请求“ 之传递单个参数、传递多个参数和传递对象
椰椰椰耶
157 2
艾利克斯冰
|
4月前
|
JSON Java 数据格式
springboot 参数统一处理
springboot 参数统一处理
艾利克斯冰
34 2
java冯坚持
|
3月前
|
监控 Java Maven
springboot学习二：springboot 初创建 web 项目、修改banner、热部署插件、切换运行环境、springboot参数配置，打包项目并测试成功
这篇文章介绍了如何快速创建Spring Boot项目，包括项目的初始化、结构、打包部署、修改启动Banner、热部署、环境切换和参数配置等基础操作。
java冯坚持
187 0
WXM
|
4月前
|
Java
SpringBoot使用总结之切面、参数拦截+过滤
WXM
131 9
艾利克斯冰
|
4月前
|
Java Spring
spring boot 启动项目参数的设定
spring boot 启动项目参数的设定
艾利克斯冰
42 0
热爱技术的小郑
|
5月前
|
XML Java 数据库
Spring5入门到实战------15、事务操作---概念--场景---声明式事务管理---事务参数--注解方式---xml方式
这篇文章是Spring5框架的实战教程，详细介绍了事务的概念、ACID特性、事务操作的场景，并通过实际的银行转账示例，演示了Spring框架中声明式事务管理的实现，包括使用注解和XML配置两种方式，以及如何配置事务参数来控制事务的行为。
热爱技术的小郑
69 0
Spring5入门到实战------15、事务操作---概念--场景---声明式事务管理---事务参数--注解方式---xml方式
土木林森
|
5月前
|
Java API 数据格式
Spring Boot API参数读取秘籍大公开！6大神器助你秒变参数处理大师，让你的代码飞起来！
【8月更文挑战第4天】Spring Boot凭借其便捷的开发和配置特性，成为构建微服务的热门选择。高效处理HTTP请求参数至关重要。本文介绍六种核心方法：查询参数利用`@RequestParam`；路径变量采用`@PathVariable`；请求体通过`@RequestBody`自动绑定；表单数据借助`@ModelAttribute`或`@RequestParam`；请求头使用`@RequestHeader`；Cookie则依靠`@CookieValue`。每种方法针对不同场景，灵活运用可提升应用性能与用户体验。
土木林森
86 9

热门文章

最新文章

  • 1
    SpringMvc+Spring+MyBatis 基于注解整合
  • 2
    Spring Cloud Alibaba 实操 (六) Sentinel限流
  • 3
    Spring（17）——对JSR330标准的支持
  • 4
    spring-注入对象map
  • 5
    轻松了解Spring中的控制反转和依赖注入（二）
  • 6
    spring 源码之模板设计模式
  • 7
    spring-编程式事务管理
  • 8
    Spring Boot中使用EasyPoi入门
  • 9
    spring quartz分布式任务计划
  • 10
    Spring + lombok+ @Qualifier使用
  • 1
    springboot 启动原理、启动过程、启动机制的介绍
    554
  • 2
    springboot实现文件防盗链设计
    134
  • 3
    Spring Boot中一般如何使用线程池？
    806
  • 4
    Spring Boot 源码面试知识点
    106
  • 5
    【MongoDB 专栏】MongoDB 与 Spring Boot 的集成实践
    269
  • 6
    深入探索Spring Boot Web应用源码及实战应用
    119
  • 7
    ruoyi-nbcio从spring2.7.18升级springboot到3.1.7，java从java8升级到17（二）
    382
  • 8
    springboot数据库回滚失败原因
    67
  • 9
    springboot全局自定义异常
    48
  • 10
    springBoot+rabbit消息获取和消息确认
    149

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第四阶段
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库

    • 相关实验场景

    更多
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    DataWorks智能交互式数据开发与分析之旅