【springboot】【@Validated】--使用Spring Validation優雅地進行參數校驗

1. 引言

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

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

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

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

 

2. 搭建環境

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

<!--校驗組件-->
<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 依賴就可以了

 

3. 小試牛刀

　　參數校驗非常簡單，首先在待校驗字段上增加校驗規則注解

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

　　然后在controller方法中添加@Validated和用於接收錯誤信息的BindingResult就可以了，於是有了第一版：

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信息返回：

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	校驗容器的元素個數

 

4. 規范返回值

　　待校驗參數多了之后我們希望一次返回所有校驗失敗信息，方便接口調用方進行調整，這就需要統一返回格式，常見的就是封裝一個結果類。

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 格式錯誤"
    ]
}

 

5. 全局異常處理

　　每個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);
    }
    
}

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

　　（1）使用form data方式調用接口，校驗異常拋出 BindException

　　（2）使用 json 請求體調用接口，校驗異常拋出 MethodArgumentNotValidException

　　（3）單個參數校驗異常拋出ConstraintViolationException

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

　　全局異常處理類可以添加各種需要處理的異常，比如添加一個對Exception.class的異常處理，當所有ExceptionHandler都無法處理時，由其記錄異常信息，並返回友好提示。

 

 

個人實踐

 

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

 

6. 分組校驗

　　如果同一個參數，需要在不同場景下應用不同的校驗規則，就需要用到分組校驗了。比如：新注冊用戶還沒起名字，我們允許name字段為空，但是不允許將名字更新為空字符。

　　分組校驗有三個步驟：

　　（1）定義一個分組類（或接口）

public interface Update extends Default{
}

　　（2）在校驗注解上添加groups屬性指定分組

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

 　（3）Controller方法的@Validated注解添加分組類

@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 不能為空"
    ]
}

 

7. 遞歸校驗

　　如果 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;
    // 省略其他代碼...
}   

　　調用請求驗證如下：

 

8. 自定義校驗

　　Spring 的 validation 為我們提供了這么多特性，幾乎可以滿足日常開發中絕大多數參數校驗場景了。但是，一個好的框架一定是方便擴展的。有了擴展能力，就能應對更多復雜的業務場景，畢竟在開發過程中，唯一不變的就是變化本身。

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

　　（1）自定義校驗注解

　　（2）編寫校驗者類

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

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

　　自定義校驗注解使用起來和內置注解無異，在需要的字段上添加相應注解即可，同學們可以自行驗證。