Spring Boot 实现接口的各种参数校验

在我们进行接口开发时，在对参数的接收时，我们需要冗余复杂的校验规则 来进行接口参数的校验，接下来推荐一个好用的校验工具Spring Validation。

Java API规范 (JSR303) 定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。

Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。接下来，我们以spring-boot项目为例，介绍Spring Validation的使用。

1.添加依赖

<!--新增validator-->
        <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
     <!--添加lombok-->
        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

2.接口参数校验

对于web服务来说，为防止非法参数对业务造成影响，在Controller层一定要做参数校验的！大部分情况下，请求参数分为如下两种形式：

• POST、PUT请求，使用requestBody传递参数；
• GET请求，使用requestParam/PathVariable传递参数。

下面我们简单介绍下requestBody和requestParam/PathVariable的参数校验实战！

2.1 requestBody参数校验

POST、PUT请求一般会使用requestBody传递参数，这种情况下，后端使用DTO对象进行接收。只要给 DTO 对象加上@Validated注解就能实现自动参数校验。

比如，有一个保存User的接口，要求userName长度是2-10，account和password字段长度是6-20。如果校验失败，会抛出MethodArgumentNotValidException异常，Spring默认会将其转为400（Bad Request）请求。

DTO 表示数据传输对象（Data Transfer Object），用于服务器和客户端之间交互传输使用的。在 spring-web 项目中可以表示用于接收请求参数的Bean对象。

我们只需要两步就可以实现刚刚对user对象参数的需求

• 1.在实体类上声明约束注解

  import lombok.Data;
  import org.hibernate.validator.constraints.Length;
  import javax.validation.constraints.NotNull;

  @Data
  public class UserDTO {

  private Long userId;
  
  @NotNull
  @Length(min = 2, max = 10)
  private String userName;
  
  @NotNull
  @Length(min = 6, max = 20)
  private String account;
  
  @NotNull
  @Length(min = 6, max = 20)
  private String password;
  

  }

• 2.在接口方法参数上声明校验注解

  import org.springframework.validation.annotation.Validated;
  import org.springframework.web.bind.annotation.PostMapping;
  import org.springframework.web.bind.annotation.RequestBody;
  import org.springframework.web.bind.annotation.RestController;

  import java.util.HashMap;
  import java.util.Map;

  @RestController
  public class UserController {

  @PostMapping("/save")
  public Map<String, Object> saveUser(@RequestBody @Validated UserDTO userDTO) {
      Map<String, Object> result = new HashMap<>();
      result.put("code", 20000);
      return result;
  }
  

  }

接下来我们进行一下测试

我们可以看到密码位数不对时会转为400请求参数不对的错误

2.2 requestParam/PathVariable参数校验

GET请求一般会使用requestParam/PathVariable传参。
如果参数比较多 (比如超过 6 个)，还是推荐使用DTO对象接收。否则，推荐将一个个参数平铺到方法入参中。在这种情况下，必须在Controller类上标注@Validated注解，并在入参上声明约束注解 (如@Min等)。
如果校验失败，会抛出ConstraintViolationException异常。代码示例如下：

package com.example.code.controller;

import com.example.code.po.UserDTO;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @GetMapping("{userId}")
    public Map<String, Object> detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
        Map<String, Object> result = new HashMap<>();
        UserDTO userDTO = new UserDTO();
        userDTO.setUserId(userId);