java开发SpringBoot参数校验过程示例教程

java开发SpringBoot参数校验过程示例教程

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

大家好，我是飘渺。

前几天写了一篇SpringBoot如何统一后端返回格式？老鸟们都是这样玩的！

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

首先我们来看看什么是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

public class ValidVO {

private String id;

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

private String appId;

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

private String name;

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

private String email;

private String sex;

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

private String level;

}

在实际开发中对于需要校验的字段都需要设置对应的业务提示，即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

public class ValidController {

@ApiOperation("RequestBody校验")

@PostMapping("/valid/test1")

public String test1(@Validated @RequestBody ValidVO validVO){

log.info("validEntity is {}", validVO);

return "test1 valid success";

}

@ApiOperation("Form校验")

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

public String test2(@Validated ValidVO validVO){

log.info("validEntity is {}", validVO);

return "test2 valid success";

}

@ApiOperation("单参数校验")

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

public String test3(@Email String email){

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

return "email valid success";

}

}

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

第四步，体验效果

调用test1方法

提示的是org.springframework.web.bind.MethodArgumentNotValidException异常

POST http://localhost:8080/valid/test1

Content-Type: application/json

{

"id": 1,

"level": "12",

"email": "47693899",

"appId": "ab1c"

}

{

"status": 500,

"message": "Validation failed for argument [0] in public java.lang.String com.jianzh5.blog.valid.ValidController.test1(com.jianzh5.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field 'email': rejected value [47693899]; codes [Email.validVO.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*]; default message [不是一个合法的电子邮件地址]]...",

"data": null,

"timestamp": 1628239624332

}

调用test2方法

提示的是org.springframework.validation.BindException异常

POST http://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: 3 errors\nField error in object 'validVO' on field 'name': rejected value [null]; codes [NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字为必填项]...",

"data": null,

"timestamp": 1628239301951

}

调用test3方法，

提示的是javax.validation.ConstraintViolationException异常

POST http://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})

public ResponseEntity> handleValidatedException(Exception e) {

ResultData resp = null;

if (e instanceof MethodArgumentNotValidException) {

// BeanValidation exception

MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;

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

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

.map(ObjectError::getDefaultMessage)

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

);

} else if (e instanceof ConstraintViolationException) {

// BeanValidation GET simple param

ConstraintViolationException ex = (ConstraintViolationException) e;

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

ex.getConstraintViolations().stream()

.map(ConstraintViolation::getMessage)

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

);

} else if (e instanceof BindException) {

// BeanValidation GET object param

BindException ex = (BindException) e;

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

ex.getAllErrors().stream()

.map(ObjectError::getDefaultMessage)

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

);

}

return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);

}

体验效果

POST http://localhost:8080/valid/test1

Content-Type: application/json

{

"id": 1,

"level": "12",

"email": "47693899",

"appId": "ab1c"

}

POST http://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 @interface EnumString {

String message() default "value not in enum values.";

Class>[] groups() default {};

Class extends Payload>[] payload() 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();

}

}

第二步，自定义校验逻辑

public claZgLfmXYss EnumStringValidator implements ConstraintValidator {

private List enumStringList;

@Override

public void initialize(EnumString constraintAnnotation) {

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

}

@Override

public boolean isValid(String value, ConstraintValidatorContext context) {

if(value == null){

return true;

}

return enumStringList.contains(value);

}

}

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

@ApiModelProperty(value = "性别")

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

private String sex;

第四步，体验效果

POST http://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校验框架已经考虑到了这种场景并且提供了解决方案，就是分组校验，只不过很多同学不知道而已。要使用分组校验，只需要三个步骤：

第一步：定义分组接口

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{

}

}

}

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

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

@Data

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

public class ValidVO {

@ApiModelProperty("ID")

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

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

private String id;

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

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

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

private String appId;

@ApiModelProperty(value = "名字")

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

private String name;

@ApiModelProperty(value = "邮箱")

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

privte String email;

...

}

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

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

@RestController

@Api("参数校验")

@Slf4j

@Validated

public class ValidController {

@ApiOperation("新增")

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

public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){

log.info("validEntity is {}", validVO);

return "test3 valid success";

}

@ApiOperation("更新")

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

public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){

log.info("validEntity is {}", validVO);

return "test4 valid success";

}

}

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

第四步，体验效果

POST http://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字段作参数校验的。如：

POST http://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场景的情况，很容易被老鸟被所鄙视嘲笑，希望大家好好掌握。

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

以上就是SpringBoot参数校验过程示例教程的详细内容，更多关于SpringBoot参数校验的资料请关注我们其它相关文章！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。