Spring Validation优雅地校验参数

使用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组件(参见：validation-starter-no-longer-included-in-web-starters)，所以需要引入如下依赖：

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

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

1）实体类上做参数校验

在待校验字段上增加校验规则注解

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

2）在controller中参数校验

在controller方法中添加@Validated和用于接收错误信息的BindingResult就可以了

	public String add1(@Validated UserVO userVO, BindingResult result) {
   
    List<FieldError> fieldErrors = result.getFieldErrors();
    if(!fieldErrors.isEmpty()){
   
        return fieldErrors.get