SpringBoot 使用hibernate validator校驗(yàn)

更新時(shí)間：2018年11月27日 11:32:22 作者：殷天文

這篇文章主要介紹了SpringBoot 使用hibernate validator校驗(yàn)，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

準(zhǔn)備工作

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

1.常用注解

常用注解

2.簡(jiǎn)單的實(shí)體校驗(yàn)

public class CardDTO {

  @NotBlank
  private String cardId;

  @Size(min = 10, max = 10)
  @NotNull
  private String cardNum; // 卡號(hào)

  @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;
  }

}

實(shí)體屬性上添加校驗(yàn)注解
controller 方法參數(shù)前使用@Valid 即可

3. 復(fù)雜的實(shí)體校驗(yàn)

3.1 嵌套實(shí)體校驗(yàn)

public class UserDTO {

  @NotBlank
  private String userId;

  @NotBlank
  private String username;

  private String password;

  @Valid
  private List<CardDTO> cardList;

  //省略 get set
}

controller 寫法同上，只是在 UserDTO cardList 屬性上標(biāo)記@Valid 注解即可。 3.2 List<DTO> 校驗(yàn)

無(wú)效示例

如果我們想校驗(yàn) 一個(gè)實(shí)體List，如上圖所示的這種寫法是完全不起效的。

我們需要像 嵌套校驗(yàn) 時(shí)一樣，對(duì) 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;
  }

  // 省略了 實(shí)現(xiàn)方法
}

重寫實(shí)現(xiàn)方法完全使用 this.list.xxx()

Gitee:spring 會(huì)將數(shù)據(jù)封裝到我們定義的 list 屬性中，又將屬性聲明了 @Valid 使得 hibernate validator 可以為我們做校驗(yàn)！

3.3 使用 @Validated 分組校驗(yàn)

public interface Insert {
}

public interface Update {
}

定義兩個(gè)接口

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
}

實(shí)體標(biāo)記的注解中添加 group 屬性

@PostMapping("insert_card")
  public Object insert_card(@RequestBody @Validated(Insert.class) GroupCardDTO card){
    return card;
  }

使用 @Validated(xxx.class) 標(biāo)記參數(shù)，完成分組校驗(yàn)！

4.自定義注解校驗(yàn)

當(dāng) validator 提供的注解無(wú)法滿足我們的業(yè)務(wù)需求，可以通過(guò)自定義的方式來(lái)實(shí)現(xiàn)校驗(yàn)。

需求：校驗(yàn)?zāi)匙址仨殲榇髮懟蛘咝?/p>

public enum CaseMode {
  UPPER,
  LOWER
}

定義一個(gè)枚舉類

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 指定我們的校驗(yàn)邏輯實(shí)現(xiàn)類

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;
    }

  }

}