使用Spring Validation優雅地校驗參數

時間 2020-08-06

標籤使用 spring validation 優雅校驗參數欄目 Spring 简体版

原文原文鏈接

寫得好的沒我寫得全，寫得全的沒我寫得好

引言

不知道你們平時的業務開發過程當中 controller 層的參數校驗都是怎麼寫的？是否也存在下面這樣的直接判斷？java

public String add(UserVO userVO) {
    if(userVO.getAge() == null){
        return "年齡不能爲空";
    }
    if(userVO.getAge() > 120){
        return "年齡不能超過120";
    }
    if(userVO.getName().isEmpty()){
        return "用戶名不能爲空";
    }
    // 省略一堆參數校驗...
    return "OK";
}

業務代碼還沒開始寫呢，光參數校驗就寫了一堆判斷。這樣寫雖然沒什麼錯，可是給人的感受就是：不優雅，不專業。git

其實Spring框架已經給咱們封裝了一套校驗組件：validation。其特色是簡單易用，自由度高。接下來課表明使用springboot-2.3.1.RELEASE搭建一個簡單的 Web 工程，給你們一步一步講解在開發過程當中如何優雅地作參數校驗。github

1. 環境搭建

從springboot-2.3開始，校驗包被獨立成了一個starter組件，因此須要引入以下依賴：web

<!--校驗組件-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!--web組件-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

而springboot-2.3以前的版本只須要引入 web 依賴就能夠了。spring

2.小試牛刀

參數校驗很是簡單，首先在待校驗字段上增長校驗規則註解json

public class UserVO {
    @NotNull(message = "age 不能爲空")
    private Integer age;
}

而後在controller方法中添加@Validated和用於接收錯誤信息的BindingResult就能夠了，因而有了初版：springboot

public String add1(@Validated UserVO userVO, BindingResult result) {
    List<FieldError> fieldErrors = result.getFieldErrors();
    if(!fieldErrors.isEmpty()){
        return fieldErrors.get(0).getDefaultMessage();
    }
    return "OK";
}

經過工具(postman)去請求接口，若是參數不符合規則，會將相應的 message信息返回：app

age 不能爲空

內置的校驗註解有不少，羅列以下：框架

註解	校驗功能
@AssertFalse	必須是false
@AssertTrue	必須是true
@DecimalMax	小於等於給定的值
@DecimalMin	大於等於給定的值
@Digits	可設定最大整數位數和最大小數位數
@Email	校驗是否符合Email格式
@Future	必須是未來的時間
@FutureOrPresent	當前或未來時間
@Max	最大值
@Min	最小值
@Negative	負數（不包括0）
@NegativeOrZero	負數或0
@NotBlank	不爲null而且包含至少一個非空白字符
@NotEmpty	不爲null而且不爲空
@NotNull	不爲null
@Null	爲null
@Past	必須是過去的時間
@PastOrPresent	必須是過去的時間，包含如今
@PositiveOrZero	正數或0
@Size	校驗容器的元素個數

3. 規範返回值

待校驗參數多了以後咱們但願一次返回全部校驗失敗信息，方便接口調用方進行調整，這就須要統一返回格式，常見的就是封裝一個結果類。less

public class ResultInfo<T>{
    private Integer status;
    private String message;
    private T response;
    // 省略其餘代碼...
}

改造一下controller 方法，第二版：

public ResultInfo add2(@Validated UserVO userVO, BindingResult result) {
    List<FieldError> fieldErrors = result.getFieldErrors();
    List<String> collect = fieldErrors.stream()
            .map(o -> o.getDefaultMessage())
            .collect(Collectors.toList());
    return new ResultInfo<>().success(400,"請求參數錯誤",collect);
}

請求該方法時，全部的錯誤參數就都返回了：

{
    "status": 400,
    "message": "請求參數錯誤",
    "response": [
        "年齡必須在[1,120]之間",
        "bg 字段的整數位最多爲3位，小數位最多爲1位",
        "name 不能爲空",
        "email 格式錯誤"
    ]
}

4. 全局異常處理

每一個Controller方法中都若是都寫一遍對BindingResult信息的處理，使用起來仍是很繁瑣。能夠經過全局異常處理的方式統一處理校驗異常。

當咱們寫了@validated註解，不寫BindingResult的時候，Spring 就會拋出異常。由此，能夠寫一個全局異常處理類來統一處理這種校驗異常，從而免去重複組織異常信息的代碼。

全局異常處理類只須要在類上標註@RestControllerAdvice，並在處理相應異常的方法上使用@ExceptionHandler註解，寫明處理哪一個異常便可。

@RestControllerAdvice
public class GlobalControllerAdvice {
    private static final String BAD_REQUEST_MSG = "客戶端請求參數錯誤";
    // <1> 處理 form data方式調用接口校驗失敗拋出的異常 
    @ExceptionHandler(BindException.class)
    public ResultInfo bindExceptionHandler(BindException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        List<String> collect = fieldErrors.stream()
                .map(o -> o.getDefaultMessage())
                .collect(Collectors.toList());
        return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);
    }
    // <2> 處理 json 請求體調用接口校驗失敗拋出的異常 
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResultInfo methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        List<String> collect = fieldErrors.stream()
                .map(o -> o.getDefaultMessage())
                .collect(Collectors.toList());
        return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);
    }
    // <3> 處理單個參數校驗失敗拋出的異常
    @ExceptionHandler(ConstraintViolationException.class)
    public ResultInfo constraintViolationExceptionHandler(ConstraintViolationException e) {
        Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
        List<String> collect = constraintViolations.stream()
                .map(o -> o.getMessage())
                .collect(Collectors.toList());
        return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect);
    }
    

}

事實上，在全局異常處理類中，咱們能夠寫多個異常處理方法，課表明總結了三種參數校驗時可能引起的異常：

使用form data方式調用接口，校驗異常拋出 BindException
使用 json 請求體調用接口，校驗異常拋出 MethodArgumentNotValidException
單個參數校驗異常拋出ConstraintViolationException

注：單個參數校驗須要在參數上增長校驗註解，並在類上標註 @Validated。

全局異常處理類能夠添加各類須要處理的異常，好比添加一個對Exception.class的異常處理，當全部ExceptionHandler都沒法處理時，由其記錄異常信息，並返回友好提示。

5.分組校驗

若是同一個參數，須要在不一樣場景下應用不一樣的校驗規則，就須要用到分組校驗了。好比：新註冊用戶還沒起名字，咱們容許name字段爲空，可是不容許將名字更新爲空字符。

分組校驗有三個步驟：

定義一個分組類（或接口）
在校驗註解上添加groups屬性指定分組
Controller方法的@Validated註解添加分組類

public interface Update extends Default{
}

public class UserVO {
    @NotBlank(message = "name 不能爲空",groups = Update.class)
    private String name;
    // 省略其餘代碼...
}

@PostMapping("update")
public ResultInfo update(@Validated({Update.class}) UserVO userVO) {
    return new ResultInfo().success(userVO);
}

細心的同窗可能已經注意到，自定義的Update分組接口繼承了Default接口。校驗註解(如： @NotBlank)和@validated默認都屬於Default.class分組，這一點在javax.validation.groups.Default註釋中有說明

/**
 * Default Jakarta Bean Validation group.
 * <p>
 * Unless a list of groups is explicitly defined:
 * <ul>
 *     <li>constraints belong to the {@code Default} group</li>
 *     <li>validation applies to the {@code Default} group</li>
 * </ul>
 * Most structural constraints should belong to the default group.
 *
 * @author Emmanuel Bernard
 */
public interface Default {
}

在編寫Update分組接口時，若是繼承了Default，下面兩個寫法就是等效的：

@Validated({Update.class})

@Validated({Update.class,Default.class})

請求一下/update接口能夠看到，不只校驗了name字段，也校驗了其餘默認屬於Default.class分組的字段

{
    "status": 400,
    "message": "客戶端請求參數錯誤",
    "response": [
        "name 不能爲空",
        "age 不能爲空",
        "email 不能爲空"
    ]
}

若是Update不繼承Default，@Validated({Update.class})就只會校驗屬於Update.class分組的參數字段，修改後再次請求該接口獲得以下結果，能夠看到，其餘字段沒有參與校驗：

{
    "status": 400,
    "message": "客戶端請求參數錯誤",
    "response": [
        "name 不能爲空"
    ]
}

6.遞歸校驗

若是 UserVO 類中增長一個 OrderVO 類的屬性，而 OrderVO 中的屬性也須要校驗，就用到遞歸校驗了，只要在相應屬性上增長@Valid註解便可實現（對於集合一樣適用）

OrderVO類以下

public class OrderVO {
    @NotNull
    private Long id;
    @NotBlank(message = "itemName 不能爲空")
    private String itemName;
    // 省略其餘代碼...
}

在 UserVO 類中增長一個 OrderVO 類型的屬性

public class UserVO {
    @NotBlank(message = "name 不能爲空",groups = Update.class)
    private String name;
    //須要遞歸校驗的OrderVO
    @Valid
    private OrderVO orderVO;
    // 省略其餘代碼...
}

調用請求驗證以下：

7. 自定義校驗

Spring 的 validation 爲咱們提供了這麼多特性，幾乎能夠知足平常開發中絕大多數參數校驗場景了。可是，一個好的框架必定是方便擴展的。有了擴展能力，就能應對更多複雜的業務場景，畢竟在開發過程當中，惟一不變的就是變化自己。

Spring Validation容許用戶自定義校驗，實現很簡單，分兩步：

自定義校驗註解
編寫校驗者類

代碼也很簡單，結合註釋你一看就能懂

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {HaveNoBlankValidator.class})// 標明由哪一個類執行校驗邏輯
public @interface HaveNoBlank {
    
    // 校驗出錯時默認返回的消息
    String message() default "字符串中不能含有空格";

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

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

    /**
     * 同一個元素上指定多個該註解時使用
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    public @interface List {
        NotBlank[] value();
    }
}

public class HaveNoBlankValidator implements ConstraintValidator<HaveNoBlank, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // null 不作檢驗
        if (value == null) {
            return true;
        }
        if (value.contains(" ")) {
            // 校驗失敗
            return false;
        }
        // 校驗成功
        return true;
    }
}

自定義校驗註解使用起來和內置註解無異，在須要的字段上添加相應註解便可，同窗們能夠自行驗證