SpringBoot利用@Validated和@Valid進行校驗參數

什麼是Validator

Spring Validation驗證框架對參數的驗證機制提供了@Validated（Spring's JSR-303規範，是標準JSR-303的一個變種），javax提供了@Valid（標準JSR-303規範），配合BindingResult可以直接提供參數驗證結果。

@Validated是@Valid的一次封裝，不是規範。

在檢驗Controller的入參是否符合規範時，使用@Validated或者@Valid在基本驗證功能上沒有太多區別。但是在分組、註解地方、嵌套驗證等功能上兩個有所不同：

分組：
@Validated：提供了一個分組功能，可以在入參驗證時，根據不同的分組採用不同的驗證機制

@Valid：作爲標準JSR-303規範，還沒有吸收分組的功能。

註解地方：

• @Validated：可以用在類、方法和方法參數上。
• @Valid：可以用在方法、構造函數、方法參數和成員屬性（字段）上
• 嵌套驗證：
• 嵌套驗證就是類嵌套類的驗證，比如我要在集合上加一個@notnull的註解，要求該集合中的每一個對象都被驗證，如果只用@Validated與@Valid是不會驗證的。我們要用@Validated配合@Valid來進行驗證。

使用示例：

方法參數校驗：

@GetMapping("/validtest")
@ResponseBody
public String validtest(
        @Size(min = 1,max = 10,message = "姓名長度必須爲1到10")@RequestParam("name") String name,
        @Min(value = 10,message = "年齡最小爲10")@Max(value = 100,message = "年齡最大爲100") @RequestParam("age") Integer age) {
    return "validtest";
}

 

對象/DTO對象校驗

//如果你有一個學生類，其結構如下
//在新增時需要驗證其名字和年齡是否爲空，那麼只需要如下操作即可

public class StudentDTO{
    @NotBlank(message = "學生名稱不能爲空")
    private String name;
    @NotNull(message = "年齡不能爲空")
    private Integer age;
    ...
    getter
    setter省略
}

//在web接口處

@RestController
@RequestMapping("/api/v1/student")
public class StudentController{
    
    /**
     *
     * BindingResult result 一定要跟在 @Validated 註解對象的後面,且當有多個@Validated
     * 註解時,每個註解對象後面都需要添加一個
     */
    @PostMapping("add")
    public ResponseEntity addStudent(@RequestBody @Validated StudentDTO student , BindingResult result){
    
        if(result.hasErrors()){
            return new ResponseEntity(result.getFieldError().getDefaultMessage());
            //result.getFieldError().getDefaultMessage() 這個方法的內容就是剛剛在DTO處定義的message內容
        }
    }
}

然後需要在controller方法體添加@Validated或@Valid  不加校驗會不起作用

嵌套校驗：

示例：

public class Item {

    @NotNull(message = "id不能爲空")
    @Min(value = 1, message = "id必須爲正整數")
    private Long id;

    @Valid // 嵌套驗證必須用@Valid
    @NotNull(message = "props不能爲空")
    @Size(min = 1, message = "props至少要有一個自定義屬性")
    private List<Prop> props;
}

Item帶有很多屬性，屬性裏面有屬性id，屬性值id，屬性名和屬性值，如下所示：

public class Prop {

    @NotNull(message = "pid不能爲空")
    @Min(value = 1, message = "pid必須爲正整數")
    private Long pid;

    @NotNull(message = "vid不能爲空")
    @Min(value = 1, message = "vid必須爲正整數")
    private Long vid;

    @NotBlank(message = "pidName不能爲空")
    private String pidName;

    @NotBlank(message = "vidName不能爲空")
    private String vidName;
}

分組校驗

import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

public class Resume {
    public interface Default {
    }

    public interface Update {
    }

    @NotNull(message = "id不能爲空", groups = Update.class)
    private Long id;

    @NotNull(message = "名字不能爲空", groups = Default.class)
    @Length(min = 4, max = 10, message = "name 長度必須在 {min} - {max} 之間", groups = Default.class)
    private String name;

    @NotNull(message = "年齡不能爲空", groups = Default.class)
    @Min(value = 18, message = "年齡不能小於18歲", groups = Default.class)
    private Integer age;
    
}

使用分組：

/**
     * 使用Defaul分組進行驗證
     * @param resume
     * @return
     */
    @PostMapping("/validate5")
    public String addUser(@Validated(value = Resume.Default.class) @RequestBody Resume resume) {
        return "validate5";
    }

    /**
     * 使用Default、Update分組進行驗證
     * @param resume
     * @return
     */
    @PutMapping("/validate6")
    public String updateUser(@Validated(value = {Resume.Update.class, Resume.Default.class}) @RequestBody Resume resume) {
        return "validate6";
    }

建立了兩個分組，名稱分別爲Default、Update。POST方法提交時使用Defaut分組的校驗規則，PUT方法提交時同時使用兩個分組規則。

自定義校驗規則

自定義註解校驗

需要自定義一個註解類和一個校驗類。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER,ElementType.FIELD})
@Constraint(validatedBy = FlagValidatorClass.class)
public @interface FlagValidator {
    // flag的有效值，多個使用,隔開
    String values();

    // flag無效時的提示內容
    String message() default "flag必須是預定義的那幾個值，不能隨便寫";

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

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

 

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class FlagValidatorClass implements ConstraintValidator<FlagValidator,Object> {
    /**
     * FlagValidator註解規定的那些有效值
     */
    private String values;

    @Override
    public void initialize(FlagValidator flagValidator) {
        this.values = flagValidator.values();
    }

    /**
     * 用戶輸入的值，必須是FlagValidator註解規定的那些值其中之一。
     * 否則，校驗不通過。
     * @param value 用戶輸入的值，如從前端傳入的某個值
     */
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        // 切割獲取值
        String[] value_array = values.split(",");
        Boolean isFlag = false;

        for (int i = 0; i < value_array.length; i++){
            // 存在一致就跳出循環
            if (value_array[i] .equals(value)){
                isFlag = true; break;
            }
        }

        return isFlag;
    }
}

使用我們自定義的註解：

public class User {
    // 前端傳入的flag值必須是1或2或3，否則校驗失敗
    @FlagValidator(values = "1,2,3")
    private String flag ;
}

添加全局異常

創建一個GlobalExceptionHandler類，在類上方添加@RestControllerAdvice註解然後添加以下代碼：

 /**
     * 對方法參數校驗異常處理方法(僅對於表單提交有效，對於以json格式提交將會失效)
     * 如果是表單類型的提交，則spring會採用表單數據的處理類進行處理（進行參數校驗錯誤時會拋出BindException異常）
     */
    @ExceptionHandler(BindException.class)
    public ResponseEntity<Map<String, Object>> handlerBindException(BindException exception) {
        return handlerNotValidException(exception);
    }
 
    /**
     * 對方法參數校驗異常處理方法(前端提交的方式爲json格式出現異常時會被該異常類處理)
     * json格式提交時，spring會採用json數據的數據轉換器進行處理（進行參數校驗時錯誤是拋出MethodArgumentNotValidException異常）
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, Object>> handlerArgumentNotValidException(MethodArgumentNotValidException exception) {
        return handlerNotValidException(exception);
    }
 
    public ResponseEntity<Map<String, Object>> handlerNotValidException(Exception e) {
        log.debug("begin resolve argument exception");
        BindingResult result;
        if (e instanceof BindException) {
            BindException exception = (BindException) e;
            result = exception.getBindingResult();
        } else {
            MethodArgumentNotValidException exception = (MethodArgumentNotValidException) e;
            result = exception.getBindingResult();
        }
 
        Map<String, Object> maps;
        if (result.hasErrors()) {
            List<FieldError> fieldErrors = result.getFieldErrors();
            maps = new HashMap<>(fieldErrors.size());
            fieldErrors.forEach(error -> {
                maps.put(error.getField(), error.getDefaultMessage());
            });
        } else {
            maps = Collections.EMPTY_MAP;
        }
 
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(maps);
 
    }

在這裏我僅僅是針對參數校驗的異常進行了統一處理，也就是返回給前端的響應碼是400（參數格式錯誤）,對於自定義異常或者其他的異常都可以採用這種方式來對異常進行統一處理