原文地址：https://blog.csdn.net/weixin_43671737/article/details/108578122

SpringBoot @Validated註解實現引數分組校驗

在前後端分離開發的時候我們需要用到引數校驗，前端需要進行引數校驗，後端介面同樣的也需要，以防傳入不合法的資料。

1. pom依賴

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
 

2. 註解的作用

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

3. 新增到實體類欄位上

標註的地方就是用來分組校驗的，下下面會解釋。

@Data
public class LoginVo {

    @ApiModelProperty(value = "使用者名稱稱")
    @NotEmpty(message = "使用者名稱不能為空！",groups = LoginModel.class)
    @NotEmpty(message = "新增時使用者名稱不能為空！",groups = SaveModel.class)
    private String userName;

    @ApiModelProperty(value = "密碼")
    @Size(min = 2,message = "密碼最少為2位",groups = LoginModel.class)
    @Size(min = 6,message = "密碼最少為6位",groups = SaveModel.class)
    private String password;
}
 

通過groups的屬性來分組，假設我在使用登入分組校驗的時候，設定使用者名稱不能為空和密碼最少為2位的驗證。而在新增分組設定新增時使用者名稱不能為空和密碼最少為6位的驗證。

4. 分組校驗的作用

1. 在來解釋下上面標註的分組介面。

   LoginModel

   import javax.validation.groups.Default;
   	public interface LoginModel extends Default {
   }
   

   必須繼承預設的Defaut介面不然後丟擲異常。

   SaveModel

   import javax.validation.groups.Default;
   	public interface SaveModel extends Default{
   }
   

2. 在controller的介面上加上@Validated註解，引數就加上你需要根據那種規則來校驗。

   @ApiOperation(value = "登入以後返回token")
   @PostMapping(value = "/login")
   public Result login(@RequestBody @Validated(LoginModel.class) LoginVo loginVo) {
       String token = userService.login(loginVo.getUserName(), loginVo.getPassword());
       return Result.success(token);
   }
   

   執行後只能在控制檯顯示錯誤的結果，新的問題又來了怎麼把錯誤的結果通過自己的result類返回給前端。這就需要對錯誤全域性捕捉了。

5. 異常處理

@RestControllerAdvice
@Slf4j
public class ParameterCalibration {

    @ExceptionHandler({MethodArgumentNotValidException.class, BindException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Result handleMethodArgumentNotValidException(Exception exception) {
        StringBuilder errorInfo = new StringBuilder();
        BindingResult bindingResult=null;
        if(exception instanceof MethodArgumentNotValidException){
            bindingResult= ((MethodArgumentNotValidException)exception).getBindingResult();
        }
        if(exception instanceof BindException){
            bindingResult= ((BindException)exception).getBindingResult();
        }
        for(int i = 0; i < bindingResult.getFieldErrors().size(); i++){
            if(i > 0){
                errorInfo.append(",");
            }
            FieldError fieldError = bindingResult.getFieldErrors().get(i);
            errorInfo.append(fieldError.getField()).append(" :").append(fieldError.getDefaultMessage());
        }
        log.error(errorInfo.toString());
        //這裡返回自己的Result的結果類。
        return  Result.validateFailed(errorInfo.toString());
    }

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public Result  handleDefaultException(Exception exception) {
        log.error(exception.toString());
        //這裡返回自己的Result的結果類。
        return  Result.validateFailed("伺服器錯誤",exception);
    }
}

7. 測試

先LoginModel的校驗規則。控制檯列印的資料

前端收到的資料

切換成SaveModel控制檯列印的資料
切換成SaveModel前端收到的資料

可以看到兩次的驗證規則時不同的，完成了簡易的分組操作。

總結，就是在新增驗證規則的時候指定對應的分組，在使用時傳入需要的分組。可能理解有誤，發現請指導。