json格式校验并显示错误_使用 Spring Validation 优雅地进行参数校验

写得好的没我写得全，写得全的没我写得好

引言

不知道大家平时的业务开发过程中 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组件，所以需要引入如下依赖：

org.springframework.bootspring-boot-starter-validation

org.springframework.bootspring-boot-starter-web

而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 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	当前或将来时间</