Spring Validation驗(yàn)證框架對參數(shù)的驗(yàn)證機(jī)制提供了@Validated（Spring's JSR-303 規(guī)范，是標(biāo)準(zhǔn) JSR-303 的一個(gè)變種），javax提供了@Valid（標(biāo)準(zhǔn)JSR-303規(guī)范），配合 BindingResult 可以直接提供參數(shù)驗(yàn)證結(jié)果。其中對于字段的特定驗(yàn)證注解比如 @NotNull 等網(wǎng)上到處都有，這里不詳述

在檢驗(yàn) Controller 的入?yún)⑹欠穹弦?guī)范時(shí)，使用 @Validated 或者 @Valid 在基本驗(yàn)證功能上沒有太多區(qū)別。但是在分組、注解地方、嵌套驗(yàn)證等功能上兩個(gè)有所不同：

1. 分組

@Validated：提供了一個(gè)分組功能，可以在入?yún)Ⅱ?yàn)證時(shí)，根據(jù)不同的分組采用不同的驗(yàn)證機(jī)制，這個(gè)網(wǎng)上也有資料，不詳述。@Valid：作為標(biāo)準(zhǔn)JSR-303規(guī)范，還沒有吸收分組的功能。

2. 注解地方

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

@Valid：可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性（字段）上

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

3. 嵌套驗(yàn)證

在比較兩者嵌套驗(yàn)證時(shí)，先說明下什么叫做嵌套驗(yàn)證。比如我們現(xiàn)在有個(gè)實(shí)體叫做Item：

public class Item {

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

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

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

public class Prop {

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

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

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

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

屬性這個(gè)實(shí)體也有自己的驗(yàn)證機(jī)制，比如屬性和屬性值id不能為空，屬性名和屬性值不能為空等。

現(xiàn)在我們有個(gè) ItemController 接受一個(gè)Item的入?yún)?，想要對Item進(jìn)行驗(yàn)證，如下所示：

@RestController
public class ItemController {

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

在上圖中，如果Item實(shí)體的props屬性不額外加注釋，只有@NotNull和@Size，無論入?yún)⒉捎聾Validated還是@Valid驗(yàn)證，Spring Validation框架只會對Item的id和props做非空和數(shù)量驗(yàn)證，不會對props字段里的Prop實(shí)體進(jìn)行字段驗(yàn)證，也就是@Validated和@Valid加在方法參數(shù)前，都不會自動對參數(shù)進(jìn)行嵌套驗(yàn)證。也就是說如果傳的List<Prop>中有Prop的pid為空或者是負(fù)數(shù)，入?yún)Ⅱ?yàn)證不會檢測出來。

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

我們修改Item類如下所示：

public class Item {

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

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

然后我們在ItemController的addItem函數(shù)上再使用@Validated或者@Valid，就能對Item的入?yún)⑦M(jìn)行嵌套驗(yàn)證。此時(shí)Item里面的props如果含有Prop的相應(yīng)字段為空的情況，Spring Validation框架就會檢測出來，bindingResult就會記錄相應(yīng)的錯(cuò)誤。

總結(jié)一下 @Validated 和 @Valid 在嵌套驗(yàn)證功能上的區(qū)別：

@Validated： 用在方法入?yún)⑸蠠o法單獨(dú)提供嵌套驗(yàn)證功能。不能用在成員屬性（字段）上，也無法提示框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。

@Valid： 用在方法入?yún)⑸蠠o法單獨(dú)提供嵌套驗(yàn)證功能。能夠用在成員屬性（字段）上，提示驗(yàn)證框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評論