SpringBoot實現接口的各種參數校驗的示例

Posted on by

在我們進行接口開發時，在對參數的接收時，我們需要冗餘復雜的校驗規則 來進行接口參數的校驗，接下來推薦一個好用的校驗工具Spring Validation。

Java API規范 (JSR303) 定義瞭Bean校驗的標準validation-api，但沒有提供實現。hibernate validation是對這個規范的實現，並增加瞭校驗註解如@Email、@Length等。

Spring Validation是對hibernate validation的二次封裝，用於支持spring mvc參數自動校驗。接下來，我們以spring-boot項目為例，介紹Spring Validation的使用。

1.添加依賴

<!--新增validator-->
        <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
     <!--添加lombok-->
        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

2.接口參數校驗

對於web服務來說，為防止非法參數對業務造成影響，在Controller層一定要做參數校驗的！大部分情況下，請求參數分為如下兩種形式：

  • POST、PUT請求，使用requestBody傳遞參數；
  • GET請求，使用requestParam/PathVariable傳遞參數。

下面我們簡單介紹下requestBody和requestParam/PathVariable的參數校驗實戰！

2.1 requestBody參數校驗

POST、PUT請求一般會使用requestBody傳遞參數，這種情況下，後端使用DTO對象進行接收。隻要給 DTO 對象加上@Validated註解就能實現自動參數校驗。

比如，有一個保存User的接口，要求userName長度是2-10，account和password字段長度是6-20。如果校驗失敗，會拋出MethodArgumentNotValidException異常，Spring默認會將其轉為400（Bad Request）請求。

DTO 表示數據傳輸對象（Data Transfer Object），用於服務器和客戶端之間交互傳輸使用的。在 spring-web 項目中可以表示用於接收請求參數的Bean對象。

我們隻需要兩步就可以實現剛剛對user對象參數的需求

1.在實體類上聲明約束註解

import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.NotNull;

@Data
public class UserDTO {

    private Long userId;

    @NotNull
    @Length(min = 2, max = 10)
    private String userName;

    @NotNull
    @Length(min = 6, max = 20)
    private String account;

    @NotNull
    @Length(min = 6, max = 20)
    private String password;
}

2.在接口方法參數上聲明校驗註解

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {

    @PostMapping("/save")
    public Map<String, Object> saveUser(@RequestBody @Validated UserDTO userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        return result;
    }
}

接下來我們進行一下測試

在這裡插入圖片描述

我們可以看到密碼位數不對時會轉為400請求參數不對的錯誤

2.2 requestParam/PathVariable參數校驗

GET請求一般會使用requestParam/PathVariable傳參。
如果參數比較多 (比如超過 6 個)，還是推薦使用DTO對象接收。否則，推薦將一個個參數平鋪到方法入參中。在這種情況下，必須在Controller類上標註@Validated註解，並在入參上聲明約束註解 (如@Min等)。
如果校驗失敗，會拋出ConstraintViolationException異常。代碼示例如下：

package com.example.code.controller;

import com.example.code.po.UserDTO;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @GetMapping("{userId}")
    public Map<String, Object> detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
        Map<String, Object> result = new HashMap<>();
        UserDTO userDTO = new UserDTO();
        userDTO.setUserId(userId);
        userDTO.setAccount("11111111111111111");
        userDTO.setUserName("xixi");
        userDTO.setAccount("11111111111111111");
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }

    @GetMapping("getByAccount")
    public Map<String, Object> getByAccount(@Length(min = 6, max = 20) @NotNull String account) {
        Map<String, Object> result = new HashMap<>();
        UserDTO userDTO = new UserDTO();
        userDTO.setUserId(10000000000000003L);
        userDTO.setAccount(account);
        userDTO.setUserName("xixi");
        userDTO.setAccount(account);
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }
}

在這裡插入圖片描述

3.統一異常處理

在我們剛剛的測試中會發現如果校驗失敗，會拋出MethodArgumentNotValidException或者ConstraintViolationException異常。
但是在實際項目開發中，通常會用統一異常處理來返回一個更友好的提示。比如我們系統要求無論發送什麼異常，http的狀態碼必須返回200，由業務碼去區分系統的異常情況。

import org.springframework.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolationException;
import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class CommonExceptionHandler {

    @ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Map<String, Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        Map<String, Object> result = new HashMap<>();
        BindingResult bindingResult = ex.getBindingResult();
        StringBuilder sb = new StringBuilder("校驗失敗:");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
        String msg = sb.toString();
        result.put("code", 500);
        result.put("msg", msg);
        return result;
    }

    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Map<String, Object> handleConstraintViolationException(ConstraintViolationException ex) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 500);
        result.put("msg", ex.getMessage());
        return result;
    }
}

在這裡插入圖片描述

4.進階使用

4.1 分組校驗

在實際項目中，可能多個方法需要使用同一個DTO類來接收參數，而不同方法的校驗規則很可能是不一樣的。
這個時候，簡單地在DTO類的字段上加約束註解無法解決這個問題。因此，spring-validation支持瞭分組校驗的功能，專門用來解決這類問題。
還是繼續使用上面的例子，比如保存User的時候，UserId是可空的，但是更新User的時候，UserId的值必須>=10000000000000000L；其它字段的校驗規則在兩種情況下一樣。這個時候使用分組校驗的代碼示例如下：

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@Data
public class UserDTO_Groups {
    @Min(value = 10000000000000000L, groups = Update.class)
    private Long userId;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 2, max = 10, groups = {Save.class, Update.class})
    private String userName;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String account;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String password;


    public interface Save {
    }

    public interface Update {
    }
}

在@Validated註解上指定校驗分組

import com.example.code.po.UserDTO;
import com.example.code.po.UserDTO_Groups;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @PostMapping("/save_group")
    public Map<String, Object> saveUser_Group(@RequestBody @Validated(UserDTO_Groups.Save.class) UserDTO_Groups userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }

    @PostMapping("/update_group")
    public Map<String, Object> updateUser(@RequestBody @Validated(UserDTO_Groups.Update.class) UserDTO_Groups userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }
}

4.2 嵌套校驗

在實際開發中，我們保存User信息的時候同時還帶有Job信息。需要註意的是，此時DTO類的對應字段必須標記@Valid註解。

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.Valid;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

/**
 * 嵌套校驗
 */
@Data
public class UserDTO_Nest {
    @Min(value = 10000000000000000L, groups = Update.class)
    private Long userId;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 2, max = 10, groups = {Save.class, Update.class})
    private String userName;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String account;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String password;

    @NotNull(groups = {Save.class, Update.class})
    @Valid
    private Job job;

    public interface Save {
    }

    public interface Update {
    }
}

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@Data
public class Job {

    @Min(value = 1, groups = UserDTO_Nest.Update.class)
    private Long jobId;

    @NotNull(groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    @Length(min = 2, max = 10, groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    private String jobName;

    @NotNull(groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    @Length(min = 2, max = 10, groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    private String position;

}


package com.example.code.controller;

import com.example.code.po.UserDTO;
import com.example.code.po.UserDTO_Groups;
import com.example.code.po.UserDTO_Nest;
import com.example.code.validate.ValidationList;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {

    @PostMapping("/save1")
    public Map<String, Object> save1(@RequestBody @Validated(UserDTO_Nest.Save.class) UserDTO_Nest userList) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userList);
        return result;
    }
}

因為我們在代碼中設置瞭嵌套校驗要求job不能為空，所以:

在這裡插入圖片描述

我們在job類匯總設置瞭position最小長度為2，所以：

在這裡插入圖片描述

嵌套校驗可以結合分組校驗一起使用。
嵌套集合校驗會對集合裡面的每一項都進行校驗，例如List< Job>字段會對這個list裡面的每一個Job對象都進行校驗。

4.3 集合校驗

如果請求體直接傳遞瞭json數組給後臺，並希望對數組中的每一項都進行參數校驗。
此時，如果我們直接使用java.util.Collection下的list或者set來接收數據，參數校驗並不會生效！我們可以使用自定義list集合來接收參數：

1.包裝List類型，並聲明@Valid註解

package com.example.code.validate;

import lombok.experimental.Delegate;

import javax.validation.Valid;
import java.util.ArrayList;
import java.util.List;

public class ValidationList<E> implements List<E> {

    @Delegate
    @Valid
    public List<E> list = new ArrayList<>();

    @Override
    public String toString() {
        return list.toString();
    }
}

註意：@Delegate註解受lombok版本限制，1.18.6以上版本可支持。如果校驗不通過，會拋出NotReadablePropertyException，同樣可以使用統一異常進行處理。
接下來我們開發接口，使其可以批量保存

import com.example.code.po.UserDTO;
import com.example.code.po.UserDTO_Groups;
import com.example.code.po.UserDTO_Nest;
import com.example.code.validate.ValidationList;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @PostMapping("/saveList")
    public Map<String, Object> saveList(@RequestBody @Validated(UserDTO_Nest.Save.class) ValidationList<UserDTO_Nest> userList) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userList);
        return result;
    }
}

4.4 自定義校驗

在我們實際的業務開發中，我們的需求總是比框架提供的這些簡單校驗要復雜的多，我們可以通過自定義校驗來滿足我們的需求。

假設我們自定義加密id（由數字或者a-f的字母組成，32-256長度）校驗，主要分為兩步：

1.自定義約束註解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EncryptIdValidator.class})
public @interface EncryptId {

    String message() default "加密id格式錯誤";

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

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

2.實現ConstraintValidator接口編寫約束校驗器

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> {

    private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$");

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {

        if (value != null) {
            Matcher matcher = PATTERN.matcher(value);
            return matcher.find();
        }
        return true;
    }
}

3.在實體類上的字段中進行使用

import com.example.code.validate.EncryptId;
import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.NotNull;

@Data
public class UserDTO {

    private Long userId;

    @NotNull
    @Length(min = 2, max = 10)
    private String userName;

    @NotNull
    @Length(min = 6, max = 20)
    private String account;

    @NotNull
    @EncryptId
    private String password;
}

4.測試

import com.example.code.validate.ValidationList;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @PostMapping("/save2")
    public Map<String, Object> save2(@RequestBody @Validated UserDTO userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }
}

結果如下：

在這裡插入圖片描述

我們可以看到自定義的校驗已經應用成功瞭

5.快速失敗 (Fail Fast)

Spring Validation默認會校驗完所有字段，然後才拋出異常。此時如果需要校驗字段過多則會影響前後端交互的速度，我們可以通過一些簡單的配置，開啟Fali Fast模式，一旦校驗失敗就立即返回。

import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

@Component
public class ValidatorConfig {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()

                .failFast(true)
                .buildValidatorFactory();
        return validatorFactory.getValidator();
    }
}

6.@Valid和@Validated區別

區別 @Valid @Validated
提供者 JSR-303 規范 Spring
是否支持分組 不支持 支持
標註位置 METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USE TYPE, METHOD, PARAMETER
嵌套校驗 支持 不支持

7.實現原理

7.1 requestBody參數校驗實現原理

在spring-mvc中，RequestResponseBodyMethodProcessor是用於解析@RequestBody標註的參數以及處理@ResponseBody標註方法的返回值的。顯然，執行參數校驗的邏輯肯定就在解析參數的方法resolveArgument()中：

於是我們看一下RequestResponseBodyMethodProcessor的resolveArgument()方法

在這裡插入圖片描述

可以看到調用瞭validateIfApplicable()進行參數校驗，我們在看看validateIfApplicable()具體是如何校驗的

在這裡插入圖片描述

我們可以看到真正的校驗，無論是@Validated、@Valid都是通過binder.validate(validationHints);實現，所以我們在接著往下看看WebDataBinder.validate()實現

在這裡插入圖片描述

最終發現底層最終還是調用瞭Hibernate Validator進行真正的校驗處理

7.2 方法級別的參數校驗實現原理

上面提到的將參數一個個平鋪到方法參數中，然後在每個參數前面聲明約束註解的校驗方式，就是方法級別的參數校驗,如下圖所示：

在這裡插入圖片描述

實際上，這種方式可用於任何Spring Bean的方法上，比如Controller/Service等。其底層實現原理就是AOP，具體來說是通過MethodValidationPostProcessor動態註冊AOP切面，然後使用MethodValidationInterceptor對切點方法織入增強。

我們看一下MethodValidationPostProcessor中源碼的實現

在這裡插入圖片描述

最終調用的是MethodValidationInterceptor()，那麼我們進入到該類看一下

在這裡插入圖片描述

實際上，不管是requestBody參數校驗還是方法級別的校驗，最終都是調用Hibernate Validator執行校驗，Spring Validation隻是做瞭一層封裝。
至此對於接口參數的校驗就到此結束瞭，有問題歡迎大傢來下方討論，謝謝。

到此這篇關於SpringBoot實現接口的各種參數校驗的示例的文章就介紹到這瞭,更多相關SpringBoot 接口參數校驗內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：