Spring boot 參數驗證——使用hibernate validator

零、使用

參考資料：【SpringMVC學習06】SpringMVC中的數據校驗

spring boot默認使用 hibernate validator

1、依賴（以spring boot 爲例）

<dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>RELEASE</version>
        </dependency>
複製代碼

2、在你須要校驗的屬性上加上@NotNull等註釋

public class Person{
    @NotNull
	private String name;  
}
複製代碼

3、加上@Valid註釋，同時用bindingResult獲取異常（必須緊跟在@Valid修飾的變量後面，這是由於，在參數列表中容許有多於一個的模型對象，Spring會爲它們建立不一樣的BindingResult實例。 ）

@RequestMapping(value = "/edit")
    public Result<Long> insertBase(@Valid Person person, BindingResult bindingResult) {
        //參數校驗
        if (bindingResult.hasErrors()) {
            return Result.createFailResult(ResultCodeEnums.PARAM_ERROR);
        }
	}
複製代碼

1、規則

@AssertFalse	Boolean,boolean	驗證註解的元素值是false
@AssertTrue	Boolean,boolean	驗證註解的元素值是true
@NotNull	任意類型	驗證註解的元素值不是null
@Null	任意類型	驗證註解的元素值是null
@Min(value=值)	BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存儲的是數字）子類型	驗證註解的元素值大於等於@Min指定的value值
@Max（value=值）	和@Min要求同樣	驗證註解的元素值小於等於@Max指定的value值
@DecimalMin(value=值)	和@Min要求同樣	驗證註解的元素值大於等於@ DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求同樣	驗證註解的元素值小於等於@ DecimalMax指定的value值
@Digits(integer=整數位數, fraction=小數位數)	和@Min要求同樣	驗證註解的元素值的整數位數和小數位數上限
@Size(min=下限, max=上限)	字符串、Collection、Map、數組等	驗證註解的元素值的在min和max（包含）指定區間以內，如字符長度、集合大小
@Past	java.util.Date,java.util.Calendar;Joda Time類庫的日期類型	驗證註解的元素值（日期類型）比當前時間早
@Future	與@Past要求同樣	驗證註解的元素值（日期類型）比當前時間晚
@NotBlank	CharSequence子類型	驗證註解的元素值不爲空（不爲null、去除首位空格後長度爲0），不一樣於@NotEmpty，@NotBlank只應用於字符串且在比較時會去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子類型	驗證註解的元素值長度在min和max區間內
@NotEmpty	CharSequence子類型、Collection、Map、數組	驗證註解的元素值不爲null且不爲空（字符串長度不爲0、集合大小不爲0）
@Range(min=最小值, max=最大值)	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子類型和包裝類型	驗證註解的元素值在最小值和最大值之間
@Email(regexp=正則表達式,flag=標誌的模式)	CharSequence子類型（如String）	驗證註解的元素值是Email，也能夠經過regexp和flag指定自定義的email格式
@Pattern(regexp=正則表達式,flag=標誌的模式)	String，任何CharSequence的子類型	驗證註解的元素值與指定的正則表達式匹配
@Valid	任何非原子類型	指定遞歸驗證關聯的對象；如用戶對象中有個地址對象屬性，若是想在驗證用戶對象時一塊兒驗證地址對象的話，在地址對象上加@Valid註解便可級聯驗證

參考資料：SpringMVC數據驗證——第七章 註解式控制器的數據驗證、類型轉換及格式化——跟着開濤學SpringMVC

2、Validator

參考資料：使用Validator作SpringMVC的驗證框架 - 使用Validator

3、@Validated 和@Valid的區別

原文連接：stackoverflow.com/a/52092984/…

@Valid的使用

Controller:

@RequestMapping(value = "createAccount")
public String stepOne(@Valid Account account) {...}
複製代碼

Form object:

public class Account {

    @NotBlank
    private String username;

    @Email
    @NotBlank
    private String email;

}
複製代碼

---

@Validated的使用 Source: blog.codeleak.pl/2014/08/val…

Controller:

@RequestMapping(value = "stepOne")
public String stepOne(@Validated(Account.ValidationStepOne.class) Account account) {...}

@RequestMapping(value = "stepTwo")
public String stepTwo(@Validated(Account.ValidationStepTwo.class) Account account) {...}
複製代碼

Form object:

public class Account {

    @NotBlank(groups = {ValidationStepOne.class})
    private String username;

    @Email(groups = {ValidationStepOne.class})
    @NotBlank(groups = {ValidationStepOne.class})
    private String email;

    @NotBlank(groups = {ValidationStepTwo.class})
    @StrongPassword(groups = {ValidationStepTwo.class})
    private String password;

    @NotBlank(groups = {ValidationStepTwo.class})
    private String confirmedPassword;
    
    public interface ValidationStepOne {
    }
    public interface ValidationStepTwo {
    }

}
複製代碼

4、常見問題

一、@Valid在list失效

你看一下你是否是沒有在list以前加上@Valid

二、參數綁定的error

若是添加的註解在參數綁定的時候就報錯了，好比須要的是Integer，可是傳入的是String

這時候分三種狀況

一、有@Valid 有BindingResult 使用的是普通的參數接收；

能夠被bindingResult捕獲，判斷isBindingFailure能夠知道是不是參數綁定失敗

此時你添加在這個參數上的校驗註解會不啓用，由於參數綁定是在註解校驗以前

@RequestMapping(value = "/edit")
    public Result<Long> insertBase(@Valid Person person, BindingResult bindingResult) {
        Result<Long> result = Result.createFailResult();
        //參數校驗
        if (bindingResult.hasErrors()) {
            List<FieldError> list = bindingResult.getFieldErrors();
            String message = list.get(0).getDefaultMessage();
            if (list.get(0).isBindingFailure()){
                message = HealthRecordVO.getValidName().get(list.get(0).getField())+"類型不匹配";
            }
            result.setMsg(message);
            return result;
        }
	}
	
	
// 此時getDefaultMessage會顯示 ：Failed to convert property value of type 'java.lang.String' to required type 'java.lang.Integer' for property 'weight'; nested exception is java.lang.NumberFormatException: For input string: "字符串"
複製代碼

二、有@Valid 有BindingResult 參數是以json形式接收的；

此時就不能被bindingResult捕獲了，會直接拋給前端400的異常

@RequestMapping(value = "/edit", method = RequestMethod.POST)
public Result<Long> insertBase(@RequestBody @Valid Person person, BindingResult bindingResult) {
    Result<Long> result = Result.createFailResult();
    //參數校驗
    if (bindingResult.hasErrors()) {
        List<FieldError> list = bindingResult.getFieldErrors();
        String message = list.get(0).getDefaultMessage();
        if (list.get(0).isBindingFailure()){
            message = HealthRecordVO.getValidName().get(list.get(0).getField())+"類型不匹配";
        }
        result.setMsg(message);
        return result;
    }
}
//此時bindingResult啥也拿不到
複製代碼

通常來講類型匹配應該是由前端來作控制，可是保不齊有什麼特殊狀況（好比前端實在是沒有時間……）

此時咱們能夠在這個controller中加上一個單獨的異常處理

@ResponseBody
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public Result<Long> messageNotReadable(HttpMessageNotReadableException exception){
        InvalidFormatException formatException = (InvalidFormatException)exception.getCause();
        List<JsonMappingException.Reference> e = formatException.getPath();
        String fieldName = "";
        for (JsonMappingException.Reference reference :e){
            //這裏得到了類型匹配出錯的屬性的屬性名
            String field = reference.getFieldName();
        }
        return Result.createFailResult(field+"請輸入數字");
    }
複製代碼

@ResponseStatus 這個註解是爲了標識這個方法返回值的HttpStatus code ，這裏咱們不變，仍是拋出400

@ExceptionHandler 當一個Controller中有方法加了@ExceptionHandler以後，這個Controller其餘方法中沒有捕獲的異常就會以參數的形式傳入加了@ExceptionHandler註解的那個方法中。

在這裏，因爲springmvc默認採用jackson做爲json序列化工具，當反序列化失敗的時候就會拋出HttpMessageNotReadableException

固然這裏只針對了一個controller裏面的參數校驗，你一樣可使用@ControllerAdvice來作全局異常判斷

三、沒有@Valid 或者沒有BindingResult

此時接口返回的就是400了，畢竟你啥也沒作

參考連接：www.cnblogs.com/woshimrf/p/…