SpringBoot如何进⾏参数校验，⽼鸟们都这么玩的
来聊聊在SprinBoot中如何集成参数校验Validator，以及参数校验的⾼阶技巧（⾃定义校验，分组校验）。
此⽂是依赖于前⽂的代码基础，已经在项⽬中加⼊了全局异常校验器。（代码仓库在⽂末）
⾸先我们来看看什么是Validator参数校验器，为什么需要参数校验？
为什么需要参数校验
在⽇常的接⼝开发中，为了防⽌⾮法参数对业务造成影响，经常需要对接⼝的参数做校验，例如登录的时候需要校验⽤户名密码是否为空，创建⽤户的时候需要校验邮件、⼿机号码格式是否准确。靠代码对接⼝参数⼀个个校验的话就太繁琐了，代码可读性极差。
Validator框架就是为了解决开发⼈员在开发的时候少写代码，提升开发效率；Validator专门⽤来进⾏接⼝参数校验，例如常见的必填校
验，email格式校验，⽤户名必须位于6到12之间 等等...
Validator校验框架遵循了JSR-303验证规范（参数校验规范）, JSR是 Java Specification Requests的缩写。
接下来我们看看在SpringbBoot中如何集成参数校验框架。
SpringBoot中集成参数校验
第⼀步，引⼊依赖
xml
org.springframework.bootspring-boot-starter-weborg.springframework.bootspring-boot-starter-validation
注：从 springboot-2.3开始，校验包被独⽴成了⼀个 starter组件，所以需要引⼊validation和web，⽽ springboot-2.3之前的版本只需要引⼊web 依赖就可以了。
第⼆步，定义要参数校验的实体类
java
@DatapublicclassValidVO {privateStringid;@Length(min =6,max =12,message ="appId长度必须位于6到12之
间")privateStringappId;@NotBlank(message ="名字为必填项")privateStringname;@Email(message ="请填写正确的邮箱地
址")privateStringemail;privateStringx;@NotEmpty(message ="级别不能为空")privateStringlevel;}
在实际开发中对于需要校验的字段都需要设置对应的业务提⽰，即message属性。
常见的约束注解如下：
注解功能
@AsrtFal可以为null，如果不为null的话必须为fal
@AsrtTrue可以为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
注：此表格只是简单的对注解功能的说明，并没有对每⼀个注解的属性进⾏说明；可详见源码。
第三步，定义校验类进⾏测试
java
@RestController@Slf4j@ValidatedpublicclassValidController{@ApiOperation("RequestBody校
验")@PostMapping("/valid/test1")publicString test1(@Validated@RequestBodyValidVO validVO){ log.info("validEntity is {}", validVO);return"test1 valid success"; }@ApiOperation("Form校验")@PostMapping(value ="/valid/test2")publicString
test2(@ValidatedValidVO validVO){ log.info("validEntity is {}", validVO);return"test2 valid success"; }@ApiOperation("单参数校验")@PostMapping(value ="/valid/test3")publicString test3(@EmailString email){ log.info("email is {}", email);return"email valid success"; }}
这⾥我们先定义三个⽅法test1，test2，test3，test1使⽤了 @RequestBody注解，⽤于接受前端发送的json数据，test2模拟表单提
注意，当使⽤单参数校验时需要在Controller上加上@Validated注解，否则不⽣效。
交，test3模拟单参数提交。注意，当使⽤单参数校验时需要在Controller上加上@Validated注解，否则不⽣效
第四步，体验效果
调⽤test1⽅法，提⽰的是org.springframework.web.bind.MethodArgumentNotValidException异常
json
json
{"status":500,"message":"Validation failed for argument [0] in public java.lang.String
com.jianzh5.blog.st1(com.jianzh5.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field
'email': rejected value [47693899]; codes [ail,Email.java.lang.String,Email]; arguments
[t.support.DefaultMessageSourceResolvable: codes [ail,emai
l]; arguments []; default message [email],[straints.Pattern$Flag;@26139123,.*]; default message [不是⼀个合法的电⼦邮件地址]]...","data":null,"timestamp":1628239624332}
调⽤test2⽅法，提⽰的是org.springframework.validation.BindException异常
json
json
{"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 [t.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字为必填项]...","data":null,"timestamp":1628239301951}
调⽤test3⽅法，提⽰的是javax.validation.ConstraintViolationException异常
json
json
{"status":500,"message":"ail: 不是⼀个合法的电⼦邮件地址","data":null,"timestamp":1628239281022}
通过加⼊ Validator校验框架可以帮助我们⾃动实现参数的校验。
参数异常加⼊全局异常处理器
虽然我们之前定义了全局异常拦截器，也看到了拦截器确实⽣效了，但是 Validator校验框架返回的错误提⽰太臃肿了，不便于阅读，为了⽅便前端提⽰，我们需要将其简化⼀下。
直接修改之前定义的 RestExceptionHandler，单独拦截参数校验的三个异常：
javax.validation.ConstraintViolationException，org.springframework.validation.BindException，org.springframework.web.bind.Me thodArgumentNotValidException，代码如下：
java
@ExceptionHandler(value = {BindException.class, ValidationException.class,
MethodArgumentNotValidException.class})publicResponEntity> handleValidatedException(Exception e) { ResultData resp
=null;if(einstanceofMethodArgumentNotValidException) {// BeanValidation exceptionMethodArgumentNotValidException ex = (MethodArgumentNotValidException) e; resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
.collect(Collectors.joining("; ")) ); }elif(einstanceofConstraintViolationException) {// BeanValidation GET simple paramConstraintViolationException ex = (ConstraintViolationException) e; resp =
ResultData.fail(HttpStatus.BAD_REQUEST.value(), ex.getConstraintViolations().stream()
.map(ConstraintViolation::getMessage) .collect(Collectors.joining("; ")) );
}elif(einstanceofBindException) {// BeanValidation GET object paramBindException ex = (BindException) e; resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(), ex.getAllErrors().stream()
.
map(ObjectError::getDefaultMessage) .collect(Collectors.joining("; ")) );
}returnnewResponEntity<>(resp,HttpStatus.BAD_REQUEST);}
体验效果
java
json
{"status":400,"message":"名字为必填项; 不是⼀个合法的电⼦邮件地址; appId长度必须位于6到12之
间","data":null,"timestamp":1628435116680}
是不是感觉清爽多了？
⾃定义参数校验
虽然Spring Validation 提供的注解基本上够⽤，但是⾯对复杂的定义，我们还是需要⾃⼰定义相关注解来实现⾃动校验。
⽐如上⾯实体类中的x性别属性，只允许前端传递传 M，F 这2个枚举值，如何实现呢？
第⼀步，创建⾃定义注解
java
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER,
TYPE_USE})@Retention(RUNTIME)@Repeatable(EnumString.List.class)@Documented@Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执⾏校验逻辑public@interfaceEnumString { String message()default"value not in enum values."; Class[] groups()default{}; Class[] payload()default{};/** *@returndate must in this value array */String[]
value();/** * Defines veral {@linkEnumString} annotations on the same element. * *@eEnumString
*/@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER,
TYPE_USE})@Retention(RUNTIME)@Documented@interfaceList { EnumString[] value(); }}
第⼆步，⾃定义校验逻辑
java
publicclassEnumStringValidatorimplementsConstraintValidator {privateList
enumStringList;@Overridepublicvoidinitialize(EnumString constraintAnnotation){ enumStringList =
Arrays.asList(constraintAnnotation.value()); }@OverridepublicbooleanisValid(String value, ConstraintValidatorContext context) {if(value ==null){returntrue; }ains(value); }}
第三步，在字段上增加注解
java
@ApiModelProperty(value ="性别")@EnumString(value = {"F","M"}, message="性别只允许为F或M")private String x;
第四步，体验效果
java
json
{"status":400,"message":"性别只允许为F或M","data":null,"timestamp":1628435243723}
分组校验
⼀个VO对象在新增的时候某些字段为必填，在更新的时候⼜⾮必填。如上⾯的 ValidVO中 id 和 appId 属性在新增操作时都是⾮必填
⾮必填，⽽在编辑必填，name在新增操作时为必填
必填，⾯对这种场景你会怎么处理呢？
操作时都为必填
在实际开发中我见到很多同学都是建⽴两个VO对象，ValidCreateVO，ValidEditVO来处理这种场景，这样确实也能实现效果，但是会造成类膨胀，⽽且极其容易被开发⽼鸟们嘲笑。
image-20210716084136689
分组校验，只不过很多同学不知道⽽已。要使⽤分组校验，只需要三其实 Validator校验框架已经考虑到了这种场景并且提供了解决⽅案，就是分组校验
个步骤：
第⼀步：定义分组接⼝
java
publicinterfaceValidGroupextendsDefault{interfaceCrudextendsValidGroup{interfaceCreateextendsCrud{
}interfaceUpdateextendsCrud{ }interfaceQueryextendsCrud{ }interfaceDeleteextendsCrud{ } }}
这⾥我们定义⼀个分组接⼝ValidGroup让其继承
ups.Default，再在分组接⼝中定义出多个不同的操作类型，Create，Update，Query，Delete。⾄于为什么需要继承Default我们稍后再说。
第⼆步，在模型中给参数分配分组
java
@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; ...}
给参数指定分组，对于未指定分组的则使⽤的是默认分组。
