SpringBoot中使用@Valid 做入参表单校验 以及常见校验规则

1.在pom.xml中引入 hibernate-validator

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

2.注入bean:

@Configuration
public class FactoryConfig {
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        return new MethodValidationPostProcessor();
    }
}

3.在需要参数校验的Controller添加校验注解

@ApiOperation(value = "登录")
@PostMapping(value = "/login")
public ResponseMessage loginRest(@Valid @RequestBody LoginInfoVO loginInfoVO, HttpServletRequest request) {
   try {
       logger.info(JSON.toJSONString(loginInfoVO));

       UserDetailVO userDetailVO = userInfoService.getUserByUserName(loginInfoVO, request);
       if (null == userDetailVO) {
           throw new TokenAccessException(ResponseEnum.QUERY_FAILED.getCode(), ResponseEnum.QUERY_FAILED.getMessage());
       }
   } catch (Exception e) {
       logger.error("登录失败", e);
       return Result.success(ResponseEnum.ERROR.getCode(), "登录失败", null);
   }
}

4.在bean中添加校验规则

package com.adc.da.entity.precise.vo;

import lombok.Data;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

@Data
public class LoginInfoVO {

    @NotBlank(message = "用户名不能为空")
    private String username;
    
    @NotBlank(message = "密码不能为空")
    private String password;

    @NotBlank(message = "验证码不能为空")
    private String verifyCode;

    @NotBlank(message = "sessionId不能为空")
    private String sessionId;

}

5.添加统一的异常处理方法

@ControllerAdvice
@Order(value = 0)
public class MethodArgumentNotValid {
    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseMessage defultExcepitonHandler(MethodArgumentNotValidException exception) throws Exception {
        logger.error(exception.getMessage(), exception);
        
        List<ValidErrorVO> validErrorList = new ArrayList<>();
        BindingResult result = exception.getBindingResult();
        for (FieldError fieldError : result.getFieldErrors()) {
            validErrorList.add(new ValidErrorVO(fieldError.getField(), fieldError.getDefaultMessage()));
            logger.warn("valid error: obj[{}], filed[{}], message[{}]", fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
        }
        ErrorBackVO errorBackVO = new ErrorBackVO(validErrorList);
        Map<String, ErrorBackVO> map = new HashMap<>();
        map.put("ErrorBackVO", errorBackVO);
        //返回错误信息
        return Result.error(ResponseEnum.SCAN_VALID_FAILED.getCode(), ResponseEnum.SCAN_VALID_FAILED.getMessage(), map);
    }
}

6.测试

在登录接口入参中删除 verifyCode

1.入参：

{
  "password": "string",
  "sessionId": "string",
  "username": "string"
}

2.响应数据：

{
  "respCode": "4005",
  "data": {
    "ErrorBackVO": {
      "validErrorVOList": [
        {
          "file": "verifyCode",
          "message": "验证码不能为空"
        }
      ]
    }
  },
  "ok": false,
  "message": "数据校验失败"
}

校验拦截成功

附：常见校验规则

@Null       验证对象是否为null
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
@CreditCardNumber信用卡验证
@Email  验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@URL(protocol=,host=, port=,regexp=, flags=) ip地址校验

Booelan检查
@AssertTrue     验证 Boolean 对象是否为 true  
@AssertFalse    验证 Boolean 对象是否为 false  

长度检查
@Size(min=, max=)   验证对象（Array,Collection,Map,String）长度是否在给定的范围之内  
@Length(min=, max=) Validates that the annotated string is between min and max included.
 
日期检查
@Past       验证 Date 和 Calendar 对象是否在当前时间之前  
@Future     验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern    验证 String 对象是否符合正则表达式的规则

数值检查，建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为""时无法转换为int，但可以转换为Stirng为"",Integer为null
@Min            验证 Number 和 String 对象是否大等于指定的值  
@Max            验证 Number 和 String 对象是否小等于指定的值  
@DecimalMax     被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin     被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits         验证 Number 和 String 的构成是否合法  
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum

更多好玩好看的内容，欢迎到我的博客交流，共同进步        WaterMin

喜欢听相声的朋友，也可以来我的 YouTube，来听郭老师的相声    秋酿