Spring Boot 数据校验@Valid+统一异常处理的实现

发布时间：2020-09-05 22:26:39 作者：JYT IMXB
来源：脚本之家阅读：232

1.先在你需要校验的实体类上面加上所需要的注解

为了测试，我自己就简单写了。@NotNull 和 @NotBlank 不能为空

 @Entity
 @Table(name = "User")
 @Data
 public class User implements Serializable {

 @Id
 @NotNull(message = "id不能为空")
 @GeneratedValue(strategy = GenerationType.IDENTITY)
 private Integer id;

 @NonNull
 @NotBlank(message = "姓名不能为空")
 @Column(name = "name")
 private String name;

 public User() {
 }

 public User(Integer id,String name) {
  this.id=id;
  this.name = name;
 }


}

下面是我从别的博客收集的所有参数校验注解的使用规则方法

空检查

@Null 验证对象是否为null

@NotNull 验证对象是否不为null, 无法查检长度为0的字符串

@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.

@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

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. @Range(min=10000,max=50000,message=“range.bean.wage”) private BigDecimal wage;

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)

@CreditCardNumber信用卡验证

@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。

@ScriptAssert(lang= ,script=, alias=)

@URL(protocol=,host=, port=,regexp=, flags=)

2.在controller层加入@Valid注解

ServiceResult是我自己创建的异常返回类

添加用户信息的方法

 @PostMapping("/saveUser")
 public ServiceResult addUsers(@Valid @RequestBody User user){
   return ServiceResult.success(userRepository.save(user));
 }

3.创建统一处理异常的类

@RestControllerAdvice
@ExceptionHandler(写你想要拦截的异常类型)

这两个注解必须要

第一个方法是校验异常的统一处理

第二个是防止参数类型不一致的处理

当然你也可以在里面处理其他异常。

@RestControllerAdvice
public class BadRequestExceptionHandler {


 private static final Logger logger = LoggerFactory.getLogger(BadRequestExceptionHandler.class);

 /**
  * 校验错误拦截处理
  *
  * @param exception 错误信息集合
  * @return 错误信息
  */
 @ExceptionHandler(MethodArgumentNotValidException.class)
 public ServiceResult validationBodyException(MethodArgumentNotValidException exception){

  BindingResult result = exception.getBindingResult();
  if (result.hasErrors()) {

   List<ObjectError> errors = result.getAllErrors();

   errors.forEach(p ->{

    FieldError fieldError = (FieldError) p;
    logger.error("Data check failure : object{"+fieldError.getObjectName()+"},field{"+fieldError.getField()+
      "},errorMessage{"+fieldError.getDefaultMessage()+"}");

   });

  }
  return ServiceResult.error("请填写正确信息");
 }

 /**
  * 参数类型转换错误
  *
  * @param exception 错误
  * @return 错误信息
  */
 @ExceptionHandler(HttpMessageConversionException.class)
 public ServiceResult parameterTypeException(HttpMessageConversionException exception){

  logger.error(exception.getCause().getLocalizedMessage());
  return ServiceResult.error("类型转换错误");

 }

}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持亿速云。

Spring Boot 数据校验@Valid+统一异常处理的实现

相关阅读