@Valid注解的作用及@Valid注解與@Validated的區(qū)別
更新時(shí)間：2022年08月30日 10:56:35 作者：CrazySnail_x
這篇文章主要介紹了@Valid注解的作用及@Valid注解與@Validated的區(qū)別，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
1.@Valid注解
用于驗(yàn)證注解是否符合要求，直接加在變量user之前，在變量中添加驗(yàn)證信息的要求，當(dāng)不符合要求時(shí)就會(huì)在方法中返回message 的錯(cuò)誤提示信息。
@ApiOperation(value = "Shipping receive completion request from shiphub frontend or app client like OMS", tags = {"Completion APIs"})
@ApiResponses(value = {
@ApiResponse(code = 200, message = "OK"),
@ApiResponse(code = 401, message = "You are not authorized to access to this API"),
@ApiResponse(code = 403, message = "Accessing the resource you were trying to reach is forbidden"),
@ApiResponse(code = 404, message = "The resource you were trying to reach is not found")
})
@PostMapping(value = "/completion", produces = {"application/json"}, consumes = {"application/json"})
public ResponseEntity<ApiResponseDto> actionCompletionShippingOrder(
@ApiParam(value = "request body", required = true) @RequestBody @Valid CompletionOrderRequestDto completionOrderRequestDto,
BindingResult bindingResult) throws Exception {
ApiResponseDto apiResponseDto = shippingCompletionService.requestActionToOrder(bindingResult, completionOrderRequestDto);
if (!AppClientResponse.GENERAL_SUCC.getStatus().equals(apiResponseDto.getStatus())) {
return new ResponseEntity<>(apiResponseDto, HttpStatus.BAD_REQUEST);
}
return new ResponseEntity<>(apiResponseDto, HttpStatus.OK);
}然后在 CompletionOrderRequestDto 類中添加驗(yàn)證信息的要求：
public class CompletionOrderRequestDto implements Serializable, IShiphubRequestDto {
private static final long serialVersionUID = -6593240841146979248L;
@JsonProperty("client_name")
@ICheckAppClientName
private String clientName;
@JsonProperty("ship_group_id")
@NotBlank(message = "shipGroupId不能為空")
private String shipGroupId;
}
@NotBlank 注解所指的 password 字段，表示驗(yàn)證密碼不能為空，如果為空的話，上面 Controller 中的 create 方法會(huì)將message 中的"密碼不能為空"返回。
當(dāng)然也可以添加其他驗(yàn)證信息的要求：
| 限制 | 說明 |
| @Null | 限制只能為null |
| @NotNull | 限制必須不為null |
| @AssertFalse | 限制必須為false |
| @AssertTrue | 限制必須為true |
| @DecimalMax(value) | 限制必須為一個(gè)不大于指定值的數(shù)字 |
| @DecimalMin(value) | 限制必須為一個(gè)不小于指定值的數(shù)字 |
| @Digits(integer,fraction) | 限制必須為一個(gè)小數(shù)，且整數(shù)部分的位數(shù)不能超過integer，小數(shù)部分的位數(shù)不能超過fraction |
| @Future | 限制必須是一個(gè)將來的日期 |
| @Max(value) | 限制必須為一個(gè)不大于指定值的數(shù)字 |
| @Min(value) | 限制必須為一個(gè)不小于指定值的數(shù)字 |
| @Past | 限制必須是一個(gè)過去的日期 |
| @Pattern(value) | 限制必須符合指定的正則表達(dá)式 |
| @Size(max,min) | 限制字符長(zhǎng)度必須在min到max之間 |
| @Past | 驗(yàn)證注解的元素值（日期類型）比當(dāng)前時(shí)間早 |
| @NotEmpty | 驗(yàn)證注解的元素值不為null且不為空（字符串長(zhǎng)度不為0、集合大小不為0） |
| @NotBlank | 驗(yàn)證注解的元素值不為空（不為null、去除首位空格后長(zhǎng)度為0），不同于@NotEmpty，@NotBlank只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的空格 |
| 驗(yàn)證注解的元素值是Email，也可以通過正則表達(dá)式和flag指定自定義的email格式 |
除此之外還可以自定義驗(yàn)證信息的要求，例如上面的 @ICheckAppClientName：
注解的具體內(nèi)容：
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {CheckActionNameCompletionOrderValidator.class})
public @interface ICheckActionNameCompletionOrder {
String message() default "1102";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}這是校驗(yàn)器：
public class CheckActionNameCompletionOrderValidator implements ConstraintValidator<ICheckActionNameCompletionOrder, String> {
private static final Logger logger = LoggerFactory.getLogger(CheckActionNameCompletionOrderValidator.class);
@Value("#{'${Action.completionName}'.split(',')}")
private List<String> actionCompletionOrderList;
@Override
public boolean isValid(String actionName, ConstraintValidatorContext context) {
logger.info("Action completion order name validator: enter action name is { {} }", actionName);
return actionName != null && actionCompletionOrderList.stream().anyMatch(x -> actionName.toLowerCase().equals(x.toLowerCase()));
}
}2.@Valid與@Validated的區(qū)別
- @Valid是使用Hibernate validation的時(shí)候使用
- @Validated是只用Spring Validator校驗(yàn)機(jī)制使用
說明：java的JSR303聲明了@Valid這類接口，而Hibernate-validator對(duì)其進(jìn)行了實(shí)現(xiàn)
@Validation對(duì)@Valid進(jìn)行了二次封裝，在使用上并沒有區(qū)別，但在分組、注解位置、嵌套驗(yàn)證等功能上有所不同，這里主要就這幾種情況進(jìn)行說明。
注解位置
@Validated：用在類型、方法和方法參數(shù)上。但不能用于成員屬性（field）@Valid：可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性（field）上
如：
如果@Validated注解在成員屬性上，則會(huì)報(bào) '@Validdated' not applicable to field 錯(cuò)誤：
分組校驗(yàn)
@Validated：提供分組功能，可以在參數(shù)驗(yàn)證時(shí)，根據(jù)不同的分組采用不同的驗(yàn)證機(jī)制@Valid：沒有分組功能
舉例：
定義分組接口：
public interface IGroupA {
}
public interface IGroupB {
}定義需要檢驗(yàn)的參數(shù)bean：
public class StudentBean implements Serializable{
@NotBlank(message = "用戶名不能為空")
private String name;
//只在分組為IGroupB的情況下進(jìn)行驗(yàn)證
@Min(value = 18, message = "年齡不能小于18歲", groups = {IGroupB.class})
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機(jī)號(hào)格式錯(cuò)誤")
private String phoneNum;
@Email(message = "郵箱格式錯(cuò)誤")
private String email;
@MyConstraint
private String className;測(cè)試代碼：
檢驗(yàn)分組為IGroupA的情況
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}這里對(duì)分組IGroupB的就沒檢驗(yàn)了
如果把測(cè)試代碼改成下面這樣，就會(huì)檢驗(yàn)B了
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}說明：
1、不分 配groups，默認(rèn)每次都要進(jìn)行驗(yàn)證
2、對(duì)一個(gè)參數(shù)需要多種驗(yàn)證方式時(shí)，也可通過分配不同的組達(dá)到目的。
組序列
默認(rèn)情況下 不同級(jí)別的約束驗(yàn)證是無序的，但是在一些情況下，順序驗(yàn)證卻是很重要。
一個(gè)組可以定義為其他組的序列，使用它進(jìn)行驗(yàn)證的時(shí)候必須符合該序列規(guī)定的順序。在使用組序列驗(yàn)證的時(shí)候，如果序列前邊的組驗(yàn)證失敗，則后面的組將不再給予驗(yàn)證。
舉例：
定義組序列：
@GroupSequence({Default.class, IGroupA.class, IGroupB.class})
public interface IGroup {
}需要校驗(yàn)的Bean，分別定義IGroupA對(duì)age進(jìn)行校驗(yàn)，IGroupB對(duì)className進(jìn)行校驗(yàn)：
public class StudentBean implements Serializable{
@NotBlank(message = "用戶名不能為空")
private String name;
@Min(value = 18, message = "年齡不能小于18歲", groups = IGroupA.class)
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機(jī)號(hào)格式錯(cuò)誤")
private String phoneNum;
@Email(message = "郵箱格式錯(cuò)誤")
private String email;
@MyConstraint(groups = IGroupB.class)
private String className;測(cè)試代碼：
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroup.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}測(cè)試發(fā)現(xiàn)，如果age出錯(cuò)，那么對(duì)組序列在IGroupA后的IGroupB不進(jìn)行校驗(yàn)，即例子中的className不進(jìn)行校驗(yàn)，結(jié)果如下：
嵌套校驗(yàn)
一個(gè)待驗(yàn)證的pojo類，其中還包含了待驗(yàn)證的對(duì)象，需要在待驗(yàn)證對(duì)象上注解@Valid，才能驗(yàn)證待驗(yàn)證對(duì)象中的成員屬性，這里不能使用@Validated。
舉例：
需要約束校驗(yàn)的bean：
public class TeacherBean {
@NotEmpty(message = "老師姓名不能為空")
private String teacherName;
@Min(value = 1, message = "學(xué)科類型從1開始計(jì)算")
private int type;public class StudentBean implements Serializable{
@NotBlank(message = "用戶名不能為空")
private String name;
@Min(value = 18, message = "年齡不能小于18歲")
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機(jī)號(hào)格式錯(cuò)誤")
private String phoneNum;
@Email(message = "郵箱格式錯(cuò)誤")
private String email;
@MyConstraint
private String className;
@NotNull(message = "任課老師不能為空")
@Size(min = 1, message = "至少有一個(gè)老師")
private List<TeacherBean> teacherBeans;注意：
這里對(duì)teacherBeans只校驗(yàn)了NotNull, 和 Size，并沒有對(duì)teacher信息里面的字段進(jìn)行校驗(yàn)，具體測(cè)試如下：
這里teacher中的type明顯是不符合約束要求的，但是能檢測(cè)通過，是因?yàn)樵趕tudent中并沒有做 嵌套校驗(yàn)
可以在teacherBeans中加上 @Valid，具體如下：
@Valid
@NotNull(message = "任課老師不能為空")
@Size(min = 1, message = "至少有一個(gè)老師")
private List<TeacherBean> teacherBeans;這里再來測(cè)試，會(huì)發(fā)現(xiàn)如下結(jié)果：
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot如何實(shí)現(xiàn)Tomcat自動(dòng)配置
這篇文章主要介紹了SpringBoot如何實(shí)現(xiàn)Tomcat自動(dòng)配置，幫助大家更好的理解和學(xué)習(xí)使用SpringBoot框架，感興趣的朋友可以了解下2021-03-03
servlet之web路徑問題_動(dòng)力節(jié)點(diǎn)Java學(xué)院整理
這篇文章主要為大家詳細(xì)介紹了servlet之web路徑問題的相關(guān)資料，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-07-07
這篇文章主要為大家詳細(xì)介紹了精致小巧的java相冊(cè)制作方法,具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2016-10-10
這篇文章主要介紹了Java Springboot如何基于圖片生成下載鏈接,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-03-03
在本篇內(nèi)容中小編給大家分享的是關(guān)于java虛擬機(jī)中多線程的知識(shí)點(diǎn)總結(jié)內(nèi)容，需要的朋友們參考學(xué)習(xí)下。2019-06-06
這篇文章主要介紹了Java中常用的三種流程控制語句的使用，文中講解非常細(xì)致，代碼幫助大家更好的理解和學(xué)習(xí)，感興趣的朋友可以了解下2022-04-04
Java實(shí)現(xiàn)threadLocal線程池獲取
本文主要介紹了Java實(shí)現(xiàn)threadLocal線程池獲取，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07
手動(dòng)部署java項(xiàng)目到k8s中的實(shí)現(xiàn)
本文主要介紹了手動(dòng)部署java項(xiàng)目到k8s中的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-08-08
java實(shí)現(xiàn)點(diǎn)擊按鈕事件彈出子窗口
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)點(diǎn)擊按鈕事件彈出子窗口，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2019-07-07
這篇文章主要介紹了Java的Channel通道之FileChannel類詳解,FileChannel類是Java NIO中的一個(gè)重要類,用于在文件中進(jìn)行讀寫操作,它提供了一種高效的方式來處理大文件和隨機(jī)訪問文件的需求,需要的朋友可以參考下2023-10-10