Bean Validator

Bean Validator

关于Jakarta EE

2018年03月， Oracle 决定把 JavaEE 移交给开源组织 Eclipse 基金会，并且不再使用Java EE这个名称。

因此javax改名为jakarta

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

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>2.0.1</version>
</dependency>

需要的依赖

<!-- 规范API -->
<dependency>
    <groupId>javax.el</groupId>
    <artifactId>javax.el-api</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- 标准实现，该依赖已经有jakarta.validation-api，无需单独引入了 -->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.5.Final</version>
</dependency>

常用注解

• @AssertFalse - 元素必须为false
• @AssertTrue - 元素必须为true
• @DecimalMax - 元素必须是一个数字，且值必须<=最大值
• @DecimalMin - 元素必须是一个数组，且值必须>=最大值

核心API

• Validation - 校验类，可以获取校验工厂
• ValidatorFactory - 校验工厂
• Validator - 校验器，通过校验工厂获取
• ConstraintViolation - 违反约束，可以获取错误的校验信息，配合Set集合使用
  • getPropertyPath - 属性路径（名称）
  • getMessage - 错误信息
  • getInvalidValue - 无效的值、错误的值

Validator

public interface Validator {
    // 用于校验 Java Bean
    <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups);
    // 校验指定属性
    <T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, Class<?>... groups);
    // 校验value值
    <T> Set<ConstraintViolations<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups);
    // 获取class类型描述信息
    BeanDesctiptor getConstraitsForClass(Class<?> clazz);

}

ConstraintViolation

保存了违反约束的上下文及详细信息

ValidatorContext

校验案例

核心校验接口

Bean Validation使用的校验器是ExecutableValidator，支持对方法和构造方法的校验。

public interface ExecutableValidator {

	// 方法校验：参数+返回值
	<T> Set<ConstraintViolation<T>> validateParameters(T object,
													   Method method,
													   Object[] parameterValues,
													   Class<?>... groups);
	<T> Set<ConstraintViolation<T>> validateReturnValue(T object,
														Method method,
														Object returnValue,
														Class<?>... groups);

	// 构造器校验：参数+返回值
	<T> Set<ConstraintViolation<T>> validateConstructorParameters(Constructor<? extends T> constructor,
																  Object[] parameterValues,
																  Class<?>... groups);
	<T> Set<ConstraintViolation<T>> validateConstructorReturnValue(Constructor<? extends T> constructor,
																   T createdObject,
																   Class<?>... groups);
}

方法参数校验

返回值校验

构造方法校验