SpringBoot 使用hibernate validator校驗

這篇文章主要介紹了SpringBoot 使用hibernate validator校驗，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

本文將全面的介紹如何使用 validator 進行數據校驗

本文源碼： https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate

準備工作

我們只需要引入 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 分組

本節源碼： https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate

本地下載地址：springboot-validate_jb51.rar

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持神馬文庫。