SpringBoot 使用hibernate validator校验

本文将全面的介绍如何使用 validator 进行数据校验

本文源码：

准备工作

我们只需要引入 spring-boot-starter-web 包即可使用

1.常用注解

常用注解

2.简单的实体校验

public class carddto {

  @notblank
  private string cardid;

  @size(min = 10, max = 10)
  @notnull
  private string cardnum; // 卡号

  @past
  @notnull
  private date createdate;

  @range(max = 3)
  private string cardtype;

  // 省略get set
}

@restcontroller
public class usercontroller {

  @postmapping("simple")
  public object simple(@requestbody @valid carddto carddto) {
    return carddto;
  }

}

• 实体属性上添加校验注解
• controller 方法 参数前 使用@valid 即可

3. 复杂的实体校验

 3.1 嵌套实体校验

public class userdto {

  @notblank
  private string userid;

  @notblank
  private string username;

  private string password;

  @valid
  private list<carddto> cardlist;

  //省略 get set
}

controller 写法 同上，只是在 userdto cardlist 属性上标记@valid 注解 即可。 3.2 list<dto> 校验

无效示例

如果我们想校验 一个实体list，如上图所示的这种写法是完全不起效的。

我们需要像 嵌套校验 时一样，对 list<carddto> 做一层封装

public class validlist<e> implements list<e> {

  @valid
  private list<e> list = new arraylist<>();

  public list<e> getlist() {
    return list;
  }

  public void setlist(list<e> list) {
    this.list = list;
  }

  // 省略了 实现方法
}

重写实现方法完全使用 this.list.xxx()

gitee:spring 会将数据封装到我们定义的 list 属性中，又将属性声明了 @valid 使得 hibernate validator 可以为我们做校验！

3.3 使用 @validated 分组校验

public interface insert {
}

public interface update {
}

定义两个接口

public class groupcarddto {

  @notblank(groups = {update.class})
  private string id;

  @notblank(groups = {insert.class})
  private string cardnum;

  @notnull(groups = {insert.class, update.class})
  private integer cardtype;

  //省略 get set
}

实体标记的注解中添加 group 属性

@postmapping("insert_card")
  public object insert_card(@requestbody @validated(insert.class) groupcarddto card){
    return card;
  }

使用 @validated(xxx.class) 标记参数，完成分组校验！

4.自定义注解校验

当 validator 提供的注解无法满足我们的业务需求，可以通过自定义的方式来实现校验。

需求：校验某字符串必须为大写或者小写

public enum casemode {
  upper,
  lower
}

定义一个枚举类

import javax.validation.constraint;
import javax.validation.payload;
import java.lang.annotation.*;

@target( { elementtype.field })
@retention(retentionpolicy.runtime)
@constraint(validatedby = checkcasevalidator.class)
@documented
public @interface checkcase {

  string message() default "";

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

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

  casemode value() default casemode.lower;

}

• 定义注解
• @constraint 指定我们的校验逻辑实现类

import javax.validation.constraintvalidator;
import javax.validation.constraintvalidatorcontext;

public class checkcasevalidator implements constraintvalidator<checkcase, string> {

  private casemode casemode;

  @override
  public void initialize(checkcase constraintannotation) {
    this.casemode = constraintannotation.value();
  }

  @override
  public boolean isvalid(string value, constraintvalidatorcontext context) {

    if (value == null || "".equals(value.trim())) {
      return false;
    }

    switch (this.casemode) {
      case lower:
        return value.equals(value.tolowercase());
      case upper:
        return value.equals(value.touppercase());
      default:
        return false;
    }

  }

}

• initialize() 初始化时执行，可以用来获取注解中的属性
• isvalid() 实现我们的校验逻辑

备注

我们自定义的注解依然支持 @validated group 分组

本节源码：

本地下载地址：

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