參數驗證 @Validated 和 @Valid 的區別

lieeps 發布于2019-08-16 14:37 / 2572人閱讀

摘要：也就是說如果傳的中有的為空或者是負數，入參驗證不會檢測出來。為了能夠進行嵌套驗證，必須手動在實體的字段上明確指出這個字段里面的實體也要進行驗證。用在方法入參上無法多帶帶提供嵌套驗證功能。

來源：blog.csdn.net/qq_27680317/article/details/79970590
整編：Java技術棧（公眾號ID：javastack）

Spring Validation驗證框架對參數的驗證機制提供了@Validated（Spring"s JSR-303 規范，是標準 JSR-303 的一個變種），javax提供了@Valid（標準JSR-303規范），配合 BindingResult 可以直接提供參數驗證結果。其中對于字段的特定驗證注解比如 @NotNull 等網上到處都有，這里不詳述

在檢驗 Controller 的入參是否符合規范時，使用 @Validated 或者 @Valid 在基本驗證功能上沒有太多區別。但是在分組、注解地方、嵌套驗證等功能上兩個有所不同：

1. 分組

@Validated：提供了一個分組功能，可以在入參驗證時，根據不同的分組采用不同的驗證機制，這個網上也有資料，不詳述。@Valid：作為標準JSR-303規范，還沒有吸收分組的功能。

2. 注解地方

@Validated：可以用在類型、方法和方法參數上。但是不能用在成員屬性（字段）上

@Valid：可以用在方法、構造函數、方法參數和成員屬性（字段）上

兩者是否能用于成員屬性（字段）上直接影響能否提供嵌套驗證的功能。

3. 嵌套驗證

在比較兩者嵌套驗證時，先說明下什么叫做嵌套驗證。比如我們現在有個實體叫做Item：

public class Item {

    @NotNull(message = "id不能為空")
    @Min(value = 1, message = "id必須為正整數")
    private Long id;

    @NotNull(message = "props不能為空")
    @Size(min = 1, message = "至少要有一個屬性")
    private List props;
}

Item帶有很多屬性，屬性里面有屬性id，屬性值id，屬性名和屬性值，如下所示：

public class Prop {

    @NotNull(message = "pid不能為空")
    @Min(value = 1, message = "pid必須為正整數")
    private Long pid;

    @NotNull(message = "vid不能為空")
    @Min(value = 1, message = "vid必須為正整數")
    private Long vid;

    @NotBlank(message = "pidName不能為空")
    private String pidName;

    @NotBlank(message = "vidName不能為空")
    private String vidName;
}

屬性這個實體也有自己的驗證機制，比如屬性和屬性值id不能為空，屬性名和屬性值不能為空等。

現在我們有個 ItemController 接受一個Item的入參，想要對Item進行驗證，如下所示：

@RestController
public class ItemController {

    @RequestMapping("/item/add")
    public void addItem(@Validated Item item, BindingResult bindingResult) {
        doSomething();
    }
}

在上圖中，如果Item實體的props屬性不額外加注釋，只有@NotNull和@Size，無論入參采用@Validated還是@Valid驗證，Spring Validation框架只會對Item的id和props做非空和數量驗證，不會對props字段里的Prop實體進行字段驗證，也就是@Validated和@Valid加在方法參數前，都不會自動對參數進行嵌套驗證。也就是說如果傳的List中有Prop的pid為空或者是負數，入參驗證不會檢測出來。

為了能夠進行嵌套驗證，必須手動在Item實體的props字段上明確指出這個字段里面的實體也要進行驗證。由于@Validated不能用在成員屬性（字段）上，但是@Valid能加在成員屬性（字段）上，而且@Valid類注解上也說明了它支持嵌套驗證功能，那么我們能夠推斷出：@Valid加在方法參數時并不能夠自動進行嵌套驗證，而是用在需要嵌套驗證類的相應字段上，來配合方法參數上@Validated或@Valid來進行嵌套驗證。

我們修改Item類如下所示：

public class Item {

    @NotNull(message = "id不能為空")
    @Min(value = 1, message = "id必須為正整數")
    private Long id;

    @Valid // 嵌套驗證必須用@Valid
    @NotNull(message = "props不能為空")
    @Size(min = 1, message = "props至少要有一個自定義屬性")
    private List props;
}

然后我們在ItemController的addItem函數上再使用@Validated或者@Valid，就能對Item的入參進行嵌套驗證。此時Item里面的props如果含有Prop的相應字段為空的情況，Spring Validation框架就會檢測出來，bindingResult就會記錄相應的錯誤。

總結一下 @Validated 和 @Valid 在嵌套驗證功能上的區別：

@Validated： 用在方法入參上無法多帶帶提供嵌套驗證功能。不能用在成員屬性（字段）上，也無法提示框架進行嵌套驗證。能配合嵌套驗證注解@Valid進行嵌套驗證。

@Valid： 用在方法入參上無法多帶帶提供嵌套驗證功能。能夠用在成員屬性（字段）上，提示驗證框架進行嵌套驗證。能配合嵌套驗證注解@Valid進行嵌套驗證。

另外，棧長已經整理了 Java 系列核心知識點文章，關注Java技術棧微信公眾號，在后臺回復關鍵字：java，即可獲取。

關注公眾號，每天推送一篇干貨。

云服務器 GPU云服務器寬帶和專線的區別專線和寬帶的區別空間和域名的區別功能和作用的區別

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/73113.html

@Validated和@Valid的區別？校驗級聯屬性（內部類）

摘要：畢竟永遠相信本文能給你帶來意想不到的收獲使用示例關于數據校驗這一塊在中的使用案例，我相信但凡有點經驗的程序員應該沒有不會使用的，并且還不乏熟練的選手。每篇一句 NBA里有兩大笑話：一是科比沒天賦，二是詹姆斯沒技術相關閱讀【小家Java】深入了解數據校驗：Java Bean Validation 2.0（JSR303、JSR349、JSR380）Hibernate-Validati...

Winer 2019-08-19 10:14 評論0 收藏0
讓Controller支持對平鋪參數執行@Valid數據校驗

摘要：方案一借助對方法級別數據校驗的能力首先必須明確一點此能力屬于框架的，而部分框架。每篇一句在金字塔塔尖的是實踐，學而不思則罔，思而不學則殆（現在很多編程框架都只是教你碎片化的實踐）相關閱讀【小家Java】深入了解數據校驗：Java Bean Validation 2.0（JSR303、JSR349、JSR380）Hibernate-Validation 6.x使用案例【小家Spr...

printempw 2019-08-19 10:15 評論0 收藏0
Spring方法級別數據校驗：@Validated + MethodValidationPostPr

摘要：就這樣借助相關約束注解，就非常簡單明了，語義清晰的優雅的完成了方法級別入參校驗返回值校驗的校驗。但倘若是返回值校驗執行了即使是失敗了，方法體也肯定被執行了只能哪些類型上提出這個細節的目的是約束注解并不是能用在所有類型上的。每篇一句在《深度工作》中作者提出這么一個公式：高質量產出=時間*專注度。所以高質量的產出不是靠時間熬出來的，而是效率為王相關閱讀【小家Java】深入了解數據校...

孫吉亮 2019-08-19 10:11 評論0 收藏0
Hibernate-Validator 驗證參數

摘要：添加依賴，如果使用了，則不需要引用任何依賴，因為包中已經包含了依賴在類的屬性上加上對應的注解核查結果中文不能為空檢查結果中文級聯校驗不能超過個嫌疑人集合被注釋的元素必須為被注釋的元素必須不為被注釋的元素必須為被注釋的元素必須為被 1.添加 Hibernate-Validator 依賴，如果使用了springboot，則不需要引用任何依賴，因為spring-boot-starter-we...

myeveryheart 2019-08-16 18:37 評論0 收藏0
Java驗證

摘要：校驗器可以通過對象報告校驗失敗的信息接口定義示例如下，可以使用等工具測試用戶名不能為空常用注解也可以自定義注解及其校驗規則獲取并初始化注解信息設置自定義校驗規則人的姓名不能為空參考 Q: 為什么后端需要校驗，只交給前端校驗行不行A: 前后端都需要校驗后端校驗防止請求過來的非法數據，對后端進行破壞 Java后端常用的校驗框架 Apache commons-validator http...

funnyZhang 2019-08-15 12:17 評論0 收藏0