Spring @Valid @Validated

對於屬性的驗證有以下一些註解
@NotBlank：只用在String上，值不能爲null，而且trim後長度大於零。不爲null，不是全爲空格的字符串
@NotNull: 不能爲null,但能夠是長度爲零的字符串
@NotEmpty: 不能爲null，長度大於零
@Null：必須爲null
@Min(value): 數字，值必須大於等於指定的值
@Max(value): 數字，值必須小雨等於指定的值
@DecimalMin(value): 數字，值必須大於等於指定的值
@DecimalMax(value): 數字，值必須小雨等於指定的值
@Digits(integer, fraction)：數字，值必須在可接收的範圍內@Digits(integer=3, fraction=2) 111.22是符合要求的，1111.22不符合，整數部分4位因此不符合要求
@Size(min=v1,max=v2): v1<=值<=v2
@AssertTrue: 必須爲true
@AssertFalse: 必須爲false
@Past: 必須是過去的日期
@Future: 必須是未來的日期
@Pattern(regex=, flag=): 符合指定的正則表達式

@Valid：能夠用在方法參數，方法，屬性上。用來進行嵌套驗證。嵌套驗證就是在ClassA的屬性中有ClassB，而ClassB的屬性也須要進行驗證。

@Validated:能夠用在方法參數，方法上，不能用在屬性上。提供了分組的功能，在參數傳入時根據分組採用不一樣的驗證機制。說明一下分組，例如對於User的userID，在新建用戶時userID必需要爲null。在更新用戶時userID必需要不爲空而且不能都是空格（blank）。這就對userID進行了分組功能，Add和Update兩個組。

@Valid實例

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驗證

能夠看到chapterList中的ChapterInfo的chapterName爲blank，驗證不經過

@Validated實例

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;
    }

}

其中對usrID屬性使用了@NotBlank(groups = {Update.class})和@Null(groups = {Add.class})註釋。意思是：
(1)Update user時usrID不能爲blank（要經過usrID查找user去update）
(2)Add user時usrID必須爲空（要生成新的user，會分配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的傳入參數進行了Validated的分組驗證（Add)，若是傳入User的usrID不爲blank則會出錯。

PostMan驗證
usrID不存在時

正常返回新添加的user

指定usrID時

出錯