SpringBoot如何进行参数校验实例详解-eolink官网

SpringBoot如何进行参数校验实例详解

目录前言为什么需要参数校验SpringBoot中集成参数校验第一步，引入依赖第二步，定义要参数校验的实体类第三步，定义校验类进行测试第四步，体验效果参数异常加入全局异常处理器体验效果自定义参数校验第一步，创建自定义注解第二步，自定义校验逻辑第三步，在字段上增加注解第四步，体验效果分组校验第一步：定义分组接口第二步，在模型中给参数分配分组第三步，给需要参数校验的方法指定分组第四步，体验效果小结总结

前言

今天我们继续聊聊在SprinBoot中如何集成参数校验Validator，以及参数校验的高阶技巧（自定义校验，分组校验）。

“此文是依赖于前文的代码基础，已经在项目中加入了全局异常校验器。（代码仓库在文末）”

首先我们来看看什么是Validator参数校验器，为什么需要参数校验？

为什么需要参数校验

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

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

“Validator校验框架遵循了jsR-303验证规范（参数校验规范）, JSR是java Specification Requests的缩写。”

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

SpringBoot中集成参数校验

第一步，引入依赖

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-validation

“注：从springboot-2.3开始，校验包被独立成了一个starter组件，所以需要引入validation和web，而springboot-2.3之前的版本只需要引入 web 依赖就可以了。”

第二步，定义要参数校验的实体类

@Data

publicclassValidVO{

privateStringid;

@Length(min=6,max=12,message="appId长度必须位于6到12之间")

privateStringappId;

@NotBlank(message="名字为必填项")

privateStringname;

@Email(message="请填写正确的邮箱地址")

privateStringemail;

privateStringsex;

@NotEmpty(message="级别不能为空")

privateStringlevel;

}

在实际开发中对于需要校验的字段都需要设置对应的业务提示，即message属性。

常见的约束注解如下：

注解功能@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

注：此表格只是简单的对注解功能的说明，并没有对每一个注解的属性进行说明；可详见源码。

第三步，定义校验类进行测试

@RestController

@Slf4j

@Validated

publicclassValidController{

@ApiOperation("RequestBody校验")

@PostMapping("/valid/test1")

publicStringtest1(@Validated@RequestBodyValidVOvalidVO){

log.info("validEntityis{}",validVO);

return"test1validsuccess";

}

@ApiOperation("Form校验")

@PostMapping(value="/valid/test2")

publicStringtest2(@ValidatedValidVOvalidVO){

log.info("validEntityis{}",validVO);

return"test2validsuccess";

}

@ApiOperation("单参数校验")

@PostMapping(value="/valid/test3")

publicStringtest3(@EmailStringemail){

log.info("emailis{}",email);

return"emailvalidsuccess";

}

这里我们先定义三个方法test1，test2，test3，test1使用了@RequestBody注解，用于接受前端发送的json数据，test2模拟表单提交，test3模拟单参数提交。注意，当使用单参数校验时需要在Controller上加上@McZvIvkjValidated注解，否则不生效。

第四步，体验效果

调用test1方法，提示的是org.springframework.web.bind.MethodArgumentNotValidException异常

POSThttp://localhost:8080/valid/test1

Content-Type:application/json

{

"id":1,

"level":"12",

"email":"47693899",

"appId":"ab1c"

}

{

"status":500,

"message":"Validationfailedforargument[0]inpublicjava.lang.Stringcom.jianzh5.blog.valid.ValidController.test1(com.jianzh5.blog.valid.ValidVO)with3errors:[Fielderrorinobject'validVO'onfield'email':rejectedvalue[47693899];codes[Email.validVO.email,Email.email,Email.java.lang.String,Email];arguments[org.springframework.context.support.DefaultMessageSourceResolvable:codes[validVO.email,email];arguments[];defaultmessage[email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*];defaultmessage[不是一个合法的电子邮件地址]]...",

"data":null,

"timestamp":1628239624332

}

调用test2方法，提示的是org.springframework.validation.BindException异常

POSThttp://localhost:8080/valid/test2

Content-Type:application/x-www-form-urlencoded

id=1&level=12&email=476938977&appId=ab1c

{

"status":500,

"message":"org.springframework.validation.BeanPropertyBindingResult:3errors\nFielderrorinobject'validVO'onfield'name':rejectedvalue[null];codes[NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank];arguments[org.springframework.context.support.DefaultMessageSourceResolvable:codes[validVO.name,name];arguments[];defaultmessage[name]];defaultmessage[名字为必填项]...",

"data":null,

"timestamp":1628239301951

}

调用test3方法，提示的是javax.validation.ConstraintViolationException异常

POSThttp://localhost:8080/valid/test3

Content-Type:application/x-www-form-urlencoded

email=476938977

{

"status":500,

"message":"test3.email:不是一个合法的电子邮件地址",

"data":null,

"timestamp":1628239281022

}

通过加入Validator校验框架可以帮助我们自动实现参数的校验。

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

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

直接修改之前定义的RestExceptionHandler，单独拦截参数校验的三个异常：javax.validation.ConstraintViolationException，org.springframework.validation.BindException，org.springframework.web.bind.MethodArgumentNotValidException，代码如下：

@ExceptionHandler(value={BindException.class,ValidationException.class,MethodArgumentNotValidException.class})

publicResponseEntity>handleValidatedException(Exceptione){

ResultDataresp=null;

if(einstanceofMethodArgumentNotValidException){

//BeanValidationexception

MethodArgumentNotValidExceptionex=(MethodArgumentNotValidException)e;

resp=ResultData.fail(HttpStatus.BAD_REQUEST.value(),

ex.getBindingResult().getAllErrors().stream()

.map(ObjectError::getDefaultMessage)

.collect(Collectors.joining(";"))

);

}elseif(einstanceofConstraintViolationException){

//BeanValidationGETsimpleparam

ConstraintViolationExceptionex=(ConstraintViolationException)e;

resp=ResultData.fail(HttpStatus.BAD_REQUEST.value(),

ex.getConstraintViolations().stream()

.map(ConstraintViolation::getMessage)

.collect(Collectors.joining(";"))

);

}elseif(einstanceofBindException){

//BeanValidationGETobjectparam

BindExceptionex=(BindException)e;

resp=ResultData.fail(HttpStatus.BAD_REQUEST.value(),

ex.getAllErrors().stream()

.map(ObjectError::getDefaultMessage)

.collect(Collectors.joining(";"))

);

}

returnnewResponseEntity<>(resp,HttpStatus.BAD_REQUEST);

}

体验效果

POSThttp://localhost:8080/valid/test1

Content-Type:application/json

{

"id":1,

"level":"12",

"email":"47693899",

"appId":"ab1c"

}

{

"status":400,

"message":"名字为必填项;不是一个合法的电子邮件地址;appId长度必须位于6到12之间",

"data":null,

"timestamp":1628435116680

}

是不是感觉清爽多了？

自定义参数校验

虽然Spring Validation 提供的注解基本上够用，但是面对复杂的定义，我们还是需要自己定义相关注解来实现自动校验。

比如上面实体类中的sex性别属性，只允许前端传递传 M，F 这2个枚举值，如何实现呢？

第一步，创建自定义注解

@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})

@Retention(RUNTIME)

@Repeatable(EnumString.List.class)

@Documented

@Constraint(validatedBy=EnumStringValidator.class)//标明由哪个类执行校验逻辑

public@interfaceEnumString{

Stringmessage()default"valuenotinenumvalues.";

Class>[]groups()default{};

Class[]payload()default{};

/**

*@returndatemustinthisvaluearray

String[]value();

/**

*Definesseveral{@linkEnumString}annotationsonthesameelement.

*@seeEnumString

@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})

@Retention(RUNTIME)

@Documented

@interfaceList{

EnumString[]value();

}

第二步，自定义校验逻辑

publicclassEnumStringValidatorimplementsConstraintValidator{

privateListenumStringList;

@Override

publicvoidinitialize(EnumStringconstraintAnnotation){

enumStringList=Arrays.asList(constraintAnnotation.value());

}

@Override

publicbooleanisValid(Stringvalue,ConstraintValidatorContextcontext){

if(value==null){

returntrue;

}

returnenumStringList.contains(value);

}

第三步，在字段上增加注解

@ApiModelProperty(value="性别")

@EnumString(value={"F","M"},message="性别只允许为F或M")

privateStringsex;

第四步，体验效果

POSThttp://localhost:8080/valid/test2

Content-Type:application/x-www-form-urlencoded

id=1&name=javadaily&level=12&email=476938977@qq.com&appId=ab1cdddd&sex=N

{

"status":400,

"message":"性别只允许为F或M",

"data":null,

"timestamp":1628435243723

}

分组校验

一个VO对象在新增的时候某些字段为必填，在更新的时候又非必填。如上面的ValidVO中 id 和 appId 属性在新增操作时都是非必填，而在编辑操作时都为必填，name在新增操作时为必填，面对这种场景你会怎么处理呢？

在实际开发中我见到很多同学都是建立两个VO对象，ValidCreateVO，ValidEditVO来处理这种场景，这样确实也能实现效果，但是会造成类膨胀，而且极其容易被开发老鸟们嘲笑。

其实Validator校验框架已经考虑到了这种场景并且提供了解决方案，就是分组校验，只不过很多同学不知道而已。要使用分组校验，只需要三个步骤：

第一步：定义分组接口

publicinterfaceValidGroupextendsDefault{

interfaceCrudextendsValidGroup{

interfaceCreateextendsCrud{

}

interfaceUpdateextendsCrud{

}

interfaceQueryextendsCrud{

}

interfaceDeleteextendsCrud{

}

这里我们定义一个分组接口ValidGroup让其继承javax.validation.groups.Default，再在分组接口中定义出多个不同的操作类型，Create，Update，Query，Delete。至于为什么需要继承Default我们稍后再http://说。

第二步，在模型中给参数分配分组

@Data

@ApiModel(value="参数校验类")

publicclassValidVO{

@ApiModelProperty("ID")

@Null(groups=ValidGroup.Crud.Create.class)

@NotNull(groups=ValidGroup.Crud.Update.class,message="应用ID不能为空")

privateStringid;

@Null(groups=ValidGroup.Crud.Create.class)

@NotNull(groups=ValidGroup.Crud.Update.class,message="应用ID不能为空")

@ApiModelProperty(value="应用ID",example="cloud")

privateStringappId;

@ApiModelProperty(value="名字")

@NotBlank(groups=ValidGroup.Crud.Create.class,message="名字为必填项")

privateStringname;

@ApiModelProperty(value="邮箱")

@Email(message="请填写正取的邮箱地址")

privteStringemail;

...

}

给参数指定分组，对于未指定分组的则使用的是默认分组。

第三步，给需要参数校验的方法指定分组

@RestController

@Api("参数校验")

@Slf4j

@Validated

publicclassValidController{

@ApiOperation("新增")

@PostMapping(value="/valid/add")

publicStringadd(@Validated(value=ValidGroup.Crud.Create.class)ValidVOvalidVO){

log.info("validEntityis{}",validVO);

return"test3validsuccess";

}

@ApiOperation("更新")

@PostMapping(value="/valid/update")

publicStringupdate(@Validated(value=ValidGroup.Crud.Update.class)ValidVOvalidVO){

log.info("validEntityis{}",validVO);

return"test4validsuccess";

}

这里我们通过value属性给add()和update()方法分别指定Create和Update分组。

第四步，体验效果

POSThttp://localhost:8080/valid/add

Content-Type:application/x-www-form-urlencoded

name=javadaily&level=12&email=476938977@qq.com&sex=F

在Create时我们没有传递id和appId参数，校验通过。

当我们使用同样的参数调用update方法时则提示参数校验错误。

{

"status":400,

"message":"ID不能为空;应用ID不能为空",

"data":null,

"timestamp":1628492514313

}

由于email属于默认分组，而我们的分组接口ValidGroup已经继承了Default分组，所以也是可以对email字段作参数校验的。如：

POSThttp://localhost:8080/valid/add

Content-Type:application/x-www-form-urlencoded

name=javadaily&level=12&email=476938977&sex=F

{

"status":400,

"message":"请填写正取的邮箱地址",

"data":null,

"timestamp":1628492637305

}

当然如果你的ValidGroup没有继承Default分组，那在代码属性上就需要加上@Validated(value = {ValidGroup.Crud.Create.class, Default.class}才能让email字段的校验生效。

小结

参数校验在实际开发中使用频率非常高，但是很多同学还只是停留在简单的使用上，像分组校验，自定义参数校验这2个高阶技巧基本没怎么用过，经常出现譬如建立多个VO用于接受Create，Update场景的情况，很容易被老鸟被所鄙视嘲笑，希望大家好好掌握。

最后，我是飘渺Jam，一名写代码的架构师，做架构的程序员，期待您的转发与关注，当然也可以添加我的个人微信 jianzh5，咱们一起聊技术！

github地址：https://github.com/jianzh5/cloud-blog/

总结

如何入门php版交通银行网银支付接口开发

348 2022-09-01

SpringBoot如何进行参数校验实例详解

如何入门php版交通银行网银支付接口开发

Python-接口开发入门解析

java内部接口和外部接口有什么不同

推荐文章

接口调用是什么意思？几种常用接口调用方式

接口设计原则

8款在线 API 接口文档管理工具

api管理系统是什么？

什么是接口调试？接口调试的步骤有哪些？

api 接口管理系统有哪些？

接口测试有几种测试方法

API文档生成工具有哪些？

微服务和api网关区别

交换机配置步骤

最近发表

热评文章

在线接口文档管理工具推荐，支持在线测试，HTTP接口

开源的在线接口文档wiki工具Mindoc的介绍与使

如何优雅的进行接口设计？接口设计的六大原则是什么？

什么是API测试,api检测公司

遇到百度网址安全中心提醒您该页面可能存在钓鱼欺诈信息

软件接口设计怎么做？前后端分离软件接口设计思路

SpringBoot如何进行参数校验实例详解

微信扫一扫：分享

推荐文章

最近发表

热评文章