@valid 無法觸發BindingResult的解決

Posted on by

方法參數

public String listFireEvent(@Valid  FireSearch fireSearch, HttpServletRequest request, BindingResult bindingResult)

問題

如果驗證失敗會直接拋出異常，而不是放入bindingResult

原因

@Valid 和 BindingResult 不能有其它類

解決方案

把HttpServletRequest 放到最後

即：

public String listFireEvent(@Valid FireSearch fireSearch, BindingResult bindingResult,HttpServletRequest request)

@Validated和@Valid區別

Spring validation驗證框架對入參實體進行嵌套驗證必須在相應屬性（字段）加上@Valid而不是@Validated

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<Prop> 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>中有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<Prop> props;
}

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

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

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

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：