@Valid註解的作用及@Valid註解與@Validated的區別

2022-08-30 14:01:06

1.@Valid註解

用於驗證註解是否符合要求，直接加在變數user之前，在變數中新增驗證資訊的要求，當不符合要求時就會在方法中返回message 的錯誤提示資訊。

@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 類中新增驗證資訊的要求：

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 欄位，表示驗證密碼不能為空，如果為空的話，上面 Controller 中的 create 方法會將message 中的"密碼不能為空"返回。

當然也可以新增其他驗證資訊的要求：

限制	說明
@Null	限制只能為null
@NotNull	限制必須不為null
@AssertFalse	限制必須為false
@AssertTrue	限制必須為true
@DecimalMax(value)	限制必須為一個不大於指定值的數位
@DecimalMin(value)	限制必須為一個不小於指定值的數位
@Digits(integer,fraction)	限制必須為一個小數，且整數部分的位數不能超過integer，小數部分的位數不能超過fraction
@Future	限制必須是一個將來的日期
@Max(value)	限制必須為一個不大於指定值的數位
@Min(value)	限制必須為一個不小於指定值的數位
@Past	限制必須是一個過去的日期
@Pattern(value)	限制必須符合指定的正規表示式
@Size(max,min)	限制字元長度必須在min到max之間
@Past	驗證註解的元素值（日期型別）比當前時間早
@NotEmpty	驗證註解的元素值不為null且不為空（字串長度不為0、集合大小不為0）
@NotBlank	驗證註解的元素值不為空（不為null、去除首位空格後長度為0），不同於@NotEmpty，@NotBlank只應用於字串且在比較時會去除字串的空格
@Email	驗證註解的元素值是Email，也可以通過正規表示式和flag指定自定義的email格式

除此之外還可以自定義驗證資訊的要求，例如上面的 @ICheckAppClientName：

註解的具體內容：

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

這是校驗器：

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的區別

@Valid是使用Hibernate validation的時候使用
@Validated是隻用Spring Validator校驗機制使用

說明：java的JSR303宣告了@Valid這類介面，而Hibernate-validator對其進行了實現

@Validation對@Valid進行了二次封裝，在使用上並沒有區別，但在分組、註解位置、巢狀驗證等功能上有所不同，這裡主要就這幾種情況進行說明。

註解位置

@Validated：用在型別、方法和方法引數上。但不能用於成員屬性（field）
@Valid：可以用在方法、建構函式、方法引數和成員屬性（field）上

如：

如果@Validated註解在成員屬性上，則會報 '@Validdated' not applicable to field 錯誤：

分組校驗

@Validated：提供分組功能，可以在引數驗證時，根據不同的分組採用不同的驗證機制
@Valid：沒有分組功能

舉例：

定義分組介面：

public interface IGroupA {
}
 
public interface IGroupB {
}

定義需要檢驗的引數bean：

public class StudentBean implements Serializable{
    @NotBlank(message = "使用者名稱不能為空")
    private String name;
    //只在分組為IGroupB的情況下進行驗證
    @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 = "手機號格式錯誤")
    private String phoneNum;
    @Email(message = "郵箱格式錯誤")
    private String email;
    @MyConstraint
    private String className;

測試程式碼：

檢驗分組為IGroupA的情況

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

這裡對分組IGroupB的就沒檢驗了

如果把測試程式碼改成下面這樣，就會檢驗B了

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

說明：

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

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

組序列

預設情況下不同級別的約束驗證是無序的，但是在一些情況下，順序驗證卻是很重要。

一個組可以定義為其他組的序列，使用它進行驗證的時候必須符合該序列規定的順序。在使用組序列驗證的時候，如果序列前邊的組驗證失敗，則後面的組將不再給予驗證。

舉例：

定義組序列：

@GroupSequence({Default.class, IGroupA.class, IGroupB.class})
public interface IGroup {
}

需要校驗的Bean，分別定義IGroupA對age進行校驗，IGroupB對className進行校驗：

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 = "手機號格式錯誤")
    private String phoneNum;
    @Email(message = "郵箱格式錯誤")
    private String email;
    @MyConstraint(groups = IGroupB.class)
    private String className;

測試程式碼：

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroup.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

測試發現，如果age出錯，那麼對組序列在IGroupA後的IGroupB不進行校驗，即例子中的className不進行校驗，結果如下：

巢狀校驗

一個待驗證的pojo類，其中還包含了待驗證的物件，需要在待驗證物件上註解@Valid，才能驗證待驗證物件中的成員屬性，這裡不能使用@Validated。

舉例：

需要約束校驗的bean：

public class TeacherBean {
    @NotEmpty(message = "老師姓名不能為空")
    private String teacherName;
    @Min(value = 1, message = "學科型別從1開始計算")
    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 = "手機號格式錯誤")
    private String phoneNum;
    @Email(message = "郵箱格式錯誤")
    private String email;
    @MyConstraint
    private String className;
 
    @NotNull(message = "任課老師不能為空")
    @Size(min = 1, message = "至少有一個老師")
    private List<TeacherBean> teacherBeans;

注意：

這裡對teacherBeans只校驗了NotNull, 和 Size，並沒有對teacher資訊裡面的欄位進行校驗，具體測試如下：

這裡teacher中的type明顯是不符合約束要求的，但是能檢測通過，是因為在student中並沒有做巢狀校驗

可以在teacherBeans中加上 @Valid，具體如下：

    @Valid
    @NotNull(message = "任課老師不能為空")
    @Size(min = 1, message = "至少有一個老師")
    private List<TeacherBean> teacherBeans;

這裡再來測試，會發現如下結果：

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。

@Valid註解的作用及@Valid註解與@Validated的區別

目錄

1.@Valid註解

2.@Valid與@Validated的區別

註解位置

分組校驗

組序列

巢狀校驗

熱門文章