快捷導(dǎo)航

Spring @Valid @Validated實(shí)現(xiàn)驗(yàn)證

更新時(shí)間：2020年01月08日 09:51:49 作者：麥穗兒

這篇文章主要介紹了Spring @Valid @Validated實(shí)現(xiàn)驗(yàn)證，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

對(duì)于屬性的驗(yàn)證有如下一些注解
@NotBlank：只用在String上，值不能為null，并且trim后長(zhǎng)度大于零。不為null，不是全為空格的字符串
@NotNull: 不能為null,但可以是長(zhǎng)度為零的字符串
@NotEmpty: 不能為null，長(zhǎng)度大于零
@Null：必須為null
@Min(value): 數(shù)字，值必須大于等于指定的值
@Max(value): 數(shù)字，值必須小雨等于指定的值
@DecimalMin(value): 數(shù)字，值必須大于等于指定的值
@DecimalMax(value): 數(shù)字，值必須小雨等于指定的值
@Digits(integer, fraction)：數(shù)字，值必須在可接收的范圍內(nèi)@Digits(integer=3, fraction=2) 111.22是符合要求的，1111.22不符合，整數(shù)部分4位所以不符合要求
@Size(min=v1,max=v2): v1<=值<=v2
@AssertTrue: 必須為true
@AssertFalse: 必須為false
@Past: 必須是過(guò)去的日期
@Future: 必須是將來(lái)的日期
@Pattern(regex=, flag=): 符合指定的正則表達(dá)式

@Valid：可以用在方法參數(shù)，方法，屬性上。用來(lái)進(jìn)行嵌套驗(yàn)證。嵌套驗(yàn)證就是在ClassA的屬性中有ClassB，而ClassB的屬性也需要進(jìn)行驗(yàn)證。

@Validated:可以用在方法參數(shù)，方法上，不能用在屬性上。提供了分組的功能，在參數(shù)傳入時(shí)根據(jù)分組采用不同的驗(yàn)證機(jī)制。說(shuō)明一下分組，例如對(duì)于User的userID，在新建用戶時(shí)userID必須要為null。在更新用戶時(shí)userID必須要不為空并且不能都是空格（blank）。這就對(duì)userID進(jìn)行了分組功能，Add和Update兩個(gè)組。

@Valid實(shí)例

Book定義

public class Book {

  @NotBlank(message = "bookID is mandatory, can not be blank")
  public String bookID;
  
  @Size(min=5, max=20)
  @NotBlank(message = "bookName is mandatory, can not be blank")
  public String bookName;
  public String author;
  
  @Valid
  public List<ChapterInfo> chapterList;
  
  public Book(String id, String name, String auth) {
    bookName = name;
    author = auth;
    bookID = id;
  }
}

ChapterInfo定義

public class ChapterInfo {
  @Min(0)
  public Long chapterID;
  
  @NotBlank
  @Size(min=5, max=50)
  public String chapterName;
  
  @Size(min=5, max=20)
  public String contentID;
}

BookController

@RestController
@RequestMapping("/bookcontroller")
public class BookController {

  private List<Book> bookList = new ArrayList();
  
  @ResponseBody
  @RequestMapping("/addBookToList")
  public boolean addBookToList(@Valid @RequestBody Book b) {
    System.out.println(b.bookName);
    
    bookList.add(b);
    
    return true;
  }
  
  @InitBinder
  private void activateDirectFieldAccess(DataBinder dataBinder) {
    dataBinder.initDirectFieldAccess();
  }
  
}

Postman驗(yàn)證

可以看到chapterList中的ChapterInfo的chapterName為blank，驗(yàn)證不通過(guò)

@Validated實(shí)例

public class User {
  
  @NotBlank
  public String name;
  
  @NotBlank
  public String address;
  
  @Min(1)
  public int age;

  public boolean isMan;
  
  @NotBlank(groups = {Update.class})
  @Null(groups = {Add.class})
  public String usrID;
  
  public interface Add{}
  
  public interface Update{}
  
  
  public User(String name, String addr, int age, boolean isMan) {
    this.name = name;
    this.address = addr;
    this.age = age;
    this.isMan = isMan;
  }

}

其中對(duì)usrID屬性使用了@NotBlank(groups = {Update.class})和@Null(groups = {Add.class})注釋。意思是：
(1)Update user時(shí)usrID不能為blank（要通過(guò)usrID查找user去update）
(2)Add user時(shí)usrID必須為空（要生成新的user，會(huì)分配user ID）

@RestController
@RequestMapping("/registcontroller")
public class RegistController {

  List<User> usrList = new ArrayList();
  
  
  @PostMapping(path="/adduser")
  @ResponseBody
  public User addUser(@RequestBody @Validated({User.Add.class}) User usr, BindingResult result) {
    
    if (result.hasErrors()) {
      List<ObjectError> list = result.getAllErrors();
      FieldError error = (FieldError)list.get(0);
      System.out.println(error.getObjectName() + "," + error.getField() + "," + error.getDefaultMessage());
      return null;
    }
    User user = new User(usr.name, usr.address, usr.age, usr.isMan);
    String usrID = usrList.size() + "";
    
    user.usrID = usrID;
    
    return user;
  }
}

在addUser的傳入?yún)?shù)進(jìn)行了Validated的分組驗(yàn)證（Add)，如果傳入U(xiǎn)ser的usrID不為blank則會(huì)出錯(cuò)。

PostMan驗(yàn)證

usrID不存在時(shí)