SpringBoot 如何進行參數校驗，老鳥們都這麼玩的！

大家好，我是飄渺。

前幾天寫了一篇

SpringBoot如何統一後端傳回格式？老鳥們都是這樣玩的！閱讀效果還不錯，而且被很多公衆号都轉載過，今天我們繼續第二篇，來聊聊在SprinBoot中如何內建參數校驗Validator，以及參數校驗的高階技巧（自定義校驗，分組校驗）。

此文是依賴于前文的代碼基礎，已經在項目中加入了全局異常校驗器。（代碼倉庫在文末）

首先我們來看看什麼是Validator參數校驗器，為什麼需要參數校驗？

為什麼需要參數校驗

在日常的接口開發中，為了防止非法參數對業務造成影響，經常需要對接口的參數做校驗，例如登入的時候需要校驗使用者名密碼是否為空，建立使用者的時候需要校驗郵件、手機号碼格式是否準确。靠代碼對接口參數一個個校驗的話就太繁瑣了，代碼可讀性極差。

Validator架構就是為了解決開發人員在開發的時候少寫代碼，提升開發效率；Validator專門用來進行接口參數校驗，例如常見的必填校驗，email格式校驗，使用者名必須位于6到12之間等等...

Validator校驗架構遵循了JSR-303驗證規範（參數校驗規範）, JSR是 Java Specification Requests 的縮寫。

接下來我們看看在SpringbBoot中如何內建參數校驗架構。

SpringBoot中內建參數校驗

第一步，引入依賴

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

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

注：從 springboot-2.3 開始，校驗包被獨立成了一個 starter 元件，是以需要引入validation和web，而 springboot-2.3 之前的版本隻需要引入 web 依賴就可以了。

第二步，定義要參數校驗的實體類

@Data
public class ValidVO {
    private String id;

    @Length(min = 6,max = 12,message = "appId長度必須位于6到12之間")
    private String appId;

    @NotBlank(message = "名字為必填項")
    private String name;

    @Email(message = "請填寫正确的郵箱位址")
    private String email;

    private String sex;

    @NotEmpty(message = "級别不能為空")
    private String level;
}

在實際開發中對于需要校驗的字段都需要設定對應的業務提示，即message屬性。

常見的限制注解如下：

注解	功能
@AssertFalse	可以為null,如果不為null的話必須為false
@AssertTrue	可以為null,如果不為null的話必須為true
@DecimalMax	設定不能超過最大值
@DecimalMin	設定不能超過最小值
@Digits	設定必須是數字且數字整數的位數和小數的位數必須在指定範圍内
@Future	日期必須在目前日期的未來
@Past	日期必須在目前日期的過去
@Max	最大不得超過此最大值
@Min	最大不得小于此最小值
@NotNull	不能為null，可以是空
@Null	必須為null
@Pattern	必須滿足指定的正規表達式
@Size	集合、數組、map等的size()值必須在指定範圍内
@Email	必須是email格式
@Length	長度必須在指定範圍内
@NotBlank	字元串不能為null,字元串trim()後也不能等于“”
@NotEmpty	不能為null，集合、數組、map等size()不能為0；字元串trim()後可以等于“”
@Range	值必須在指定範圍内
@URL	必須是一個URL

注：此表格隻是簡單的對注解功能的說明，并沒有對每一個注解的屬性進行說明；可詳見源碼。

第三步，定義校驗類進行測試

@RestController
@Slf4j
@Validated
public class ValidController {

    @ApiOperation("RequestBody校驗")
    @PostMapping("/valid/test1")   
    public String test1(@Validated @RequestBody ValidVO validVO){
        log.info("validEntity is {}", validVO);
        return "test1 valid success";
    }

    @ApiOperation("Form校驗")
    @PostMapping(value = "/valid/test2")
    public String test2(@Validated ValidVO validVO){
        log.info("validEntity is {}", validVO);
        return "test2 valid success";
    }
  
      @ApiOperation("單參數校驗")
    @PostMapping(value = "/valid/test3")
    public String test3(@Email String email){
        log.info("email is {}", email);
        return "email valid success";
    }
}

這裡我們先定義三個方法test1，test2，test3，test1使用了

@RequestBody

注解，用于接受前端發送的json資料，test2模拟表單送出，test3模拟單參數送出。注意，當使用單參數校驗時需要在Controller上加上@Validated注解，否則不生效。

第四步，體驗效果

調用test1方法，提示的是 org.springframework.web.bind.MethodArgumentNotValidException 異常

POST http://localhost:8080/valid/test1
Content-Type: application/json

{
  "id": 1,
  "level": "12",
  "email": "47693899",
  "appId": "ab1c"
}

{
  "status": 500,
  "message": "Validation failed for argument [0] in public java.lang.String com.jianzh5.blog.valid.ValidController.test1(com.jianzh5.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field 'email': rejected value [47693899]; codes [Email.validVO.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*]; default message [不是一個合法的電子郵件位址]]...",
  "data": null,
  "timestamp": 1628239624332
}

調用test2方法，提示的是 org.springframework.validation.BindException

POST http://localhost:8080/valid/test2
Content-Type: application/x-www-form-urlencoded

id=1&level=12&email=476938977&appId=ab1c

{
  "status": 500,
  "message": "org.springframework.validation.BeanPropertyBindingResult: 3 errors\nField error in object 'validVO' on field 'name': rejected value [null]; codes [NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字為必填項]...",
  "data": null,
  "timestamp": 1628239301951
}

調用test3方法，提示的是 javax.validation.ConstraintViolationException

POST http://localhost:8080/valid/test3
Content-Type: application/x-www-form-urlencoded

email=476938977

{
  "status": 500,
  "message": "test3.email: 不是一個合法的電子郵件位址",
  "data": null,
  "timestamp": 1628239281022
}

通過加入

Validator

校驗架構可以幫助我們自動實作參數的校驗。

參數異常加入全局異常處理器

雖然我們之前定義了全局異常攔截器，也看到了攔截器确實生效了，但是

Validator

校驗架構傳回的錯誤提示太臃腫了，不便于閱讀，為了友善前端提示，我們需要将其簡化一下。

直接修改之前定義的

RestExceptionHandler

，單獨攔截參數校驗的三個異常：

javax.validation.ConstraintViolationException

，

org.springframework.validation.BindException

org.springframework.web.bind.MethodArgumentNotValidException

，代碼如下：

@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ResponseEntity<ResultData<String>> handleValidatedException(Exception e) {
  ResultData<String> resp = null;

  if (e instanceof MethodArgumentNotValidException) {
    // BeanValidation exception
    MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
    resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
                           ex.getBindingResult().getAllErrors().stream()
                           .map(ObjectError::getDefaultMessage)
                           .collect(Collectors.joining("; "))
                          );
  } else if (e instanceof ConstraintViolationException) {
    // BeanValidation GET simple param
    ConstraintViolationException ex = (ConstraintViolationException) e;
    resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
                           ex.getConstraintViolations().stream()
                           .map(ConstraintViolation::getMessage)
                           .collect(Collectors.joining("; "))
                          );
  } else if (e instanceof BindException) {
    // BeanValidation GET object param
    BindException ex = (BindException) e;
    resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
                           ex.getAllErrors().stream()
                           .map(ObjectError::getDefaultMessage)
                           .collect(Collectors.joining("; "))
                          );
  }

  return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);
}

體驗效果

POST http://localhost:8080/valid/test1
Content-Type: application/json

{
  "id": 1,
  "level": "12",
  "email": "47693899",
  "appId": "ab1c"
}

{
  "status": 400,
  "message": "名字為必填項; 不是一個合法的電子郵件位址; appId長度必須位于6到12之間",
  "data": null,
  "timestamp": 1628435116680
}

是不是感覺清爽多了？

自定義參數校驗

雖然Spring Validation 提供的注解基本上夠用，但是面對複雜的定義，我們還是需要自己定義相關注解來實作自動校驗。

比如上面實體類中的sex性别屬性，隻允許前端傳遞傳 M，F 這2個枚舉值，如何實作呢？

第一步，建立自定義注解

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//标明由哪個類執行校驗邏輯
public @interface EnumString {
    String message() default "value not in enum values.";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    /**
     * @return date must in this value array
     */
    String[] value();

    /**
     * Defines several {@link EnumString} annotations on the same element.
     *
     * @see EnumString
     */
    @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
    @Retention(RUNTIME)
    @Documented
    @interface List {

        EnumString[] value();
    }
}

第二步，自定義校驗邏輯

public class EnumStringValidator implements ConstraintValidator<EnumString, String> {
    private List<String> enumStringList;

    @Override
    public void initialize(EnumString constraintAnnotation) {
        enumStringList = Arrays.asList(constraintAnnotation.value());
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if(value == null){
            return true;
        }
        return enumStringList.contains(value);
    }
}

第三步，在字段上增加注解

@ApiModelProperty(value = "性别")
@EnumString(value = {"F","M"}, message="性别隻允許為F或M")
private String sex;

POST http://localhost:8080/valid/test2
Content-Type: application/x-www-form-urlencoded

id=1&name=javadaily&level=12&[email protected]&appId=ab1cdddd&sex=N

{
  "status": 400,
  "message": "性别隻允許為F或M",
  "data": null,
  "timestamp": 1628435243723
}

分組校驗

一個VO對象在新增的時候某些字段為必填，在更新的時候又非必填。如上面的

ValidVO

中 id 和 appId 屬性在新增操作時都是非必填，而在編輯操作時都為必填，name在新增操作時為必填，面對這種場景你會怎麼處理呢？

在實際開發中我見到很多同學都是建立兩個VO對象，

ValidCreateVO

ValidEditVO

來處理這種場景，這樣确實也能實作效果，但是會造成類膨脹，而且極其容易被開發老鳥們嘲笑。

其實

Validator

校驗架構已經考慮到了這種場景并且提供了解決方案，就是分組校驗，隻不過很多同學不知道而已。要使用分組校驗，隻需要三個步驟：

第一步：定義分組接口

public interface ValidGroup extends Default {
  
    interface Crud extends ValidGroup{
        interface Create extends Crud{

        }

        interface Update extends Crud{

        }

        interface Query extends Crud{

        }

        interface Delete extends Crud{

        }
    }
}

這裡我們定義一個分組接口ValidGroup讓其繼承

javax.validation.groups.Default

，再在分組接口中定義出多個不同的操作類型，Create，Update，Query，Delete。至于為什麼需要繼承Default我們稍後再說。

第二步，在模型中給參數配置設定分組

@Data
@ApiModel(value = "參數校驗類")
public class ValidVO {
    @ApiModelProperty("ID")
    @Null(groups = ValidGroup.Crud.Create.class)
    @NotNull(groups = ValidGroup.Crud.Update.class, message = "應用ID不能為空")
    private String id;

    @Null(groups = ValidGroup.Crud.Create.class)
    @NotNull(groups = ValidGroup.Crud.Update.class, message = "應用ID不能為空")
    @ApiModelProperty(value = "應用ID",example = "cloud")
    private String appId;

    @ApiModelProperty(value = "名字")
    @NotBlank(groups = ValidGroup.Crud.Create.class,message = "名字為必填項")
    private String name;
  
      @ApiModelProperty(value = "郵箱")
    @Email(message = "請填寫正取的郵箱位址")
    privte String email;

       ...

}

給參數指定分組，對于未指定分組的則使用的是預設分組。

第三步，給需要參數校驗的方法指定分組

@RestController
@Api("參數校驗")
@Slf4j
@Validated
public class ValidController {

    @ApiOperation("新增")
    @PostMapping(value = "/valid/add")
    public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){
        log.info("validEntity is {}", validVO);
        return "test3 valid success";
    }


    @ApiOperation("更新")
    @PostMapping(value = "/valid/update")
    public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){
        log.info("validEntity is {}", validVO);
        return "test4 valid success";
    }
}

這裡我們通過

value

屬性給

add()

和

update()

方法分别指定Create和Update分組。

POST http://localhost:8080/valid/add
Content-Type: application/x-www-form-urlencoded

name=javadaily&level=12&[email protected]&sex=F

在Create時我們沒有傳遞id和appId參數，校驗通過。

當我們使用同樣的參數調用update方法時則提示參數校驗錯誤。

{
  "status": 400,
  "message": "ID不能為空; 應用ID不能為空",
  "data": null,
  "timestamp": 1628492514313
}

由于email屬于預設分組，而我們的分組接口

ValidGroup

已經繼承了

Default

分組，是以也是可以對email字段作參數校驗的。如：

POST http://localhost:8080/valid/add
Content-Type: application/x-www-form-urlencoded

name=javadaily&level=12&email=476938977&sex=F

{
  "status": 400,
  "message": "請填寫正取的郵箱位址",
  "data": null,
  "timestamp": 1628492637305
}

當然如果你的ValidGroup沒有繼承Default分組，那在代碼屬性上就需要加上

@Validated(value = {ValidGroup.Crud.Create.class, Default.class}

才能讓

email

字段的校驗生效。

小結

參數校驗在實際開發中使用頻率非常高，但是很多同學還隻是停留在簡單的使用上，像分組校驗，自定義參數校驗這2個高階技巧基本沒怎麼用過，經常出現譬如建立多個VO用于接受Create，Update場景的情況，很容易被老鳥被所鄙視嘲笑，希望大家好好掌握。

最後，我是飄渺Jam，一名寫代碼的架構師，做架構的程式員，期待您的轉發與關注，當然也可以添加我的個人微信jianzh5，咱們一起聊技術！

github位址：

https://github.com/jianzh5/cloud-blog/

SpringBoot 如何進行參數校驗，老鳥們都這麼玩的！

為什麼需要參數校驗

SpringBoot中內建參數校驗

第一步，引入依賴

第二步，定義要參數校驗的實體類

第三步，定義校驗類進行測試

第四步，體驗效果

參數異常加入全局異常處理器

體驗效果

自定義參數校驗

第一步，建立自定義注解

第二步，自定義校驗邏輯

第三步，在字段上增加注解

分組校驗

第一步：定義分組接口

第二步，在模型中給參數配置設定分組

第三步，給需要參數校驗的方法指定分組

小結

繼續閱讀

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

vue-cli簡介（中文翻譯）

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

面試題解析：你接口測試是怎麼做的？

Ajax發送和擷取json資料到Spring mvc 1.spring mvc後端2.web前段

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method

JSONObject包導入異常 java.lang.NoClassDefFoundErrorweb項目的導入包的問題