Hibernate數據校驗簡介

• 2021 年 11 月 25 日
• 筆記
• JAVA

我們在業務中經常會遇到參數校驗問題，比如前端參數校驗、Kafka消息參數校驗等，如果業務邏輯比較複雜，各種實體比較多的時候，我們通過代碼對這些數據一一校驗，會出現大量的重複代碼以及和主要業務無關的邏輯。Spring MVC提供了參數校驗機制，但是其底層還是通過Hibernate進行數據校驗，所以有必要去了解一下Hibernate數據校驗和JSR數據校驗規範。

JSR數據校驗規範

Java官方先後發佈了JSR303與JSR349提出了數據合法性校驗提供的標準框架：BeanValidator，BeanValidator框架中，用戶通過在Bean的屬性上標註類似於@NotNull、@Max等標準的註解指定校驗規則，並通過標準的驗證接口對Bean進行驗證。

JSR註解列表

JSR標準中的數據校驗註解如下所示：

JSR註解內容

我們以常用的比較簡單的@NotNull註解為例，看看註解中都包含那些內容，如下邊的源碼所示，可以看到@NotNull註解包含以下幾個內容：

1. message：錯誤消息，示例中的是錯誤碼，可以根據國際化翻譯成不同的語言。
2. groups： 分組校驗，不同的分組可以有不同的校驗條件，比如同一個DTO用於create和update時校驗條件可能不一樣。
3. payload：BeanValidation API的使用者可以通過此屬性來給約束條件指定嚴重級別. 這個屬性並不被API自身所使用.

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
@Documented
@Constraint(validatedBy = { })
public @interface NotNull {
	String message() default "{javax.validation.constraints.NotNull.message}";

	Class<?>[] groups() default { };

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

	/**
	 * Defines several {@link NotNull} annotations on the same element.
	 */
	@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
	@Retention(RUNTIME)
	@Documented
	@interface List {

		NotNull[] value();
	}
}

錯誤消息message、分組group這些功能我們程序中使用比較多，在我介紹Spring Validator數據校驗的文章中有詳細說明，但是關於payload我們接觸的比較少，下面我們舉例說明以下payload的使用，下面的示例中，我們用payload來標識數據校驗失敗的嚴重性，通過以下代碼。在校驗完一個ContactDetails的示例之後, 你就可以通過調用ConstraintViolation.getConstraintDescriptor().getPayload()來得到之前指定到錯誤級別了,並且可以根據這個信息來決定接下來到行為.

public class Severity {
    public static class Info extends Payload {};
    public static class Error extends Payload {};
}

public class ContactDetails {
    @NotNull(message="Name is mandatory", payload=Severity.Error.class)
    private String name;

    @NotNull(message="Phone number not specified, but not mandatory", payload=Severity.Info.class)
    private String phoneNumber;

    // ...
}

JSR校驗接口

通過前面的JSR校驗註解，我們可以給某個類的對應字段添加校驗條件，那麼怎麼去校驗這些校驗條件呢？JSR進行數據校驗的核心接口是Validation，該接口的定義如下所示，我們使用比較多的接口應該是<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups);，該方法可以用於校驗某個Object是否符合指定分組的校驗規則，如果不指定分組，那麼只有默認分組的校驗規則會生效。

public interface Validator {

	/**
	 * Validates all constraints on {@code object}.
	 */
	<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups);

	/**
	 * Validates all constraints placed on the property of {@code object}
	 * named {@code propertyName}.
	 */
	<T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName,Class<?>... groups);

	/**
	 * Validates all constraints placed on the property named {@code propertyName}
	 * of the class {@code beanType} would the property value be {@code value}.
	 */
	<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups);

	/**
	 * Returns the descriptor object describing bean constraints.
	 * The returned object (and associated objects including
	 * {@link ConstraintDescriptor}s) are immutable.
	 */
	BeanDescriptor getConstraintsForClass(Class<?> clazz);

	/**
	 * Returns an instance of the specified type allowing access to
	 * provider-specific APIs.
	 * <p>
	 * If the Jakarta Bean Validation provider implementation does not support
	 * the specified class, {@link ValidationException} is thrown.call
	 */
	<T> T unwrap(Class<T> type);

	/**
	 * Returns the contract for validating parameters and return values of methods
	 * and constructors.
	 */
	ExecutableValidator forExecutables();
}

Hibernate數據校驗

基於JSR數據校驗規範，Hibernate添加了一些新的註解校驗，然後實現了JSR的Validator接口用於數據校驗。

Hibernate新增註解

Hibiernate數據校驗

如何使用Hibernate進行數據校驗呢？我們知道JSR規定了數據校驗的接口Validator，Hibernate用ValidatorImpl類中實現了Validator接口，我們可以通過Hibernate提供的工廠類HibernateValidator.buildValidatorFactory創建一個ValidatorImpl實例。使用Hibernate創建一個Validator實例的代碼如下所示。

ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
    .configure()
    .addProperty( "hibernate.validator.fail_fast", "true" )
    .buildValidatorFactory();
Validator validator = validatorFactory.getValidator();

Hibernate校驗源碼

通過上面的內容，我們知道Hibernate可以用工廠方法實例化一個Validator接口的實例，這個實例可以用於帶有校驗註解的校驗JavaBean，那麼Hibernate底層是如何實現這些校驗邏輯的呢？我們以如下JavaBean為例，解析Hibernate校驗的源碼。

@Data
public class Person {

    @NotBlank
    @Size(max=64)
    private String name;

    @Min(0)
    @Max(200)
    private int age;
}

ConstraintValidator介紹

ConstraintValidator是Hibernate中數據校驗的最細粒度，他可以校驗指定註解和類型的數值是否合法。比如上面例子中的@Max(200)private int age;，對於age字段的校驗就會使用一個叫MaxValidatorForInteger的ConstraintValidator，這個ConstraintValidator在校驗的時候會判斷指定的數值是不是大於指定的最大值。

public class MaxValidatorForInteger extends AbstractMaxValidator<Integer> {

	@Override
	protected int compare(Integer number) {
		return NumberComparatorHelper.compare( number.longValue(), maxValue );
	}
}

public abstract class AbstractMaxValidator<T> implements ConstraintValidator<Max, T> {

	protected long maxValue;

	@Override
	public void initialize(Max maxValue) {
		this.maxValue = maxValue.value();
	}

	@Override
	public boolean isValid(T value, ConstraintValidatorContext constraintValidatorContext) {
		// null values are valid
		if ( value == null ) {
			return true;
		}

		return compare( value ) <= 0;
	}

	protected abstract int compare(T number);
}

ConstraintValidator初始化

我們在前面的內容中說到Hibernate提供了ValidatorImpl用於數據校驗，那麼ValidatorImpl和ConstraintValidator是什麼關係呢，簡單來說就是ValidatorImpl在初始化的時候會初始化所有的ConstraintValidator，在校驗數據的過程中調用這些內置的ConstraintValidator校驗數據。內置ConstraintValidator的對應註解的@Constraint(validatedBy = { })是空的。

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
@Documented
@Constraint(validatedBy = { }) // 這兒是空的
public @interface AssertFalse {

	String message() default "{javax.validation.constraints.AssertFalse.message}";

	Class<?>[] groups() default { };

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

	/**
	 * Defines several {@link AssertFalse} annotations on the same element.
	 *
	 * @see javax.validation.constraints.AssertFalse
	 */
	@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
	@Retention(RUNTIME)
	@Documented
	@interface List {

		AssertFalse[] value();
	}
}

自定義ConstraintValidator

如果Hibernate和JSR中的註解不夠我用，我需要自定義一個註解和約束條件，我們應該怎麼實現呢。實現一個自定義校驗邏輯一共分兩步：1.註解的實現。2.校驗邏輯的實現。比如我們需要一個校驗字段狀態的註解，我們可以使用以下示例定義一個註解：

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = StatusValidator.class)
@Documented
public @interface ValidStatus {
    String message() default "狀態錯誤 ";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    /**
     * 有效的狀態值集合，默認{1,2}
     */
    int[] value() default {1,2};
}

實現了註解之後，我們需要實現註解中的@Constraint(validatedBy = StatusValidator.class)，示例代碼如下：

/**
 * 校驗狀態是否屬於指定狀態集
 (ConstraintValidator後指定的泛型對象類型為
 註解類和註解注釋的字段類型<ValidStatus, Integer>)
 */
public class StatusValidator implements ConstraintValidator<ValidStatus, Integer> {
    private Integer[] validStatus;

    @Override
    public void initialize(ValidStatus validStatus) {
        int[] ints = validStatus.value();
        int n = ints.length;
        Integer[] integers = new Integer[n];
        for (int i = 0; i < n; i++) {
            integers[i] = ints[i];
        }
        this.validStatus = integers;
    }

    @Override
    public boolean isValid(Integer n, ConstraintValidatorContext constraintValidatorContext) {
        List<Integer> status = Arrays.asList(validStatus);
        if (status.contains(n)) {
            return true;
        }
        return false;
    }
}

Validator的特性

四種約束級別

成員變量級別的約束

約束可以通過註解一個類的成員變量來表達。如下代碼所示：

@Data
public class Person {

    @NotBlank
    @Size(max=64)
    private String name;

    @Min(0)
    @Max(200)
    private int age;
}

屬性約束

如果你的模型類遵循javabean的標準，它也可能註解這個bean的屬性而不是它的成員變量。關於JavaBean的介紹可以看我的另外一篇博客。

@Data
public class Person {

    private String name;

    @Min(0)
    @Max(200)
    private int age;

    @NotBlank
    @Size(max=64)
    public String getName(){
        return name;
    }
}

集合約束

通過在約束註解的@Target註解在約束定義中指定ElementType.TYPE_USE，就可以實現對容器內元素進行約束

類級別約束

一個約束被放到類級別上，在這種情況下，被驗證的對象不是簡單的一個屬性，而是一個完整的對象。使用類級別約束，可以驗證對象幾個屬性之間的相關性，比如不允許所有字段同時為null等。

@Data
@NotAllFieldNull
public class Person {

    private String name;

    @Min(0)
    @Max(200)
    private int age;

    @NotBlank
    @Size(max=64)
    public String getName(){
        return name;
    }
}

校驗註解的可繼承性

父類中添加了約束的字段，子類在進行校驗時也會校驗父類中的字段。

遞歸校驗

假設我們上面例子中的Person多了一個Address類型的字段，並且Address也有自己的校驗，我們怎麼校驗Address中的字段呢？可以通過在Address上添加@Valid註解實現遞歸校驗。

@Data
public class Person {

    private String name;

    @Min(0)
    @Max(200)
    private int age;

    @Valid
    public Address address;
}

@Data
public class Address{

    @NotNull
    private string city;
}

方法參數校驗

我們可以通過在方法參數中添加校驗註解，實現方法級別的參數校驗，當然這些註解的生效需要通過一些AOP實現（比如Spring的方法參數校驗）。

public void createPerson(@NotNull String name,@NotNull Integer age){

}

方法參數交叉校驗

方法也支持參數之間的校驗，比如如下注解不允許創建用戶時候用戶名和年齡同時為空，註解校驗邏輯需要自己實現。交叉校驗的參數是Object[]類型，不同參數位置對應不同的Obj。

@NotAllPersonFieldNull
public void createPerson( String name,Integer age){

}

方法返回值校驗

public @NotNull Person getPerson( String name,Integer age){
    return null;
}

分組功能

我在另一篇介紹Spring校驗註解的文章中說過，在Spring的校驗體系中，@Valid註解不支持分組校驗，@Validated註解支持分組校驗。 事實上這並不是JSR註解中的@Valid不支持分組校驗，而是Spring層面把@Valid註解的分組校驗功能屏蔽了。

所以原生的JSR註解和Hibernate校驗都支持分組校驗功能，具體校驗邏輯可以參考我有關Spring數據校驗的文章。

分組繼承

我們知道JSR分組校驗功能是使用註解中的group字段，group字段存儲了分組的類別，那麼如果分組的類之間有繼承關係，分組校驗會被繼承嗎？答案是會的。

分組順序

如果我們在校驗的過程中需要指定校驗順序，那麼我們可以給校驗條件分組，分組之後就會按照順序校驗對象中的各個屬性。

GroupSequence({ Default.class, BaseCheck.class, AdvanceCheck.class })
public interface OrderedChecks {
}

Payload

如果我們需要在不同的情況下有不同的校驗方式，比如中英文環境之類的，這種時候用分組就不是很合適了，可以考慮使用PayLoad。用戶可以在初始化Validator時候指定當前環境的payload，然後在校驗環節拿到環境中的payload走不同的校驗流程：

ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
        .configure()
        .constraintValidatorPayload( "US" )
        .buildValidatorFactory();

Validator validator = validatorFactory.getValidator();

public class ZipCodeValidator implements ConstraintValidator<ZipCode, String> {

    public String countryCode;

    @Override
    public boolean isValid(String object, ConstraintValidatorContext constraintContext) {
        if ( object == null ) {
            return true;
        }

        boolean isValid = false;

        String countryCode = constraintContext
                .unwrap( HibernateConstraintValidatorContext.class )
                .getConstraintValidatorPayload( String.class );

        if ( "US".equals( countryCode ) ) {
            // checks specific to the United States
        }
        else if ( "FR".equals( countryCode ) ) {
            // checks specific to France
        }
        else {
            // ...
        }

        return isValid;
    }
}

我是御狐神，歡迎大家關注我的微信公眾號:wzm2zsd

本文最先發佈至微信公眾號，版權所有，禁止轉載！