快捷導(dǎo)航

SpringBoot使用@Validated處理校驗的方法步驟

更新時間：2024年08月13日 09:12:52 作者：你住過的屋檐

@Validated?注解的主要目的是啟用和利用?Spring?的驗證框架,它可以用于類上也可以用于方法參數(shù)上,本文給大家介紹了SpringBoot使用@Validated優(yōu)雅的處理校驗的方法步驟,通過代碼示例介紹的非常詳細(xì),需要的朋友可以參考下

前言

@Validated 注解的主要目的是啟用和利用 Spring 的驗證框架，它可以用于類上也可以用于方法參數(shù)上。用于類上時，表示該類中的所有方法參數(shù)都需要通過驗證框架進(jìn)行驗證；用于方法參數(shù)上時，則僅表示該參數(shù)需要被驗證。選擇哪種方式取決于具體的業(yè)務(wù)需求和個人偏好。

步驟

1、引入依賴，這是 Spring 用來實現(xiàn)數(shù)據(jù)驗證的基礎(chǔ)庫

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、然后我們將注解@Validated放在類上開啟驗證功能，將注解@Valid放在參數(shù)實體上代表對實體進(jìn)行校驗，例如

@RestController
@RequestMapping("/test")
@Validated
public class TestController {
    @PostMapping()
    public R test(@Valid @RequestBody TestDTO dto){
        return R.ok("響應(yīng)成功");
    }
}

3、然后我們在請求體中隨時用如下注解即可通過框架自動進(jìn)行驗證，我這里是使用統(tǒng)一異常捕捉進(jìn)行全局異常情況攔截，有關(guān)統(tǒng)一異常封裝，大家可以關(guān)注我看我另一篇文章。

統(tǒng)一的參數(shù)異常捕捉

/**
	 *處理參數(shù)校驗異常
	 * @param e
	 * @return
	 */
	@ExceptionHandler
	public R handlerException(MethodArgumentNotValidException e) {
		e.printStackTrace();
		BindingResult bindingResult = e.getBindingResult();
		return R.fail(bindingResult.getFieldErrors().get(0).getDefaultMessage());
	}

參數(shù)實體

import lombok.Data;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
@Data
public class TestDTO {
    @NotBlank(message = "a參數(shù)不能為空")
    private String a;
    @NotNull(message = "b參數(shù)不能為null")
    private String b;
    @Max(value = 10,message = "請輸入正確的范圍")
    private Integer c;
}

4、通過apifox工具調(diào)用測試結(jié)果如下

5、以下是常用的注解說明

注解	類型	說明
@Null	Object	校驗必須為null
@NotNull	Object	校驗必須不能是null，并且必須有一個非空格字符
@NotEmpty	字符串、集合、映射等類型	值不為空（即不為 null 且不為空字符串、空集合或空映射）。
@AssertTrue	boolean、Boolean	參數(shù)需要為true，傳null允許通過，注意，當(dāng)傳了0時會認(rèn)為是false不通過
@AssertFalse	boolean、Boolean	參數(shù)需要為true，傳null允許通過，注意，當(dāng)傳了0時會認(rèn)為是false允許通過
@Max	BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	允許的最大值，null允許通過
@Min	BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	允許的最小值，null允許通過
@Negative	BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	數(shù)字類型的值必須小于零，null允許通過
@Negative	BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	數(shù)字類型的值必須小于等于零，null允許通過
@Positive	BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	數(shù)字類型的值必須大于零，null允許通過
@PositiveOrZero	BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	數(shù)字類型的值必須大于等于零，null允許通過
@Digits(integer = 10, fraction = 2)	字符串、BigDecimal、BigInteger，基本數(shù)字類型及其包裝類等	整數(shù)位數(shù)和小數(shù)位數(shù)限制，null允許通過
@Pattern	字符串	正則表達(dá)式匹配，null允許通過
@Email字符串	字符串	郵箱格式校驗，null允許通過
@Size	字符串、集合、映射等類	校驗大小的范圍，null允許通過，如 @Size(min = 1, max = 3, message = “最大范圍為1-3”)