SpringBoot 使用hibernate validator校驗(yàn)
本文將全面的介紹如何使用 validator 進(jìn)行數(shù)據(jù)校驗(yàn)
本文源碼： https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate
準(zhǔn)備工作
我們只需要引入 spring-boot-starter-web 包即可使用
1.常用注解
常用注解
2.簡單的實(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)
無效示例
如果我們想校驗(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 提供的注解無法滿足我們的業(yè)務(wù)需求，可以通過自定義的方式來實(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;
}
}
}
- initialize() 初始化時(shí)執(zhí)行，可以用來獲取注解中的屬性
- isValid() 實(shí)現(xiàn)我們的校驗(yàn)邏輯
備注
我們自定義的注解依然支持 @Validated group 分組
本節(jié)源碼： https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate
本地下載地址：springboot-validate_jb51.rar
以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
- SpringBoot使用Validator進(jìn)行參數(shù)校驗(yàn)實(shí)戰(zhàn)教程(自定義校驗(yàn)，分組校驗(yàn))
- 如何通過自定義spring?invalidator注解校驗(yàn)數(shù)據(jù)合法性
- Spring 校驗(yàn)(validator,JSR-303)簡單實(shí)現(xiàn)方式
- springboot validator枚舉值校驗(yàn)功能實(shí)現(xiàn)
- Spring中校驗(yàn)器(Validator)的深入講解
- springboot使用Validator校驗(yàn)方式
- springboot使用hibernate validator校驗(yàn)方式
- Spring Validator從零掌握對(duì)象校驗(yàn)的詳細(xì)過程
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于Java在控制臺(tái)輸出帶顏色字符的2種方式,文中通過實(shí)例代碼以及圖文介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2022-01-01
Android開發(fā)Activity管理工具類的操作方法
這篇文章主要介紹了Android開發(fā)Activity管理工具類,下面是一個(gè)完整的Activity管理工具類實(shí)現(xiàn),可以幫助你管理應(yīng)用中的所有Activity,方便一鍵退出應(yīng)用、獲取當(dāng)前Activity等操作,需要的朋友可以參考下2021-02-02
這篇文章主要介紹了在Java中使用Jwt的示例代碼，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
這篇文章主要介紹了spring控制事務(wù)的三種方式小結(jié)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-10-10
springboot+mybatis+redis 二級(jí)緩存問題實(shí)例詳解
為何HashSet中使用PRESENT而不是null作為value
IDEA報(bào)錯(cuò):java:無效的源發(fā)行版21解決方式
java 從int數(shù)組中獲取最大數(shù)的方法