SpringBoot之groups應對不同的Validation規(guī)則自定義方式

更新時間：2021年10月20日 10:11:50 作者：bladestone

這篇文章主要介紹了SpringBoot之groups應對不同的Validation規(guī)則自定義方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

groups應對不同的Validation規(guī)則自定義

groups

如果同一個規(guī)則，在不同場景下，或許執(zhí)行不同的驗證邏輯，在這種情況下，該如何來處理呢？本節(jié)將基于groups字段來實現(xiàn)靈活的驗證。

這個groups是各類Validation注解中的一個屬性信息，其定義如下：

@Target({ElementType.FIELD})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = IPAddressValidator.class)
public @interface IPAddress {
    String message() default "{ipaddress.invalid}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

其中g(shù)roups在IPAddress中的一個屬性。

定義Maker接口

兩種情況的接口類：

public interface CreateAction {
}
public interface UpdateAction {
}

這兩個接口分別代表兩種不同的類型信息。

定義實體Bean

實體Bean類中包含兩組的驗證規(guī)則，這些規(guī)則甚至都是沖突的，通過groups來實現(xiàn)規(guī)則的選取和靈活使用：

@Data
public class BeanInGroup {
    @Null(groups = CreateAction.class)
    @NotNull(groups = UpdateAction.class)
    private Long id;
}

在這里的id，對于不同的groups分別定義不同的validation規(guī)則。

定義使用實體Bean服務

定義定義這些Bean的服務：

@Validated
@Service
@Slf4j
public class BeanGroupService {
    @Validated(CreateAction.class)
    public void validateInCreate(@Valid BeanInGroup beanGroup) {
        log.info("validateInCreate:{}", beanGroup);
    }
    @Validated(UpdateAction.class)
    public void validateInUpdate(@Valid BeanInGroup beanGroup) {
        log.info("validateInUpdate:{}", beanGroup);
    }
}

在@Validated注解中，通過不同的groups信息類型，來實現(xiàn)規(guī)則的靈活定義。

單元測試

測試代碼如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class BeanGroupTest {
    @Autowired
    private BeanGroupService beanGroupService;
    @Test
    public void testValidGroup() {
        BeanInGroup bean = new BeanInGroup();
        bean.setId(null);
        this.beanGroupService.validateInCreate(bean);
        bean.setId(12l);
        this.beanGroupService.validateInUpdate(bean);
    }
    @Test(expected = ConstraintViolationException.class)
    public void testInvalidGroup() {
        BeanInGroup bean = new BeanInGroup();
        bean.setId(12l);
        this.beanGroupService.validateInCreate(bean);
        bean.setId(null);
        this.beanGroupService.validateInUpdate(bean);
    }
}

上述的代碼驗證了兩種情況，分別覆蓋了各類group情況。

小結(jié)一下

groups分別代表同一個字段情況下的驗證規(guī)則靈活使用，它帶來了靈活性。

Validation參數(shù)校驗詳解自定義注解規(guī)則和分組校驗

Hibernate Validator 是 Bean Validation 的參考實現(xiàn) 。Hibernate Validator 提供了 JSR 303 規(guī)范中所有內(nèi)置 constraint 的實現(xiàn)，除此之外還有一些附加的 constraint

在日常開發(fā)中，Hibernate Validator經(jīng)常用來驗證bean的字段，基于注解，方便快捷高效。

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

內(nèi)置校驗注解

Bean Validation 中內(nèi)置的 constraint

注解	作用
@Valid	被注釋的元素是一個對象，需要檢查此對象的所有字段值
@Null	被注釋的元素必須為 null
@NotNull	被注釋的元素必須不為 null
@AssertTrue	被注釋的元素必須為 true
@AssertFalse	被注釋的元素必須為 false
@Min(value)	被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@Max(value)	被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@DecimalMin(value)	被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value)	被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@Size(max, min)	被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction)	被注釋的元素必須是一個數(shù)字，其值必須在可接受的范圍內(nèi)
@Past	被注釋的元素必須是一個過去的日期
@Future	被注釋的元素必須是一個將來的日期
@Pattern(value)	被注釋的元素必須符合指定的正則表達式

Hibernate Validator 附加的 constraint

注解	作用
@Email	被注釋的元素必須是電子郵箱地址
@Length(min=, max=)	被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty	被注釋的字符串的必須非空
@Range(min=, max=)	被注釋的元素必須在合適的范圍內(nèi)
@NotBlank	被注釋的字符串的必須非空
@URL(protocol=,host=, port=, regexp=, flags=)	被注釋的字符串必須是一個有效的url
@CreditCardNumber	被注釋的字符串必須通過Luhn校驗算法，銀行卡，信用卡等號碼一般都用Luhn計算合法性
@ScriptAssert(lang=, script=, alias=)	要有Java Scripting API 即JSR 223(“Scripting for the JavaTM Platform”)的實現(xiàn)
@SafeHtml(whitelistType=,additionalTags=)	classpath中要有jsoup包

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

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

hibernate補充的注解中，最后3個不常用，可忽略。

主要區(qū)分下@NotNull @NotEmpty @NotBlank 3個注解的區(qū)別：

@NotNull 任何對象的value不能為null
@NotEmpty 集合對象的元素不為0，即集合不為空，也可以用于字符串不為null
@NotBlank 只能用于字符串不為null，并且字符串trim()以后length要大于0

分組校驗

如果同一個參數(shù)，需要在不同場景下應用不同的校驗規(guī)則，就需要用到分組校驗了。比如：新注冊用戶還沒起名字，我們允許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分組的參數(shù)字段

遞歸校驗

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

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 為我們提供了這么多特性，幾乎可以滿足日常開發(fā)中絕大多數(shù)參數(shù)校驗場景了。但是，一個好的框架一定是方便擴展的。有了擴展能力，就能應對更多復雜的業(yè)務場景，畢竟在開發(fā)過程中，唯一不變的就是變化本身。 Validation允許用戶自定義校驗

實現(xiàn)很簡單，分兩步：

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}) // 標明由哪個類執(zhí)行校驗邏輯
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;
        }
        //轉(zhuǎn)換枚舉類
        Class<Enum> clazz = (Class<Enum>) beanClass;
        /**
         * 其實枚舉是語法糖
         * 是封裝好的多個Enum類的實列
         * 獲取所有枚舉實例
         */
        Enum[] enumConstants = clazz.getEnumConstants();
        //根據(jù)方法名獲取方法
        Method getCode = clazz.getMethod("getCode");
        Method getDesc = clazz.getMethod("getDesc");
        for (Enum enums : enumConstants) {
            //得到枚舉實例名
            String instance = enums.name();
            //執(zhí)行枚舉方法獲得枚舉實例對應的值
            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;
        }
    }
}

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