學習Spring中的validate 背景參數校驗

     前不久開發了代碼生成器，通過Mybatis-plus的模闆插件引擎動态生成crud模闆。搞定後，就想對請求參數進行校驗。由于我這個模闆是通過表來生成的，也就是說在新增與編輯的時候，我也是會把相關的字段生成的，由于這表是從資料庫讀取的，那麼這些字段的非空限制，字段長度限制...是可以進行參數校驗，進行優化。 最近從網上查找了Spring的validate相關資料，學習一下哈。

validator

1. javax.validation

   的一系列注解可以幫我們完成參數校驗,免去繁瑣的串行校驗
2. 什麼是

   javax.validation

JSR303 是一套JavaBean參數校驗的标準，它定義了很多常用的校驗注解，我們可以直接将這些注解加在我們JavaBean的屬性上面(面向注解程式設計的時代)，就可以在需要校驗的時候進行校驗了,在SpringBoot中已經包含在starter-web中,再其他項目中可以引用依賴,并自行調整版本:

     3: 注解說明

[email protected]：不能為null，但可以為empty(""," ","   ")      
   [email protected]：不能為null，而且長度必須大于0 (" ","  ")
   [email protected]：隻能作用在String上，不能為null，而且調用trim()後，長度必須大于0("test")    即：必須有實際字元
           

驗證注解	驗證的資料類型	說明
@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注解即可級聯驗證

此處隻列出Hibernate Validator提供的大部分驗證限制注解，請參考hibernate validator官方文檔了解其他驗證限制注解和進行自定義的驗證限制注解定義。

實戰練習

依賴：

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
           

實體類

import java.math.BigDecimal;
import java.util.Date;

import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Future;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;

import lombok.Data;

/**
 * @author : dengbin
 * @date :  2019/11/14
 */
@Data
public class User {

    @NotNull(message = "名字不能為空")
    private String name;

    @Size(min = 6, max = 30, message = "位址應該在6-30字元之間")
    private String address;

    @DecimalMax(value = "100.00", message = "體重有些超标哦")
    @DecimalMin(value = "60.00", message = "多吃點飯吧")
    private BigDecimal weight;

    @Future(message = "生日必須在目前實踐之前")
    private Date birthday;

    @Pattern(regexp = "^(.+)@(.+)$", message = "郵箱的格式不合法")
    private String email;

}
           

demo測試

@ApiOperation("添加使用者")
    @PostMapping("/add")
    public ApiResp add(@Valid @RequestBody User user) throws Exception {
        return userService.add(user);
    }
           

定義全局異常，接受validate所抛出的異常。

@ControllerAdvice
@Slf4j
public class ExceptionConfig {
      @ExceptionHandler(value = MethodArgumentNotValidException.class)
        @ResponseBody
        public EmptyResp handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
            StringBuilder builder = new StringBuilder();
            BindingResult bindingResult = ex.getBindingResult();
            for (FieldError fieldError : bindingResult.getFieldErrors()) {
                builder.append(fieldError.getField());
                builder.append("(");
                builder.append(fieldError.getRejectedValue());
                builder.append(",");
                builder.append(fieldError.getDefaultMessage());
                builder.append(")");
            }
            return new EmptyResp(RetCode.REQ_PARAM_INVALID, builder.toString());
        }
}
           

先寫到這，接下來再補充學到的知識點。