当前位置:首页 > 数码 > SpringBoot接口参数校验N种适用技巧大揭秘 (springernature)

SpringBoot接口参数校验N种适用技巧大揭秘 (springernature)

admin1个月前 (04-18)数码14

环境:SpringBoot2.6.12

实践的开发上班中大部分的接口都是须要启动参数有效性校验的,参数或者是便捷的基本数据类型,也或者是对象类型,基本上一切接纳参数的接口都是须要对这些参数启动校验的,你对这些参数是怎样校验的?接上去带你一同见识下我在实践名目中都运行过哪些校验姿态!。该案例会详细引见如下7方面的内容。

在正式引见主体内容前咱们还是先要了解学习一些规范JSR303。

JSR是什么?

JSR是SpecificationRequests的缩写,意思是Java规范提案。是指向JCP(JavaCommunityProcess)提出新增一个规范化技术规范的正式恳求。任何人都可以提交JSR,以向Java平台削减新的API和服务。JSR已成为Java界的一个关键规范。JSR-303是JAVAEE6中的一项子规范,叫做BeanValidation,HibernateValidator是BeanValidation的参考成功.HibernateValidator提供了JSR303规范中一切内置constrnt的成功,除此之外还有一些附加的constraint。关系注解如下:

图片

在Spring中提供了SpringValidation验证框架对参数的验证机制提供了@Validated(Spring'sJSR-303规范,是规范JSR-303的一个变种),javax提供了@Valid(规范JSR-303规范),联合BindingResult对象可以间接失掉失误信息。在本案中这两种是等效的,然而也有区别,在接上去的案例中将会说明。

1.性能依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.aspectj</groupId><artifactId>aspectjrt</artifactId></dependency><dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId><scope>runtime</scope></dependency></dependencies>

org.aspectj依赖是在最后咱们要经过AOP技术来成功一致参数的校验。

2.参数验证

publicclassUsers{@NotEmpty(message="姓名必需填写")privateStringname;@Min(value=10,message="年龄不能小于10")privateIntegerage;@Length(min=6,max=18,message="邮箱介于6到18之间")privateStringemail;@NotEmpty(message="电话必需填写")privateStringphone;//这里的2个接口在上方的案例中会经常使用到publicstaticinterfaceG1{}publicstaticinterfaceG2{}}

这里对须要校验的字段都运行了不同的注解来解放。接上去就是在Controller接口上参与相应的注解即可:

@ResponseBodypublicclassUsersControllerextendsBaseController{@RequestMing(value="/valid/save1",method=RequestMethod.POST)publicObjectsave1(@RequestBody@ValidatedUsersuser,BindingResultresult){Optional<List<String>>op=valid(result);if(op.isPresent()){returnop.get();}return"success";}}publicclassBaseController{protectedOptional<List<String>>valid(BindingResultresult){if(result.hasErrors()){returnOptional.of(result.getAllErrors().stream().map(err->err.getDefaultMessage()).collect(Collectors.toList()));}returnOptional.empty();}}

接纳参数的Users对象前面要是用@Validated注解,并且经过BindingResult来搜集失误信息(可判别能否有失误信息);测试如下:

图片

正确状况

图片

有些时刻咱们这一个对象或者会运行到不同的场景,产生不同的校验规定该怎样做呢?这时刻咱们就可以运行分组性能,不同的运行场景指明不同的分组即可,开局撸。留意:JSR303是没有分组性能的。

publicclassUsers{@NotEmpty(message="姓名不能为空",groups=G1.class)privateStringname;@Min(value=10,message="年龄不能小于10",groups=G1.class)@Min(value=20,message="年龄不能小于20",groups=G2.class)privateIntegerage;@Length(min=6,max=18,message="邮箱介于6到18之间",groups={G1.class,G2.class})privateStringemail;@NotEmpty(message="电话必需填写")privateStringphone;publicstaticinterfaceG1{}publicstaticinterfaceG2{}}

这里不同的字段上加了groups属性,指明属于哪个分组。留意在该实体类中咱们又定义了2个类G1,G2就是为了分组用的(详细指明哪个分组)。接口处置:

@RequestMapping(value="/valid/save1",method=RequestMethod.POST)publicObjectsave1(@RequestBody@Validated(Users.G1.class)Usersuser,BindingResultresult){Optional<List<String>>op=valid(result);if(op.isPresent()){returnop.get();}return"success";}@RequestMapping(value="/valid/save2",method=RequestMethod.POST)publicObjectsave2(@RequestBody@Validated(Users.G2.class)Usersuser,BindingResultresult){Optional<List<String>>op=valid(result);if(op.isPresent()){returnop.get();}return"success";}

在这个两个接口中@Validated(Users.G2.class)区分指明了自己的分组,接上去测试看看成果。

分组G1测试:

图片

从这里前往的信息来看咱们的phone只管写了@NotEmpty然而并没有起作用,由于咱们并没有指明他的分组,并且接口上咱们指明了是用G1分组。

分组G2测试:

图片

在这个接口中发现name验证是G1的,所以这里不会启动校验,并且年龄的判别是不能小于20了。

单个参数的校验不须要实体对象,普通就是吧JSR303关系的注解间接运行到接口参数上即可。同时还须要在Controller类上参与@Validated注解。

@ValidatedpublicclassUsersControllerextendsBaseController{@PackMapping("/valid/find")publicObjectfind(@NotEmpty(message="参数Id不能为空")Stringid){return"查问到参数【"+id+"】";}}

该接口中间接将注解运行到参数上。测试:

图片

同时控制台会输入如下意外:

图片

你也发现这种意外信息揭示很不友好,接上去咱们做个便捷的部分意外处置。

咱们只要要在Controller参与如下方法即可:

springernature@ExceptionHandler(ConstraintViolationException.class)@ResponseBodypublicObjectConstraintViolationExceptionHandler(ConstraintViolationExceptione){Stringmessage=e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());returnmessage;}

在该Controller中咱们参与了一个意外处置句柄(便捷吧将失误信息输入)。

图片

在实践的上班中往往参数对象比这复杂的多,Users对象中或者还嵌套有其余的对象,这个其余的对象也或者须要参数的校验。接上去咱们就来看看这种嵌套参数是如何校验的。

publicclassUsers{@NotEmpty(message="姓名不能为空",groups=G1.class)privateStringname;@Min(value=10,message="年龄不能小于10",groups=G1.class)@Min(value=20,message="年龄不能小于20",groups=G2.class)privateIntegerage;@Length(min=6,max=18,message="邮箱介于6到18之间",groups={G1.class,G2.class})privateStringemail;@NotEmpty(message="电话必需填写")privateStringphone;@ValidprivateAddressaddress;}

留意:嵌套对象Address的校验须要在上方加@Valid注解。

publicclassAddress{@NotEmpty(message="地址信息必需填写")privateStringaddr;}

测试接口:

@RequestMapping(value="/valid/save3",method=RequestMethod.POST)publicObjectsave3(@RequestBody@ValidatedUsersuser,BindingResultresult){Optional<List<String>>op=valid(result);if(op.isPresent()){returnop.get();}return"success";}

接口上没有什么特意的与之前的如出一辙。留意:这里的校验没有设定分组,所以校验时都是校验的没有设置分组的字段。

测试:

图片

这里发现咱们的地址信息基本就没有启动校验。接着咱们吧参数变化下

图片

参数中咱们吧address字段设置上后参数启动校验了。接上去修正Users实体,吧Address自动new进去再启动测试

@ValidprivateAddressaddress=newAddress();

图片

发现即使咱们的入参没有address字段也能启动校验了,这里大家须要留意下。

请检查【技巧】API接口参数验证的必备神器,让你的代码更高效!

publicclassUsers{@NotEmpty(message="{name.notempty}",groups=G1.class)privateStringname;@Min(value=10,message="年龄不能小于10",groups=G1.class)@Min(value=20,message="年龄不能小于20",groups=G2.class)privateIntegerage;@Length(min=6,max=18,message="邮箱介于6到18之间",groups={G1.class,G2.class})privateStringemail;@NotEmpty(message="电话必需填写")privateStringphone;@ValidprivateAddressaddress=newAddress();}

留意这里的name字段中的message属性咱们经常使用了表白式的模式,而name.notempty为咱们在资源文件中定义的key。接上去,在resources/下新建如下属性文件:

图片

属性文件必定是ValidationMessages扫尾。自动文件及zh_CN内容:

name.notempty=姓名必需填写

en_US内容:

name.notempty=nameisrequire

测试:

图片

为了模拟英文环境,咱们须要设置恳求头Accept-Language:en-US

图片

显示了en_US.properties中定义的信息,到此国内化成功。

自定义注解标志须要启动一致参数校验处置的接口。

@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceEnableValidate{}

AOP切面类

@Component@AspectpublicclassValidateAspect{@Pointcut("@annotation(com.pack.params.valid.EnableValidate)")publicvoidvalid(){}@Before("valid()")publicvoidvalidateBefore(JoinPointjp){Object[]args=jp.getArgs();for(Objectarg:args){if(arginstanceofBindingResult){BindingResultresult=(BindingResult)arg;if(result.hasErrors()){Stringmessages=result.getAllErrors().stream().map(err->err.getDefaultMessage()).collect(Collectors.joining(","));thrownewParamsException(messages);}}}}}

定义了一个前置通知,阻拦标志有@EnableValidate注解的接口。假设无心外信息搜集失误信息而后抛出意外信息。测试:

@PackMapping(value="/valid/save1",method=RequestMethod.POST)@EnableValidatepublicObjectsave1(@RequestBody@Validated(Users.G1.class)Usersuser,BindingResultresult){Optional<List<String>>op=valid(result);if(op.isPresent()){returnop.get();}return"success";}

图片

到此咱们经过AOP技术成功了参数一致处置,然而这样输入失误信息很不友好,接上去咱们来完善下,经过全局意外通知阻拦处置。这里的意外信息咱们可以经过全局意外处置下格局。

终了!!!


Validated校验在springboot框架中的应用(教程版)

各位朋友大家好,我是 奋斗的小强001 ,本期更新的内容是: Validated校验在springboot框架中的应用。

前言

4.1网上业务处理

4.2系统业务处理

当输入不能满足条件时,就会抛出异常,而后统一由异常中心处理, 推荐方式2

如果一个类中包含了另外一个实体类,那么在上面加上@Validated即可,比如下面的

优缺点

优点: 统一接口校验方法,并且可以指定相应的异常信息,避免手动写if else判断参数是否合法

缺点: 在公用一个打开校验的接口时,校验有问题.需要在使用的时候考虑

注意事项

1、修改时如果不传此校验的参数会报错,所以修改时也应该传全参。

2、使用时需在接口参数前添加注解开启此校验。

3、使用注解时应抛出异常信息。默认的异常信息是英文。

4、建议大家使用的时候先结合大家的业务使用.

烧脑巨作,Spring Boot请求处理(常用参数注解使用)

注解:

该注解主要是用于rest风格的搭配使用,在请求路径中不再以k : v的形式给出请求参数与值;而是直接给定一个值。如果方法参数是一个Map<String, String>将会包含路径中所有的变量与值。

访问 :浏览器输入路径变量即可,以下是rest风格的get请求的展示,直接在地址栏发起请求就是一个get请求

获取所有访问路径上的请求参数:localhost:8080/ car/{id}/owner/{username}?age=19&inters=

该注解主要用于获取请求头header中的数据,客户端请求之后可以拿到一些头部携带的参数。支持传统的SpringMVC,也支持WebFlux响应式。如果方法参数是一个Map<String, String>将会包含所有的请求头与值

测试:

主要用于获取请求参数名称,设置参数是否可有可无以及默认值。

@RequestParam注解详解地址: /weixin_4380 …

主要用于获取Cookie值

主要用在 请求转发 时,如果页面无法直接跳转(如WEB-INF下的success页面)可以使用转发的手段。当进行转发时可以在请求中携带上请求的参数,转发会携带上一次请求的参数(一次完整的请求包括转发)

由于是同一次请求,因此也可以直接拿到原生的HttpServletRequest,然后从这里面拿参数和属性也都是可以的【获取request域属性】。

下面就体现了一种转发的思想

结果

主要获取表单或者ajax提交的内容,将表单中提交的参数与值获取全部获取出来。即获取请求体【所以请求必须是post请求--@PostMapping】,一般情况下都会使用@RequestBody注解将参数映射到pojo类的能力,但是要保证前后传入的参数名是一样的

上述是最常见的三种请求方式;而矩阵变量请求是今天的主角一种新的请求风格,严格来说矩阵变量的请求需要用到rest风格但是又不同于rest.

面试官:页面开发当中把cookie禁用了,session里面的内容怎么使用(找到)???

由上面源码知道首先可以知道这个注解是一个修饰在参数上的注解,并且可以在运行时被JVM虚拟机加载到。

由于SpringBoot中默认并没有开启矩阵变量的支持,直接关闭了矩阵变量。因此在使用的时候我们需要对SpringBoot自动装配的Bean对象进行手动的配置更改。

真正使得无法使用矩阵变量的原因是UrlPathHelper类中的removeSemicolonContent默认为true,即移除分号内容。

方法 :参照第一章说的SpringBoot三个自配置规则,利@configuration+WebMvcConfigurer自定义规则即可,因此为了开启矩阵变量的使用必须实现WebMvcConfigurer接口,完成对configurePathMatch方法的手动实现。而WebMvcConfigurer接口中所有的方法都是default的默认方法,因此可以使用适配器模式单独对该方法进行重写。所以可以在配置类中手动向IOC容器中配置一个Bean对象,该对象只对这一个方法进行重写实现即可。

重写如下

首先必须手动配置对矩阵变量的支持,其次矩阵变量是绑定在rest路径变量中的

上述两种路径都会使用同一个Controller进行处理,path拿到的就是 / 到第一个 ; 号之间的路径。

Gage绑定{gege}中的age参数,Dage绑定{didi}中的age;这样就能准确的区分出到底获取哪个age。

摘自/qq_…

现在大多数互联网项目都是采用前后端分离的方式开发,前端人员负责页面展示和数据获取,后端负责业务逻辑处理和接口封装。当与前端交互的过程当中,常用json数据与前端进行交互,这样想取出前端传送过来的json数据的时候,就需要用到@RequestBody这个注解。@RequestBody注解用于读取http请求的内容(字符串),通过springmvc提供的HttpMessageConverter接口将读到的内容转换为json、xml等格式的数据并绑定到controller方法的参数上。

提交方式为 POST 时,

获取参数的几种常用注解

免责声明:本文转载或采集自网络,版权归原作者所有。本网站刊发此文旨在传递更多信息,并不代表本网赞同其观点和对其真实性负责。如涉及版权、内容等问题,请联系本网,我们将在第一时间删除。同时,本网站不对所刊发内容的准确性、真实性、完整性、及时性、原创性等进行保证,请读者仅作参考,并请自行核实相关内容。对于因使用或依赖本文内容所产生的任何直接或间接损失,本网站不承担任何责任。

标签: SpringBoot

“SpringBoot接口参数校验N种适用技巧大揭秘 (springernature)” 的相关文章

SpringBoot-Redis-处置海量重复提交疑问的片面指南 (springboot启动)

SpringBoot-Redis-处置海量重复提交疑问的片面指南 (springboot启动)

前言: 在实践的开发名目中,一个对外泄露的接口往往会面临很屡次恳求,咱们来解释一下幂等的概念: 恣意屡次口头所发生的影响均与一次性口头的影响相反 。依照这个含意,最终的含意就...

Boot的Java全栈项目-我在前端编写基于Spring (boot的jar包无法启动)

Boot的Java全栈项目-我在前端编写基于Spring (boot的jar包无法启动)

前言 本文将使用 NestJs + Sequelize + MySQL 完成基础运行,带大家了解 Node 服务端的基础搭建,同时也会对比 Java SpringBoot 项目的基础结构。...

SpringBoot-虚构线程的强强联结-接口吞吐量直线回升-效率飙升体验惊艳! (springboot)

SpringBoot-虚构线程的强强联结-接口吞吐量直线回升-效率飙升体验惊艳! (springboot)

在这篇博客中,咱们将看到如何在spring-boot中应用loom虚构线程。咱们还将在JMeter的协助下做一些负载测试,看看虚构线程和普通线程的照应期间如何。 首先,虚构线程是Projec...

深入理解其工作原理和最佳实践-SpringBoot的配置加载机制 (深入理解yii2)

深入理解其工作原理和最佳实践-SpringBoot的配置加载机制 (深入理解yii2)

概述 SpringBoot 的配置加载机制基于 Environment 的属性源管理,它提供了一种非常灵活的方式来管理应用程序的配置信息。Environment 支持多种配置格式,可以根据不同...

轻松把握SpringBoot智能装配-从入门到精通 (轻松把握的成语)

轻松把握SpringBoot智能装配-从入门到精通 (轻松把握的成语)

一.何为智能装配 智能装配是SpringBoot的外围性能,关键是让开发者尽或者少的关注一些基础化的Bean的性能,实践上成功的上班是如何智能将Bean装载到Ioc容器中。 在Spri...

经常使用RestTemplate (经常使用人体润滑剂的危害)

经常使用RestTemplate (经常使用人体润滑剂的危害)

1、简介 在Spring-Boot名目开发中,当本模块的代码须要访问外面模块接口,或外部url链接的需求的时刻,须要经常使用网络衔接调用,上方提供了四种形式(扫除dubbo的形式)...