Spring的@Validation和javax包下的@Valid區(qū)別以及自定義校驗(yàn)注解
1.后臺參數(shù)校驗(yàn)
Spring Validation驗(yàn)證框架對參數(shù)的驗(yàn)證機(jī)制提供了@Validated(Spring JSR-303規(guī)范,是標(biāo)準(zhǔn)JSR-303的一個變種),javax提供了@Valid(標(biāo)準(zhǔn)JSR-303規(guī)范),配合BindingResult可以直接提供參數(shù)驗(yàn)證結(jié)果
spring提供的驗(yàn)證:org.springframework.validation.annotation.Validated;
javax提供的驗(yàn)證:javax.validation.Valid;
在檢驗(yàn)Controller的入?yún)⑹欠穹弦?guī)范時,使用@Validated或者@Valid在基本驗(yàn)證功能上沒有太多區(qū)別。但是在分組、注解地方、嵌套驗(yàn)證等功能上兩個有所不同:
1.1 分組
@Validated:提供了一個分組功能,可以在入?yún)Ⅱ?yàn)證時,根據(jù)不同的分組采用不同的驗(yàn)證機(jī)制,這個網(wǎng)上也有資料,不詳述。
@Valid:作為標(biāo)準(zhǔn)JSR-303規(guī)范,還沒有分組的功能。
1.2 注解地方
@Validated:可以用在類型、方法和方法參數(shù)上。但是不能用在成員屬性(字段)上
@Valid:可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性(字段)上
兩者是否能用于成員屬性(字段)上直接影響能否提供嵌套驗(yàn)證的功能。
1.3 嵌套驗(yàn)證
@Validated:用在方法入?yún)⑸蠠o法單獨(dú)提供嵌套驗(yàn)證功能。不能用在成員屬性(字段)上,也無法提示框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。
示例代碼:
#使用@Validated的分組功能,需要提供接口,原因是
@Target({ElementType.TYPE, ElementType.METHOD,ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {
Class<?>[] value() default {}; #需要定義類型做區(qū)分,所以提供個接口做分組區(qū)分
}
示例分類接口:
public interface CreateGroup {
}
#在需要驗(yàn)證的字段上添加分組即可
示例代碼:
public class WebOrderQo {
/**
* 用戶ID
*/
@ApiModelProperty("用戶ID")
@NotNull(message = "用戶ID不能為空", groups = {UpdateGroup.class, CreateGroup.class, QueryGroup.class})
private Long uid;
}
#在Controller里面的方法上加@Validated注解,啟動分組需要在@Validated(CreateGroup.class)填上對應(yīng)的分組類型,默認(rèn)沒有指定分組的校驗(yàn)注解@NotNull,在分組校驗(yàn)情況@Validated({CreateGroup.class})下不生效,只會在@Validated生效;
示例代碼:
@RestController
public class ItemController {
@RequestMapping("/item/add")
public void addItem(@Validated Item item, BindingResult bindingResult) {
doSomething();
}
}
@Valid:用在方法入?yún)⑸蠠o法單獨(dú)提供嵌套驗(yàn)證功能。能夠用在成員屬性(字段)上,提示驗(yàn)證框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證
示例代碼:
public class Item {
@NotNull(message = "id不能為空")
@Min(value = 1, message = "id必須為正整數(shù)")
@ListValue(vals = {0,1}) //自定義注解
private Long id;
@Valid // 嵌套驗(yàn)證必須用@Valid
@NotNull(message = "props不能為空")
@Size(min = 1, message = "props至少要有一個自定義屬性") //嵌套驗(yàn)證
private List<Prop> props;
}
2.自定義參數(shù)驗(yàn)證注解
當(dāng)驗(yàn)證框架提供的驗(yàn)證注解無法滿足業(yè)務(wù)需求的時候,可以自定義驗(yàn)證注解實(shí)現(xiàn)我們的業(yè)務(wù)需求
1)、編寫一個自定義的校驗(yàn)注解
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
String message() default "{pers.store.market.common.valid.ListValue.message}"; //可以在配置文件中配置自定的消息提醒
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
int[] vals() default { };
}
注意:可以在resources下面創(chuàng)建ValidationMessages.properties文件,讀取自定義的提示消息
pers.store.market.common.valid.ListValue.message=參數(shù)提交錯誤
2)、編寫一個自定義的校驗(yàn)器ConstraintValidator
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
private Set<Integer> set = new HashSet<>();
//初始化方法
@Override
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
for (int val : vals) {
set.add(val);
}
}
/**
*
* @param value 需要校驗(yàn)的值
* @param context
* @return
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
return set.contains(value);
}
}
3)、關(guān)聯(lián)自定義的校驗(yàn)器和自定義的校驗(yàn)注解
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class【可以指定多個不同的校驗(yàn)器適配不同類型的校驗(yàn)】 })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {}
到此這篇關(guān)于Spring的@Validation和javax包下的@Valid區(qū)別以及自定義校驗(yàn)注解的文章就介紹到這了,更多相關(guān)Spring的@Validation和@Valid區(qū)別內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
springboot jpa實(shí)現(xiàn)優(yōu)雅處理isDelete的默認(rèn)值
如果多個實(shí)體類都有 isDelete 字段,并且你希望在插入時為它們統(tǒng)一設(shè)置默認(rèn)值時改怎么做呢,本文為大家整理了一些方法,希望對大家有所幫助2024-11-11
Java多線程并發(fā)JUC包ReentrantLock顯示鎖的用法
這篇文章主要介紹了Java多線程并發(fā)JUC包ReentrantLock顯示鎖的用法,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-05-05
SpringBoot項(xiàng)目優(yōu)雅的全局異常處理方式(全網(wǎng)最新)
這篇文章主要介紹了SpringBoot項(xiàng)目優(yōu)雅的全局異常處理方式(全網(wǎng)最新),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
Mybatis-Plus根據(jù)時間段去查詢數(shù)據(jù)的實(shí)現(xiàn)示例
這篇文章主要介紹了Mybatis-Plus根據(jù)時間段去查詢數(shù)據(jù)的實(shí)現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
Spring Validation方法實(shí)現(xiàn)原理分析
這篇文章主要介紹了Spring Validation實(shí)現(xiàn)原理分析,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-07-07
Java多線程之定時器Timer的實(shí)現(xiàn)
這篇文章主要為大家詳細(xì)介紹了Java多線程中定時器Timer類的使用以及模擬實(shí)現(xiàn),文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-10-10
spring的事務(wù)傳播屬性REQUIRED_NESTED原理
這篇文章主要介紹了spring的事務(wù)傳播屬性REQUIRED_NESTED原理,在spring中,要想使用事務(wù)中的回滾點(diǎn),可以使用傳播屬性NESTED,需要的朋友可以參考下2023-05-05
學(xué)習(xí)Java的static與final關(guān)鍵字
本篇文章給大家詳細(xì)分析了Java的static與final關(guān)鍵字知識點(diǎn)以及相關(guān)代碼分享,有需要的讀者跟著學(xué)習(xí)下吧。2018-03-03

