spring註解之@Valid和@Validated的區分總結

2022-03-30 13:01:17

@Valid：

@Valid註解用於校驗，所屬包為：javax.validation.Valid。

① 首先需要在實體類的相應欄位上新增用於充當校驗條件的註解，如：@Min,如下程式碼（age屬於Girl類中的屬性）：

@Min(value = 18,message = "未成年禁止入內")  
private Integer age;

② 其次在controller層的方法的要校驗的引數上新增@Valid註解，並且需要傳入BindingResult物件，用於獲取校驗失敗情況下的反饋資訊，如下程式碼：

@PostMapping("/girls")  
public Girl addGirl(@Valid Girl girl, BindingResult bindingResult) {  
    if(bindingResult.hasErrors()){  
        System.out.println(bindingResult.getFieldError().getDefaultMessage());  
        return null;  
    }  
    return girlResposity.save(girl);  
}

bindingResult.getFieldError.getDefaultMessage()用於獲取相應欄位上新增的message中的內容，如：@Min註解中message屬性的內容

@Validated：

@Valid是javax.validation裡的。

@Validated是@Valid 的一次封裝，是Spring提供的校驗機制使用。@Valid不提供分組功能

@Validated的特殊用法

1、分組

當一個實體類需要多種驗證方式時，例：對於一個實體類的id來說，新增的時候是不需要的，對於更新時是必須的。

可以通過groups對驗證進行分組

分組介面類（通過向groups分配不同類的class物件，達到分組目的）：

package com.valid.interfaces;  
public interface First {  
}

實體類：

package com.valid.pojo;  
import javax.validation.constraints.Size;  
import org.hibernate.validator.constraints.NotEmpty;  
import com.valid.interfaces.First;  
public class People {  
    //在First分組時，判斷不能為空  
    @NotEmpty(groups={First.class})  
    private String id;  
    //name欄位不為空，且長度在3-8之間  
    @NotEmpty  
    @Size(min=3,max=8)  
    private String name;  
    public String getName() {  
        return name;  
    }  
    public void setName(String name) {  
        this.name = name;  
    }  
    public String getId() {  
        return id;  
    }  
    public void setId(String id) {  
        this.id = id;  
    }  
}

注：

(1)不分配groups，預設每次都要進行驗證

(2)對一個引數需要多種驗證方式時，也可通過分配不同的組達到目的。例：

@NotEmpty(groups={First.class})  
@Size(min=3,max=8,groups={Second.class})  
private String name;

控制類：

package com.valid.controller;  
import org.springframework.stereotype.Controller;  
import org.springframework.validation.BindingResult;  
import org.springframework.validation.annotation.Validated;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.ResponseBody;  
import com.valid.interfaces.First;  
import com.valid.pojo.People;  
@Controller  
public class FirstController {  
    @RequestMapping("/addPeople")  
    //不需驗證ID  
    public @ResponseBody String addPeople(@Validated People p,BindingResult result)  
    {  
        System.out.println("people's ID:" + p.getId());  
        if(result.hasErrors())  
        {  
            return "0";  
        }  
        return "1";  
    }  
      
    @RequestMapping("/updatePeople")  
    //需要驗證ID  
    public @ResponseBody String updatePeople(@Validated({First.class}) People p,BindingResult result)  
    {  
        System.out.println("people's ID:" + p.getId());  
        if(result.hasErrors())  
        {  
            return "0";  
        }  
        return "1";  
    }  
}

注：

@Validated沒有新增groups屬性時，預設驗證沒有分組的驗證屬性，如該例子：People的name屬性。

@Validated沒有新增groups屬性時，所有引數的驗證型別都有分組（即本例中People的name的@NotEmpty、@Size都新增groups屬性），則不驗證任何引數

2、組序列

預設情況下，不同組別的約束驗證是無序的，然而在某些情況下，約束驗證的順序卻很重要。

例：

（1）第二個組中的約束驗證依賴於一個穩定狀態來執行，而這個穩定狀態是由第一個組來進行驗證的。

（2）某個組的驗證比較耗時，CPU 和記憶體的使用率相對比較大，最優的選擇是將其放在最後進行驗證。因此，在進行組驗證的時候尚需提供一種有序的驗證方式，這就提出了組序列的概念。
一個組可以定義為其他組的序列，使用它進行驗證的時候必須符合該序列規定的順序。在使用組序列驗證的時候，如果序列前邊的組驗證失敗，則後面的組將不再給予驗證。

分組介面類（通過@GroupSequence註解對組進行排序）：

package com.valid.interfaces;  
public interface First {  
}

package com.valid.interfaces;  
public interface Second {  
}

package com.valid.interfaces;  
import javax.validation.GroupSequence;  
@GroupSequence({First.class,Second.class})  
public interface Group {  
}

實體類：

package com.valid.pojo;  
import javax.validation.constraints.Size;  
import org.hibernate.validator.constraints.NotEmpty;  
import com.valid.interfaces.First;  
import com.valid.interfaces.Second;  
public class People {  
    //在First分組時，判斷不能為空  
    @NotEmpty(groups={First.class})  
    private String id;  
      
    //name欄位不為空，且長度在3-8之間  
    @NotEmpty(groups={First.class})  
    @Size(min=3,max=8,groups={Second.class})  
    private String name;  
  
    public String getName() {  
        return name;  
    }  
  
    public void setName(String name) {  
        this.name = name;  
    }  
  
    public String getId() {  
        return id;  
    }  
  
    public void setId(String id) {  
        this.id = id;  
    }  
}

控制類：

package com.valid.controller;  
import org.springframework.stereotype.Controller;  
import org.springframework.validation.BindingResult;  
import org.springframework.validation.annotation.Validated;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.ResponseBody;  
import com.valid.interfaces.Group;  
import com.valid.pojo.People;  
import com.valid.pojo.Person;  
@Controller  
public class FirstController {  
    @RequestMapping("/addPeople")  
    //不需驗證ID  
    public @ResponseBody String addPeople(@Validated({Group.class}) People p,BindingResult result)  
    {  
        if(result.hasErrors())  
        {  
            return "0";  
        }  
        return "1";  
    }  
}

3、驗證多個物件

一個功能方法上處理多個模型物件時，需新增多個驗證結果物件

package com.valid.controller;  
import org.springframework.stereotype.Controller;  
import org.springframework.validation.BindingResult;  
import org.springframework.validation.annotation.Validated;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.ResponseBody;  
import com.valid.pojo.People;  
import com.valid.pojo.Person;  
@Controller  
public class FirstController {  
    @RequestMapping("/addPeople")  
    public @ResponseBody String addPeople(@Validated People p,BindingResult result,@Validated Person p2,BindingResult result2)  
    {  
        if(result.hasErrors())  
        {  
            return "0";  
        }  
        if(result2.hasErrors())  
        {  
            return "-1";  
        }  
        return "1";  
    }  
}

補充：主要區別

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

	@Validated	@Valid
分組	提供分組功能，可在入參驗證時，根據不同的分組採用不同的驗證機制。	無分組功能
可註解位置	可以用在型別、方法和方法引數上。但是不能用在成員屬性上	可以用在方法、建構函式、方法引數和成員屬性上（兩者是否能用於成員屬性上直接影響能否提供巢狀驗證的功能）
巢狀驗證	用在方法入參上無法單獨提供巢狀驗證功能。不能用在成員屬性上。也無法提供框架進行巢狀驗證。能配合巢狀驗證註解@Valid進行巢狀驗證。	用在方法入參上無法單獨提供巢狀驗證功能。能夠用在成員屬性上，提示驗證框架進行巢狀驗證。能配合巢狀驗證註解@Valid進行巢狀驗證。

總結

到此這篇關於spring註解之@Valid和@Validated的區分總結的文章就介紹到這了,更多相關@Valid和@Validated區分內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！