SpringBoot 优雅的参数效验!

·  阅读 348

引言

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

**

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

业务代码还没开始写呢,光参数校验就写了一堆判断。这样写虽然没什么错,但是给人的感觉就是:不优雅,不专业。

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

1. 环境搭建

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

**

<!--校验组件-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!--web组件-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
复制代码

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

2.小试牛刀

参数校验非常简单,首先在待校验字段上增加校验规则注解

**

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

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

**

public String add1(@Validated UserVO userVO, BindingResult result) {
    List<FieldError> fieldErrors = result.getFieldErrors();
    if(!fieldErrors.isEmpty()){
        return fieldErrors.get(0).getDefaultMessage();
    }
    return "OK";
}
复制代码

通过工具(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校验容器的元素个数

3. 规范返回值

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

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

改造一下controller 方法,第二版:

**

public ResultInfo add2(@Validated UserVO userVO, BindingResult result) {
    List<FieldError> fieldErrors = result.getFieldErrors();
    List<String> 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 格式错误"
    ]
}
复制代码

4. 全局异常处理

每个Controller方法中如果都写一遍BindingResult信息的处理,使用起来还是很繁琐。可以通过全局异常处理的方式统一处理校验异常。

当我们写了@validated注解,不写BindingResult的时候,Spring 就会抛出异常。由此,可以写一个全局异常处理类来统一处理这种校验异常,从而免去重复组织异常信息的代码。

回顾

以上就是如何使用 Spring Validation 优雅地校验参数的全部内容,下面重点总结一下文中提到的校验特性

  1. 内置多种常用校验注解
  2. 支持单个参数校验
  3. 结合全局异常处理自动组装校验异常
  4. 分组校验
  5. 支持递归校验
  6. 自定义校验
分类:
后端
分类:
后端
收藏成功!
已添加到「」, 点击更改