Springboot中，使用Validation Starter优雅地进行参数校验

程序开发 2023-09-02 20:09:37

平时大家在业务开发过程中， controller 层的参数校验都是怎么写的？是否也存在下面这样的直接判断呢？

public String add(UserVO userVO) {if(userVO.getAge() == null){return "年龄不能为空";}if(userVO.getAge() > 100){return "年龄不能超过100";}if(userVO.getName().isEmpty()){return "用户名不能为空";}// 省略一堆参数校验...return "True";
 }

以上写法虽然也能对前端参数进行校验，但是仔细想一下，如果UserVO中有100个属性字段都是需要校验的，那是不是要写一百个 if 判断语句？作为一个合格的程序猿，这显然是不允许的，代码要优雅、优雅、优雅

敲黑板、敲黑板

其实Spring框架已经给我们封装了一套校验组件：spring-boot-starter-validation。其特点是简单易用，自由度高。接下来课代表使用springboot-2.3.1.RELEASE搭建一个简单的 Web 工程，给大家一步一步讲解在开发过程中如何优雅地做参数校验。

第一步，环境搭建

从 springboot-2.3.x 开始，校验包被独立成了一个starter组件，所以需要引入如下依赖：

( springboot-2.3.x 之前的版本只需要引入 web 依赖就可以了)


 org.springframework.bootspring-boot-starter-validation
 
 
 org.springframework.bootspring-boot-starter-web

使用示例

直接在待校验字段上增加校验规则注解即可

public class UserVO {@NotNull(message = "age 不能为空")private Integer age;
 }

再在controller方法中添加@Validated和用于接收错误信息的BindingResult就可以了，于是有了第一版：

public String add1(@Validated UserVO userVO, BindingResult result) {List fieldErrors = result.getFieldErrors();if(!fieldErrors.isEmpty()){return fieldErrors.get(0).getDefaultMessage();}return "true";
 }

通过工具如(postman)去请求接口，如果参数不符合规则，会将相应的 message信息返回：

age 不能为空

它里面内置的校验注解有很多，罗列如下：

注解校验功能@AssertFalse必须是false@AssertTrue必须是true@DecimalMax小于等于给定的值@DecimalMin大于等于给定的值@Digits可设定最大整数位数和最大小数位数@Email校验是否符合Email格式@Future必须是将来的时间@FutureOrPresent当前或将来时间@Max最大值@Min最小值@Negative负数（不包括0）@NegativeOrZero负数或0@NotBlank不为null并且包含至少一个非空白字符@NotEmpty不为null并且不为空@NotNull不为null@Null为null@Past必须是过去的时间@PastOrPresent必须是过去的时间，包含现在@PositiveOrZero正数或0@Size校验容器的元素个数

规范返回值

待校验参数多了之后我们希望一次返回所有校验失败信息，方便接口调用方进行调整，这就需要统一返回格式，常见的就是封装一个结果类。

public class ResultInfo{private Integer status;private String message;private T response;// 省略其他代码...
 }

改造一下controller 方法，第二版：

public ResultInfo add2(@Validated UserVO userVO, BindingResult result) {List fieldErrors = result.getFieldErrors();List collect = fieldErrors.stream().map(o -> o.getDefaultMessage()).collect(Collectors.toList());return new ResultInfo<>().success(400,"请求参数错误",collect);
 }

请求该方法时，所有的错误参数就都返回了：

{"status": 400,"message": "请求参数错误","response": ["年龄必须在[1,120]之间","bg 字段的整数位最多为3位，小数位最多为1位","name 不能为空","email 格式错误"]
 }

全局异常处理

最佳实践

@RestControllerAdvice
 public class GlobalControllerAdvice {private static final String BAD_REQUEST_MSG = "客户端请求参数错误";// <1> 处理 form data方式调用接口校验失败抛出的异常 @ExceptionHandler(BindException.class)public ResultInfo> bindExceptionHandler(BindException e) {List fieldErrors = e.getBindingResult().getFieldErrors();List collect = fieldErrors.stream().map(o -> o.getDefaultMessage()).collect(Collectors.toList());return new ResultInfo>(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);}// <2> 处理 json 请求体调用接口校验失败抛出的异常 @ExceptionHandler(MethodArgumentNotValidException.class)public ResultInfo> methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {List fieldErrors = e.getBindingResult().getFieldErrors();List collect = fieldErrors.stream().map(o -> o.getDefaultMessage()).collect(Collectors.toList());return new ResultInfo>(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);}// <3> 处理单个参数校验失败抛出的异常@ExceptionHandler(ConstraintViolationException.class)public ResultInfo> constraintViolationExceptionHandler(ConstraintViolationException e) {Set> constraintViolations = e.getConstraintViolations();List collect = constraintViolations.stream().map(o -> o.getMessage()).collect(Collectors.toList());return new ResultInfo>(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);}@ExceptionHandler(MissingRequestHeaderException.class)public ResultInfo missingRequestHeaderExceptionHandler(MissingRequestHeaderException e) {String message = e.getMessage();return new ResultInfo(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, message);}   
 }

分组校验

如果同一个参数，需要在不同场景下应用不同的校验规则，就需要用到分组校验了。比如：新注册用户还没起名字，我们允许name字段为空，但是不允许将名字更新为空字符。

分组校验有三个步骤：

（1）定义一个分组类（或接口）

	public interface Update extends Default{}

（2）在校验注解上添加groups属性指定分组

public class UserVO {@NotBlank(message = "school 不能为空",groups = Update.class)private String school;// 省略其他代码...
 }

（3）Controller方法的@Validated注解添加分组类

@PostMapping("update")
 public ResultInfo update(@Validated({Update.class}) UserVO userVO) {return new ResultInfo().success(userVO);
 }

注：自定义的Update分组接口继承了Default接口。校验注解(如：@NotBlank)和@validated默认都属于Default.class分组，这一点在javax.validation.groups.Default注释中有说明

/*** Default Jakarta Bean Validation group.* * Unless a list of groups is explicitly defined:* 
*     constraints belong to the {@code Default} group
*     validation applies to the {@code Default} group
* * Most structural constraints should belong to the default group.** @author Emmanuel Bernard*/
 public interface Default {
 }

在编写Update分组接口时，如果继承了Default，下面两个写法就是等效的：

@Validated({Update.class})

@Validated({Update.class,Default.class})

请求一下/update接口可以看到，不仅校验了school字段，也校验了其他默认属于Default.class分组的字段

{"status": 400,"message": "客户端请求参数错误","response": ["school 不能为空","name 不能为空","age 不能为空","email 不能为空"]
 }

递归校验

public class OrderVO {@NotNullprivate Long id;@NotBlank(message = "itemName 不能为空")private String itemName;// 省略其他代码...
 }

在 UserVO 类中增加一个 OrderVO 类型的属性

public class UserVO {@NotBlank(message = "name 不能为空",groups = Update.class)private String name;//需要递归校验的OrderVO@Validprivate OrderVO orderVO;// 省略其他代码...
 }

调用请求验证如下：
在这里插入图片描述

自定义校验

Spring 的 validation 为我们提供了这么多特性，几乎可以满足日常开发中绝大多数参数校验场景了。但是，一个好的框架一定是方便扩展的。有了扩展能力，就能应对更多复杂的业务场景，毕竟在开发过程中，唯一不变的就是变化本身。

Spring Validation允许用户自定义校验，实现很简单，分两步：

（1）自定义校验注解

（2）编写校验者类

代码也很简单，结合注释，聪明的你一看就懂（不懂的可以通过下方名片找我，我跟你讲一讲）

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
 @Retention(RUNTIME)
 @Documented
 @Constraint(validatedBy = {HaveNoBlankValidator.class})// 标明由哪个类执行校验逻辑
 public @interface HaveNoBlank {// 校验出错时默认返回的消息String message() default "字符串中不能含有空格";Class[] groups() default { };Class[] payload() default { };/*** 同一个元素上指定多个该注解时使用*/@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })@Retention(RUNTIME)@Documentedpublic @interface List {NotBlank[] value();}
 }

public class HaveNoBlankValidator implements ConstraintValidator {@Overridepublic boolean isValid(String value, ConstraintValidatorContext context) {// null 不做检验if (value == null) {return true;}if (value.contains(" ")) {// 校验失败return false;}// 校验成功return true;}
 }

自定义校验注解使用起来和内置注解无异，在需要的字段上添加相应注解即可，同学们可以自行验证。

先自我介绍一下，小编13年毕业于厦门大学，14年在外包公司中软干过，后来去过微软、华为等大厂，20年进入鹅厂担任架构师，直到现在。这一路走来，深知大多数初中级java工程师，想要提升技能，往往需要自己长时间的摸索成长或是报班学习，但对于培训机构动则近万元的学费，着实压力不小。自己不成体系的自学效率不仅低效而且还很漫长，很容易就碰到天花板致技术停止不前。因此我收集整理了一份《java开发全套学习资料》送给大家，里面包含了Spring全家桶,MySQL,中间件Redis、kafka,MQ消息,Zookeeper等java全系列资料，非常适合初中高级各个阶段同行学习，初衷也很简单，就是希望帮助到想自学又不知道该从何学起的朋友，同时减轻大家的负担。添加下方名片，即可获取全套学习资料，后面抽时间定期更新一些干货文章，如果你喜欢，也可添加下方名片学习交流 (๑◡๑)

标签：

上一篇：星环科技科创板IPO过会：毛利率维持较高水平，腾讯等为主要股东下一篇：如何设置jupyter notebook的代码自动补全