SpringBoot @Validated注解實現(xiàn)參數(shù)分組校驗的方法實例

更新時間：2020年09月14日 15:33:46 作者：請叫我張大膽

這篇文章主要給大家介紹了關于SpringBoot @Validated注解實現(xiàn)參數(shù)分組校驗的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言

在前后端分離開發(fā)的時候我們需要用到參數(shù)校驗，前端需要進行參數(shù)校驗，后端接口同樣的也需要，以防傳入不合法的數(shù)據(jù)。

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) 限制必須為一個不大于指定值的數(shù)字
@DecimalMin(value) 限制必須為一個不小于指定值的數(shù)字
@Digits(integer,fraction) 限制必須為一個小數(shù)，且整數(shù)部分的位數(shù)不能超過integer，小數(shù)部分的位
數(shù)不能超過fraction
@Future 限制必須是一個將來的日期
@Past 驗證注解的元素值（日期類型）比當前時間早
@Max(value) 限制必須為一個不大于指定值的數(shù)字
@Min(value) 限制必須為一個不小于指定值的數(shù)字
@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、在來解釋下上面標注的分組接口。

LoginModel

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

必須繼承默認的Defaut接口不然后拋出異常。

SaveModel

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

5、在controller的接口上加上@Validated注解，參數(shù)就加上你需要根據(jù)那種規(guī)則來校驗。

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

運行后只能在控制臺顯示錯誤的結(jié)果，新的問題又來了怎么把錯誤的結(jié)果通過自己的result類返回給前端。這就需要對錯誤全局捕捉了。

6、寫一個對Response換回結(jié)果的處理。

@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的結(jié)果類。
    return Result.validateFailed(errorInfo.toString());
  }

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

``

7. 先測試LoginModel的校驗規(guī)則

控制臺打印的數(shù)據(jù)

前端收到的數(shù)據(jù)

切換成SaveModel控制臺打印的數(shù)據(jù)

切換成SaveModel前端收到的數(shù)據(jù)

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

8 、總結(jié)，就是在添加驗證規(guī)則的時候指定對應的分組，在使用時傳入需要的分組。可能理解有誤，發(fā)現(xiàn)請指導。

總結(jié)

到此這篇關于SpringBoot @Validated注解實現(xiàn)參數(shù)分組校驗的文章就介紹到這了,更多相關SpringBoot @Validated注解實現(xiàn)參數(shù)分組校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: