通过Validation框架检查请求参数的基本格式

通过Validation框架检查请求参数的基本格式

1.1. 添加依赖

Spring Validation框架可用于在服务器端检查请求参数的基本格式（例如是否提交了请求参数、字符串的长度是否正确、数字的大小是否在允许的区间等）。

首先，添加依赖项：

<!-- Spring Boot Validation，用于检查请求参数的基本格式 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

1.2. 检查封装在POJO中的请求参数

如果请求参数使用自定义的POJO类型进行封装，当需要检查这些请求参数的基本格式时，需要：

• 在处理请求的方法的参数列表中，在POJO类型前添加@Validated或@Valid注解，表示需要通过Spring Validation框架对此POJO类型封装的请求参数进行检查
• 在POJO类型的属性上，使用检查注解来配置检查规则，例如@NotNull注解就表示“不允许为null”，即客户端必须提交此请求参数

所有检查注解都有message属性，配置此属性，可用于向客户端响应相关的错误信息。

由于Spring Validation验证请求参数格式不通过时，会抛出异常，所以，可以在全局异常处理器中对此类异常进行处理！

先在ServiceCode中添加对应的枚举值：

ERR_BAD_REQUEST(40000)

然后，在全局异常处理器中添加对org.springframework.validation.BindException的处理：

@ExceptionHandler
public JsonResult handleBindException(BindException e) {
    log.debug("捕获到BindException：{}", e.getMessage());
    // 以下2行代码，如果有多种错误时，将随机获取其中1种错误的信息，并响应
    // String message = e.getFieldError().getDefaultMessage();
    // return JsonResult.fail(ServiceCode.ERR_BAD_REQUEST, message);
    // ===============================
    // 以下代码，如果有多种错误时，将获取所有错误信息，并响应
    StringBuilder stringBuilder = new StringBuilder();
    List<FieldError> fieldErrors = e.getFieldErrors();
    for (FieldError fieldError : fieldErrors) {
        stringBuilder.append(fieldError.getDefaultMessage());
    }
    return JsonResult.fail(ServiceCode.ERR_BAD_REQUEST, stringBuilder.toString());
}

1.3. 检查时快速失败

可以发现，Spring Validation在检查请求参数格式时，如果检查不通过，会记录下相关的错误，然后，继续进行其它检查，直到所有检查全部完成，才会返回错误信息！

检查全部的错误，相对更加消耗服务器资源，可以通过配置，使得检查出错时直接结束并返回错误！

package cn.tedu.csmall.product.config;

import lombok.extern.slf4j.Slf4j;
import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.validation.Validation;

/**
 * Spring Validation的配置类
 *
 * @author java@tedu.cn
 * @version 0.0.1
 */
@Slf4j
@Configuration
public class ValidationConfiguration {

    public ValidationConfiguration() {
        log.debug("创建配置类：ValidationConfiguration");
    }

    @Bean
    public javax.validation.Validator validator() {
        return Validation.byProvider(HibernateValidator.class)
                .configure() // 开始配置Validator
                .failFast(true) // 快速失败，即检查请求参数发现错误时直接视为失败，并不向后继续检查
                .buildValidatorFactory()
                .getValidator();
    }

}

1.4. 常用检查注解

关于检查注解，常用的有：

• @NotNull：不允许为null，适用于所有类型的请求参数

• @NotEmpty：不允许为空字符串（长度为0的字符串），仅适用于字符串类型的请求参数

  • 此注解不检查是否为null，即请求参数为null将通过检查
  • 此注解可以与@NotNull同时使用

• @NotBlank：不允许为空白（形成空白的主要有：空格、TAB制表位、换行等），仅适用于字符串类型的请求参数

  • 此注解不检查是否为null，即请求参数为null将通过检查
  • 此注解可以与@NotNull同时使用

• @Pattern：要求被检查的请求参数必须匹配某个正则表达式，通过此注解的regexp属性可以配置正则表达式，仅适用于字符串类型的请求参数

  • 此注解不检查是否为null，即请求参数为null将通过检查
  • 此注解可以与@NotNull同时使用

• @Range：要求被检查的数值型请求参数必须在某个数值区间范围内，通过此注解的min属性可以配置最小值，通过此注解的max属性可以配置最大值，仅适用于数值类型的请求参数

  • 此注解不检查是否为null，即请求参数为null将通过检查
  • 此注解可以与@NotNull同时使用

另外，在org.hibernate.validator.constraints和javax.validation.constraints包还有其它检查注解。

1.5. 检查基本值的请求参数

如果请求参数是一些基本值，没有封装（例如String、Integer、Long），则需要将检查注解添加在请求参数上，例如：

@Deprecated
@ApiOperation("删除相册【测试2】")
@ApiOperationSupport(order = 910)
@ApiImplicitParam(name = "id", value = "相册id", paramType = "query")
@PostMapping("/delete/test2")
// ===== 重点关注以下方法参数上的注解 =====
public String deleteTest(@Range(min = 1, message = "测试删除相册失败，id值必须是1或更大的有效整数！") Long id) {
    log.debug("【测试】开始处理【删除相册】的请求，这只是一个测试，没有实质功能！");
    return "OK";
}

然后，还需要在控制器类上添加@Validated注解，以上方法参数前的检查注解才会生效！如果后续运行时没有通过此检查，Spring Validation框架将抛出ConstraintViolationException类型的异常，例如：

javax.validation.ConstraintViolationException: deleteTest.id: 测试删除相册失败，id值必须是1或更大的有效整数！

则在全局异常处理器中添加处理以上异常的方法：

@ExceptionHandler
public JsonResult handleConstraintViolationException(ConstraintViolationException e) {
    log.debug("捕获到ConstraintViolationException：{}", e.getMessage());
    StringBuilder stringBuilder = new StringBuilder();
    Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
    for (ConstraintViolation<?> constraintViolation : constraintViolations) {
        stringBuilder.append(constraintViolation.getMessage());
    }
    return JsonResult.fail(ServiceCode.ERR_BAD_REQUEST, stringBuilder.toString());
}