SpringBoot Validation參數校驗 詳解自定義註解規則和分組校驗

• 2021 年 7 月 7 日
• 筆記
• springboot, validation

前言

Hibernate Validator 是 Bean Validation 的參考實現 。Hibernate Validator 提供了 JSR 303 規範中所有內置 constraint 的實現，除此之外還有一些附加的 constraint
在日常開發中，Hibernate Validator經常用來驗證bean的欄位，基於註解，方便快捷高效。

在SpringBoot中可以使用@Validated，註解Hibernate Validator加強版，也可以使用@Valid原來Bean Validation java版本

內置校驗註解

Bean Validation 中內置的 constraint

Hibernate Validator 附加的 constraint

message支援表達式和EL表達式 ，比如message = “姓名長度限制為{min}到{max} ${1+2}”)

想把錯誤描述統一寫到properties的話，在classpath下面新建ValidationMessages_zh_CN.properties文件(注意value需要轉換為unicode編碼)，然後用{}格式的佔位符

hibernate補充的註解中，最後3個不常用，可忽略。
主要區分下@NotNull @NotEmpty @NotBlank 3個註解的區別：

1. @NotNull 任何對象的value不能為null
2. @NotEmpty 集合對象的元素不為0，即集合不為空，也可以用於字元串不為null
3. @NotBlank 只能用於字元串不為null，並且字元串trim()以後length要大於0

分組校驗

如果同一個參數，需要在不同場景下應用不同的校驗規則，就需要用到分組校驗了。比如：新註冊用戶還沒起名字，我們允許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不繼承Default，@Validated({Update.class})就只會校驗屬於Update.class分組的參數欄位

遞歸校驗

如果 UserVO 類中增加一個 OrderVO 類的屬性，而 OrderVO 中的屬性也需要校驗，就用到遞歸校驗了，只要在相應屬性上增加@Valid註解即可實現（對於集合約樣適用）

public class OrderVO {
    @NotNull
    private Long id;
    @NotBlank(message = "itemName 不能為空")
    private String itemName;
    // 省略其他程式碼...
}

public class UserVO {
    @NotBlank(message = "name 不能為空",groups = Update.class)
    private String name;
    //需要遞歸校驗的OrderVO
    @Valid
    private OrderVO orderVO;
    // 省略其他程式碼...
}   

自定義校驗

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

實現很簡單，分兩步：

1. 自定義校驗註解

package cn.soboys.core.validator;

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


/**
 * @author kenx
 * @version 1.0
 * @date 2021/1/21 20:49 
 * 日期驗證 約束註解類
 */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {IsDateTimeValidator.class}) // 標明由哪個類執行校驗邏輯
public @interface IsDateTime {

    // 校驗出錯時默認返回的消息
    String message() default "日期格式錯誤";
    //分組校驗
    Class<?>[] groups() default {};

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

    //下面是我自己定義屬性
    boolean required() default true;

    String dateFormat() default "yyyy-MM-dd";


}

注意:message用於顯示錯誤資訊這個欄位是必須的，groups和payload也是必須的
@Constraint(validatedBy = { HandsomeBoyValidator.class})用來指定處理這個註解邏輯的類

2. 編寫校驗者類

package cn.soboys.core.validator;

import cn.hutool.core.util.StrUtil;

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

/**
 * @author kenx
 * @version 1.0
 * @date 2021/1/21 20:51
 * 日期驗證器
 */
public class IsDateTimeValidator implements ConstraintValidator<IsDateTime, String> {

    private boolean required = false;
    private String dateFormat = "yyyy-MM-dd";

    /**
     * 用於初始化註解上的值到這個validator
     * @param constraintAnnotation
     */
    @Override
    public void initialize(IsDateTime constraintAnnotation) {
        required = constraintAnnotation.required();
        dateFormat = constraintAnnotation.dateFormat();
    }

    /**
     * 具體的校驗邏輯
     * @param value
     * @param context
     * @return
     */
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (required) {
            return ValidatorUtil.isDateTime(value, dateFormat);
        } else {
            if (StrUtil.isBlank(value)) {
                return true;
            } else {
                return ValidatorUtil.isDateTime(value, dateFormat);
            }
        }
    }

}

注意這裡驗證邏輯我抽出來單獨寫了一個工具類，ValidatorUtil

package cn.soboys.core.validator;

import cn.hutool.core.date.DateUtil;
import cn.hutool.core.text.StrFormatter;
import cn.hutool.core.util.NumberUtil;
import cn.hutool.core.util.StrUtil;

import java.lang.reflect.Method;
import java.math.BigDecimal;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * @author kenx
 * @version 1.0
 * @date 2021/1/21 20:51
 * 驗證表達式
 */
public class ValidatorUtil {
    private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
    private static final Pattern money_pattern = Pattern.compile("^[0-9]+\\.?[0-9]{0,2}$");

    /**
     * 驗證手機號
     *
     * @param src
     * @return
     */
    public static boolean isMobile(String src) {
        if (StrUtil.isBlank(src)) {
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }


    /**
     * 驗證枚舉值是否合法 ，所有枚舉需要繼承此方法重寫
     *
     * @param beanClass 枚舉類
     * @param status    對應code
     * @return
     * @throws Exception
     */
    public static boolean isEnum(Class<?> beanClass, String status) throws Exception {
        if (StrUtil.isBlank(status)) {
            return false;
        }

        //轉換枚舉類
        Class<Enum> clazz = (Class<Enum>) beanClass;
        /**
         * 其實枚舉是語法糖
         * 是封裝好的多個Enum類的實列
         * 獲取所有枚舉實例
         */
        Enum[] enumConstants = clazz.getEnumConstants();

        //根據方法名獲取方法
        Method getCode = clazz.getMethod("getCode");
        Method getDesc = clazz.getMethod("getDesc");
        for (Enum enums : enumConstants) {
            //得到枚舉實例名
            String instance = enums.name();
            //執行枚舉方法獲得枚舉實例對應的值
            String code = getCode.invoke(enums).toString();
            if (code.equals(status)) {
                return true;
            }
            String desc = getDesc.invoke(enums).toString();
            System.out.println(StrFormatter.format("實列{}---code:{}desc{}", instance, code, desc));
        }
        return false;
    }

    /**
     * 驗證金額0.00
     *
     * @param money
     * @return
     */
    public static boolean isMoney(BigDecimal money) {
        if (StrUtil.isEmptyIfStr(money)) {
            return false;
        }
        if (!NumberUtil.isNumber(String.valueOf(money.doubleValue()))) {
            return false;
        }
        if (money.doubleValue() == 0) {
            return false;
        }
        Matcher m = money_pattern.matcher(String.valueOf(money.doubleValue()));
        return m.matches();
    }


    /**
     * 驗證 日期
     *
     * @param date
     * @param dateFormat
     * @return
     */
    public static boolean isDateTime(String date, String dateFormat) {
        if (StrUtil.isBlank(date)) {
            return false;
        }
        try {
            DateUtil.parse(date, dateFormat);
            return true;
        } catch (Exception e) {
            return false;
        }
    }

}

我自定義了補充了很多驗證器，包括日期驗證，枚舉驗證，手機號驗證，金額驗證

自定義校驗註解使用起來和內置註解無異，在需要的欄位上添加相應註解即可

校驗流程解析

使用 Validation API 進行參數效驗步驟整個過程如下圖所示，用戶訪問介面，然後進行參數效驗 ，如果效驗通過，則進入業務邏輯，否則拋出異常，交由全局異常處理器進行處理

全局異常出來請參考我這篇文章SpringBoot優雅的全局異常處理

關注公眾號猿人生獲取更多乾貨分享

發送參數校驗 獲取完整自定義源碼