Spring Boot参数校验以及分组校验的使用

Posted 2021-09-04 潮汐先生

Spring Boot参数校验以及分组校验的使用

• • 前言
  • 什么是validator
  • 注解介绍
  • • validator内置注解
    • hibernate validator扩展注解
  • 注解使用
  • • 单参数校验
    • 对象参数校验
    • 注解分组
    • 对象嵌套
    • 错误消息的捕获
    • • 1、MissingServletRequestParameterException
      • 2、ConstraintViolationException
      • 3、BindException
      • 4、MethodArgumentNotValidException

前言

原文地址： Spring Boot参数校验以及分组校验的使用

做web开发有一点很烦人就是要对前端输入参数进行校验，基本上每个接口都要对参数进行校验，比如一些非空校验、格式校验等。如果参数比较少的话还是容易处理的一但参数比较多了的话代码中就会出现大量的if-else语句。

使用这种方式虽然简单直接，但是也有不好的地方，一是降低了开发效率，因为我们需要校验的参数会存在很多地方，并且不同地方会有重复校验，其次降低了代码可读性，因为在业务代码中掺杂了太多额外工作的代码。

所以我们可以使用validator组件来代替我们进行不必要的coding操作。本文基于validator的介绍资料，也结合自己在项目中的实际使用经验进行了总结，希望能帮到大家。

什么是validator

Bean Validation是Java定义的一套基于注解的数据校验规范，目前已经从JSR 303的1.0版本升级到JSR 349的1.1版本，再到JSR 380的2.0版本（2.0完成于2017.08），已经经历了三个版本 。需要注意的是，JSR只是一项标准，它规定了一些校验注解的规范，但没有实现，比如@Null、@NotNull、@Pattern等，它们位于 javax.validation.constraints这个包下。而hibernate validator是对这个规范的实现，并增加了一些其他校验注解，如 @NotBlank、@NotEmpty、@Length等，它们位于org.hibernate.validator.constraints这个包下。

如果我们的项目使用了Spring Boot，hibernate validator框架已经集成在 spring-boot-starter-web中，所以无需再添加其他依赖。如果不是Spring Boot项目，需要添加如下依赖。

<dependency>
  	<groupId>org.hibernate.validator</groupId>
  	<artifactId>hibernate-validator</artifactId>
  	<version>6.0.8.Final</version>
</dependency>

注解介绍

validator内置注解

注解	说明
@Null	被注释的元素必须为null
@NotNull	被注释的元素不能为null
@AssertTrue	被注释的元素必须为true
@AssertFalse	被注释的元素必须为false
@Min(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max,min)	被注释的元素的大小必须在指定的范围内
@Digits(integer, fraction)	被注释的元素必须是一个数字，其值必须必须在可接受的范围内
@Past	被注释的元素必须是一个过去的日期
@Future	被注释的元素必须是一个将来的日期
@Pattern(value)	被注释的元素必须符合指定的正则表达式

hibernate validator扩展注解

注解	说明
@NotBlank	被注释的元素不能为null，且长度必须大于0，只能用于注解字符串
@Email	被注释的元素必须是电子邮箱地址
@Length(min=,max=)	被注释的字符串的大小必须在指定的范围内
@NotEmpty	被注释的元素值不为null且不为空，支持字符串、集合、Map和数组类型
@Range	被注释的元素必须在规定的范围内

注解使用

使用起来比较简单，都是使用注解方式使用。具体来说分为单参数校验、对象参数校验，单参数校验就是controller接口按照单参数接收前端传值，没有封装对象进行接收，如果有封装对象那就是对象参数校验。

单参数校验

单参数校验只需要在参数前添加注解即可，如下所示：

public Result deleteUser(@NotNull(message = "id不能为空") Long id) {  
  // do something
}

但有一点需要注意，如果使用单参数校验，controller类上必须添加@Validated注解，如下所示：

@RestController
@RequestMapping("/user")
@Validated // 单参数校验需要加的注解
public class UserController {  
	// do something
}

对象参数校验

对象参数校验使用时，需要先在对象的校验属性上添加注解，然后在Controller方法的对象参数前添加@Validated 注解，如下所示：

public Result addUser(@Validated UserAO userAo) {
  // do something
}

public class UserAO {
  @NotBlank
  private String name;
  @NotNull
  private Integer age;
}

注解分组

在对象参数校验场景下，有一种特殊场景，同一个参数对象在不同的场景下有不同的校验规则。比如，在创建对象时不需要传入id字段（id字段是主键，由系统生成，不由用户指定），但是在修改对象时就必须要传入id字段。在这样的场景下就需要对注解进行分组。

1）组件有个默认分组Default.class, 所以我们可以再创建一个分组UpdateAction.class，如下所示：

public interface UpdateAction {
  
}

2）在参数类中需要校验的属性上，在注解中添加groups属性：

public class UserAO {
    @NotNull(groups = UpdateAction.class, message = "id不能为空")
  	private Long id;
  	@NotBlank
  	private String name;
    @NotNull
  	private Integer age;
}

如上所示，就表示只在UpdateAction分组下校验id字段，在默认情况下就会校验name字段和age字段。

然后在controller的方法中，在@Validated注解里指定哪种场景即可，没有指定就代表采用Default.class，采用其他分组就需要显示指定。如下代码便表示在addUser()接口中按照默认情况进行参数校验，在updateUser()接口中按照默认情况和UpdateAction分组对参数进行共同校验。

public Result addUser(@Validated UserAO userAo) {
  	// do something
}

public Result updateUser(@Validated({Default.class, UpdateAction.class}) UserAO userAo) {  			// do something
}

对象嵌套

如果需要校验的参数对象中还嵌套有一个对象属性，而该嵌套的对象属性也需要校验，那么就需要在该对象属性上增加@Valid注解。

public class UserAO {
    @NotNull(groups = UpdateAction.class, message = "id不能为空")    
  	private Long id;        		
  	@NotBlank    
  	private String name;
    @NotNull    
  	private Integer age;        
  	@Valid    
  	private Phone phone;        
  	……
}

public class Phone {    
 		@NotBlank    
  	private String operatorType;        
  	@NotBlank    
  	private String phoneNum;
}

错误消息的捕获

参数校验失败后会抛出异常，我们只需要在全局异常处理类中捕获参数校验的失败异常，然后将错误消息添加到返回值中即可。捕获异常的方法如下所示，返回值Result是我们系统自定义的返回值类。

@RestControllerAdvice(basePackages{"com.*.controller","com.*.service"})
public class GlobalExceptionHandler {
  	@ExceptionHandler(value = {Throwable.class})
  	Result handleException(Throwable e, HttpServletRequest request){    
      // 异常处理        
    }
}

需要注意的是，如果缺少参数抛出的异常是MissingServletRequestParameterException，单参数校验失败后抛出的异常是ConstraintViolationException，get请求的对象参数校验失败后抛出的异常是BindException，post请求的对象参数校验失败后抛出的异常是MethodArgumentNotValidException，不同异常对象的结构不同，对异常消息的提取方式也就不同。如下图所示：

1、MissingServletRequestParameterException

if(e instanceof MissingServletRequestParameterException){
    Result result = Result.buildErrorResult(ErrorCodeEnum.PARAM_ILLEGAL);
    String msg = MessageFormat.format("缺少参数{0}", ((MissingServletRequestParameterException) e).getParameterName());
    result.setMessage(msg);
    return result;
}

2、ConstraintViolationException

if(e instanceof ConstraintViolationException){
  // 单个参数校验异常
  Result result = Result.buildErrorResult(ErrorCodeEnum.PARAM_ILLEGAL);
  Set<ConstraintViolation<?>> sets = ((ConstraintViolationException) e).getConstraintViolations();
  if(CollectionUtils.isNotEmpty(sets)){
    StringBuilder sb = new StringBuilder();
    sets.forEach(error -> {
                    if (error instanceof FieldError) {
                        sb.append(((FieldError)error).getField()).append(":");
                    }
                    sb.append(error.getMessage()).append(";");
                });
    String msg = sb.toString();
    msg = StringUtils.substring(msg, 0, msg.length() -1);
    result.setMessage(msg);
  }
  return result;
}

3、BindException

if (e instanceof BindException){
      // get请求的对象参数校验异常
      Result result = Result.buildErrorResult(ErrorCodeEnum.PARAM_ILLEGAL);
      List<ObjectError> errors = ((BindException) e).getBindingResult().getAllErrors();
      String msg = getValidExceptionMsg(errors);
      if (StringUtils.isNotBlank(msg)){
        result.setMessage(msg);
      }
      return result;
}

private String getValidExceptionMsg(List<ObjectError> errors) {
  if(CollectionUtils.isNotEmpty(errors)){
    StringBuilder sb = new StringBuilder();
    errors.forEach(error -> {
                    if (error instanceof FieldError) {
                       sb.append(((FieldError)error).getField()).append(":");
                    }
                    sb.append(error.getDefaultMessage()).append(";");
                });
    String msg = sb.toString();
    msg = StringUtils.substring(msg, 0, msg.length() -1);
    return msg;
  }
  return null;
}

4、MethodArgumentNotValidException

if (e instanceof MethodArgumentNotValidException){
      // post请求的对象参数校验异常
      Result result = Result.buildErrorResult(ErrorCodeEnum.PARAM_ILLEGAL);
      List<ObjectError> errors = ((MethodArgumentNotValidException) e).getBindingResult().getAllErrors();
      String msg = getValidExceptionMsg(errors);
      if (StringUtils.isNotBlank(msg)){
        result.setMessage(msg);
      }
      return result;
}