Spring validation 用法说明

一 简介

• 后端开发接口，经常会需要校验接口，可以使用spring提供的validation框架，使用注解进行校验，很方便。
• 如果提供的注解满足不了业务需求，可以自己定义，也很方便；
• 本文也提供针对List里面嵌套对象的校验方式，有些文章说解决不了，还是姿势不对。

 

二 常用

2.1 maven依赖

 TODO

2.2 注解说明

注解	作用
@Null	限制只能为null
@NotNull	限制必须不为null
@NotEmpty	只作用于字符串类型，字符串不为空，并且长度不为0
@NotBlank	只作用于字符串类型，字符串不为空，并且trim()后不为空串
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Past	验证注解的元素值（日期类型）比当前时间早
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max,min)	限制字符长度必须在min到max之间
@Email	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

 

2.3 用法说明

2.3.1 在接口字段参数上直接使用

• 在方法字段参数上直接用对应的注解即可

• 
  @RestController
  @RequestMapping("/tracemain")
  public class TraceMainController {
  
      @PostMapping("/save")
      public ResponseEntity<TraceMainSaveOutVo> saveTraceMain(
          @NotNull(message = "type字段不能为空") Integer type) {
          // xxxx
          return ResponseEntity.success(traceMainSaveOutVo);
      }
  
  }
  
  

   

 

2.3.2 在对象上使用

• Controller方法中对象前面添加 @Validated 注解，VO对象里面字段上面添加对应注解即可 
• 如下代码

@RestController
@RequestMapping("/tracemain")
public class TraceMainController {

    @PostMapping("/save")
    public ResponseEntity<TraceMainSaveOutVo> saveTraceMain(@RequestBody @Validated TraceMainSaveInVo traceMainSaveInVo) {
        // xxxx
        return ResponseEntity.success(traceMainSaveOutVo);
    }

}

@JsonInclude(JsonInclude.Include.NON_NULL)
public class TraceMainSaveInVo extends SysModel {

    private static final long serialVersionUID = -1826896482893289340L;

    @ApiModelProperty("物流唯一单号")
    @NotBlank(message = "物流唯一单号不能为空")
    private String logisticsUniqueNo;

    @ApiModelProperty("HQ跟踪单号，格式为：HQ1+19位数字")
    @Pattern(regexp = "^HQ1+\\d{19}", message = "HQ跟踪单号格式有误，格式为：HQ1+19位数字")
    @Size(min = 22, max = 22, message = "HQ跟踪单号格式有误, 格式为：HQ1+19位数字")
    private String hqTraceNo;


    @ApiModelProperty("预报来源: 1-WMS，2-LMS, 3-1track")
    @NotNull(message = "预报来源不能为空")
    @Min(value = 1, message = "预报来源的值只能为1，2，3")
    @Max(value = 3, message = "预报来源的值只能为1，2，3")
    private Integer predictSource;

}

 

2.3.3 在嵌套对象使用

• Controller类上添加 @Validated 注解，方法参数上添加 @Valid 注解，VO对象里面字段上面添加对应注解即可 ；
• 代码如下：

@RestController
@RequestMapping("/xxx")
@Validated
public class PredictController {

    @PostMapping("/save")
    public ResponseEntity<List<PredictOutVo>> saveOrUpdatePredict(@RequestBody @Valid List<PredictInVo> predictInVoList) {
        // xxx
        return ResponseEntity.success(predictOutVoList);
    }

}

public class PredictInVo extends SysModel {

    @NotBlank(message = "OMS订单编号oms_order_no不能为空")
    private String omsOrderNo;

}

 

三  自定义

3.0 场景

• 目前我需要校验一个Integer类型的参数，是不连续的，如： 只能是1,2,3,6。目前提供的都解决不了，则需要自定义。

3.1 自定义注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IntegerEnumValidator.class)
public @interface IntegerEnum {

    String message();

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    int[] intValues();


}

 

3.2 自定义校验器

• value就是实际参数传递过来的值， intValues数组是我们定义的合法的参数范围数组；
• 关于怎么找到的变量获取方法，不断debug即可知道如何获取；

import org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorContextImpl;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.metadata.ConstraintDescriptor;
import java.util.Map;

public class IntegerEnumValidator implements ConstraintValidator<IntegerEnum, Object> {

    private final String intVaules = "intValues";

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if(null == value) {
            return true;
        }
        ConstraintDescriptor<?> constraintDescriptor = ((ConstraintValidatorContextImpl) context).getConstraintDescriptor();
        Map<String, Object> attributes = constraintDescriptor.getAttributes();
        int[] intValues = (int[]) attributes.get(intVaules);
        boolean hasFlag = false;
        for (int intValue : intValues) {
            if (intValue == ((int) value)) {
                hasFlag = true;
                break;
            }
        }
        return hasFlag;
    }
}

3.3 全局异常处理(可忽略)

• 有些时候需要全局异常处理，显示异常信息，可以根据自己内部定义的异常处理进行获取。本文是使用的springboot,就直接写在了启动类中，如下：

@SpringBootApplication
public class TssAcquireApplication  {


    /**
     * spring validation校验异常处理
     */
    @ControllerAdvice
    class TssApiExceptionHandler {
        @ExceptionHandler(ConstraintViolationException.class)
        public void replayException(ConstraintViolationException replayException) {
            Set<ConstraintViolation<?>> constraintViolations = replayException.getConstraintViolations();
            if (!CollectionUtils.isEmpty(constraintViolations)) {
                StringBuilder errorInfo = new StringBuilder();
                constraintViolations.forEach(eachConstraintViolation -> {
                    errorInfo.append(eachConstraintViolation.getMessageTemplate()).append(";");
                });
                ResponseEntity<Object> responseEntity = ResponseEntity.fail(errorInfo.toString());
                HttpOutJson.out(responseEntity, HttpStatus.BAD_REQUEST.value());
            }
        }
    }


}

3.4 使用

• 和2里面的使用方式一样，只不过字段上注解使用我们自定义的注解即可；

    @Valid
    @NotNull(message = "货运类型不能为空")
    @IntegerEnum(intValues = {0, 1, 2, 3, 4, 5, 6, 7, 9}, message = "货运类型transport_type只能是0,1,2,3,4,5,6,7,9之一")
    private Integer transportType;