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

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

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

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

groups

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

這個(gè)groups是各類(lèi)Validation注解中的一個(gè)屬性信息，其定義如下：

@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中的一個(gè)屬性。

定義Maker接口

兩種情況的接口類(lèi)：

public interface CreateAction {
}
public interface UpdateAction {
}

這兩個(gè)接口分別代表兩種不同的類(lèi)型信息。

定義實(shí)體Bean

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

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

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

定義使用實(shí)體Bean服務(wù)

定義定義這些Bean的服務(wù)：

@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注解中，通過(guò)不同的groups信息類(lèi)型，來(lái)實(shí)現(xiàn)規(guī)則的靈活定義。

單元測(cè)試

測(cè)試代碼如下：

@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);
    }
}

上述的代碼驗(yàn)證了兩種情況，分別覆蓋了各類(lèi)group情況。

小結(jié)一下

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

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

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

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

在SpringBoot中可以使用@Validated，注解Hibernate Validator加強(qiáng)版，也可以使用@Valid原來(lái)Bean Validation java版本

內(nèi)置校驗(yàn)注解

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

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

Hibernate Validator 附加的 constraint

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

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

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

hibernate補(bǔ)充的注解中，最后3個(gè)不常用，可忽略。

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

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

分組校驗(yàn)

如果同一個(gè)參數(shù)，需要在不同場(chǎng)景下應(yīng)用不同的校驗(yàn)規(guī)則，就需要用到分組校驗(yàn)了。比如：新注冊(cè)用戶還沒(méi)起名字，我們?cè)试Sname字段為空，但是在更新時(shí)候不允許將名字更新為空字符。

分組校驗(yàn)有三個(gè)步驟：

1.定義一個(gè)分組類(lèi)（或接口）

public interface Update extends Default{
}

2.在校驗(yàn)注解上添加groups屬性指定分組

public class UserVO {
    @NotBlank(message = "name 不能為空",groups = Update.class)
    private String name;
    // 省略其他代碼...
}

3.Controller方法的@Validated注解添加分組類(lèi)

@PostMapping("update")
public ResultInfo update(@Validated({Update.class}) UserVO userVO) {
    return new ResultInfo().success(userVO);
}

自定義的Update分組接口繼承了Default接口。校驗(yàn)注解(如： @NotBlank)和@validated默認(rèn)其他注解都屬于Default.class分組，這一點(diǎn)在javax.validation.groups.Default注釋中有說(shuō)明

/**
 * 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 {
}

在編寫(xiě)Update分組接口時(shí)，如果繼承了Default，下面兩個(gè)寫(xiě)法就是等效的：

@Validated({Update.class}),@Validated({Update.class,Default.class})

如果Update不繼承Default，@Validated({Update.class})就只會(huì)校驗(yàn)屬于Update.class分組的參數(shù)字段

遞歸校驗(yàn)

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

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;
    //需要遞歸校驗(yàn)的OrderVO
    @Valid
    private OrderVO orderVO;
    // 省略其他代碼...
}

自定義校驗(yàn)

validation 為我們提供了這么多特性，幾乎可以滿足日常開(kāi)發(fā)中絕大多數(shù)參數(shù)校驗(yàn)場(chǎng)景了。但是，一個(gè)好的框架一定是方便擴(kuò)展的。有了擴(kuò)展能力，就能應(yīng)對(duì)更多復(fù)雜的業(yè)務(wù)場(chǎng)景，畢竟在開(kāi)發(fā)過(guò)程中，唯一不變的就是變化本身。 Validation允許用戶自定義校驗(yàn)

實(shí)現(xiàn)很簡(jiǎn)單，分兩步：

1.自定義校驗(yàn)注解

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 
 * 日期驗(yàn)證 約束注解類(lèi)
 */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {IsDateTimeValidator.class}) // 標(biāo)明由哪個(gè)類(lèi)執(zhí)行校驗(yàn)邏輯
public @interface IsDateTime {
    // 校驗(yàn)出錯(cuò)時(shí)默認(rèn)返回的消息
    String message() default "日期格式錯(cuò)誤";
    //分組校驗(yàn)
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    //下面是我自己定義屬性
    boolean required() default true;
    String dateFormat() default "yyyy-MM-dd";
}

注意:message用于顯示錯(cuò)誤信息這個(gè)字段是必須的，groups和payload也是必須的

@Constraint(validatedBy = { HandsomeBoyValidator.class})用來(lái)指定處理這個(gè)注解邏輯的類(lèi)

2.編寫(xiě)校驗(yàn)者類(lèi)

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
 * 日期驗(yàn)證器
 */
public class IsDateTimeValidator implements ConstraintValidator<IsDateTime, String> {
    private boolean required = false;
    private String dateFormat = "yyyy-MM-dd";
    /**
     * 用于初始化注解上的值到這個(gè)validator
     * @param constraintAnnotation
     */
    @Override
    public void initialize(IsDateTime constraintAnnotation) {
        required = constraintAnnotation.required();
        dateFormat = constraintAnnotation.dateFormat();
    }
    /**
     * 具體的校驗(yàn)邏輯
     * @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);
            }
        }
    }
}

注意這里驗(yàn)證邏輯我抽出來(lái)單獨(dú)寫(xiě)了一個(gè)工具類(lèi)，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
 * 驗(yàn)證表達(dá)式
 */
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}$");
    /**
     * 驗(yàn)證手機(jī)號(hào)
     *
     * @param src
     * @return
     */
    public static boolean isMobile(String src) {
        if (StrUtil.isBlank(src)) {
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }
    /**
     * 驗(yàn)證枚舉值是否合法 ，所有枚舉需要繼承此方法重寫(xiě)
     *
     * @param beanClass 枚舉類(lèi)
     * @param status    對(duì)應(yīng)code
     * @return
     * @throws Exception
     */
    public static boolean isEnum(Class<?> beanClass, String status) throws Exception {
        if (StrUtil.isBlank(status)) {
            return false;
        }
        //轉(zhuǎn)換枚舉類(lèi)
        Class<Enum> clazz = (Class<Enum>) beanClass;
        /**
         * 其實(shí)枚舉是語(yǔ)法糖
         * 是封裝好的多個(gè)Enum類(lèi)的實(shí)列
         * 獲取所有枚舉實(shí)例
         */
        Enum[] enumConstants = clazz.getEnumConstants();
        //根據(jù)方法名獲取方法
        Method getCode = clazz.getMethod("getCode");
        Method getDesc = clazz.getMethod("getDesc");
        for (Enum enums : enumConstants) {
            //得到枚舉實(shí)例名
            String instance = enums.name();
            //執(zhí)行枚舉方法獲得枚舉實(shí)例對(duì)應(yīng)的值
            String code = getCode.invoke(enums).toString();
            if (code.equals(status)) {
                return true;
            }
            String desc = getDesc.invoke(enums).toString();
            System.out.println(StrFormatter.format("實(shí)列{}---code:{}desc{}", instance, code, desc));
        }
        return false;
    }
    /**
     * 驗(yàn)證金額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();
    }
    /**
     * 驗(yàn)證 日期
     *
     * @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;
        }
    }
}

我自定義了補(bǔ)充了很多驗(yàn)證器，包括日期驗(yàn)證，枚舉驗(yàn)證，手機(jī)號(hào)驗(yàn)證，金額驗(yàn)證

自定義校驗(yàn)注解使用起來(lái)和內(nèi)置注解無(wú)異，在需要的字段上添加相應(yīng)注解即可

校驗(yàn)流程解析

使用 Validation API 進(jìn)行參數(shù)效驗(yàn)步驟整個(gè)過(guò)程如下圖所示，用戶訪問(wèn)接口，然后進(jìn)行參數(shù)效驗(yàn) ，如果效驗(yàn)通過(guò)，則進(jìn)入業(yè)務(wù)邏輯，否則拋出異常，交由全局異常處理器進(jìn)行處理