Java Bean Validation

Spring 框架提供了对 Java Bean Validation API 的支持。

Bean Validation 概述

Bean Validation 通过约束声明和元数据为 Java 应用程序提供了一种通用的验证方式。要使用它，您需要使用声明式验证约束来注解领域模型属性，这些约束随后由运行时强制执行。有内置约束，您也可以定义自己的自定义约束。

考虑以下示例，它展示了一个带有两个属性的简单 PersonForm 模型：

  • Java

  • Kotlin

public class PersonForm {
	private String name;
	private int age;
}
class PersonForm(
		private val name: String,
		private val age: Int
)

Bean Validation 允许您声明约束，如以下示例所示：

  • Java

  • Kotlin

public class PersonForm {

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

	@Min(0)
	private int age;
}
class PersonForm(
	@get:NotNull @get:Size(max=64)
	private val name: String,
	@get:Min(0)
	private val age: Int
)

然后，Bean Validation 验证器根据声明的约束验证此类的实例。有关 API 的一般信息，请参阅 Bean Validation。有关特定约束，请参阅 Hibernate Validator 文档。要了解如何将 bean 验证提供程序设置为 Spring bean，请继续阅读。

配置 Bean Validation 提供程序

Spring 为 Bean Validation API 提供全面支持，包括将 Bean Validation 提供程序作为 Spring bean 引导。这使您可以在应用程序中需要验证的任何地方注入 jakarta.validation.ValidatorFactory 或 jakarta.validation.Validator。

您可以使用 LocalValidatorFactoryBean 将默认的 Validator 配置为 Spring bean，如以下示例所示：

  • Java

  • XML

import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;

@Configuration
public class AppConfig {

	@Bean
	public LocalValidatorFactoryBean validator() {
		return new LocalValidatorFactoryBean();
	}
}
<bean id="validator"
	class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"/>

上例中的基本配置通过使用其默认引导机制触发 bean 验证初始化。预计 Bean Validation 提供程序（例如 Hibernate Validator）将存在于类路径中并自动检测到。

注入 Jakarta Validator

LocalValidatorFactoryBean 实现了 jakarta.validation.ValidatorFactory 和 jakarta.validation.Validator，因此如果您喜欢直接使用 Bean Validation API，可以注入对后者的引用以应用验证逻辑，如以下示例所示：

  • Java

  • Kotlin

import jakarta.validation.Validator;

@Service
public class MyService {

	@Autowired
	private Validator validator;
}
import jakarta.validation.Validator;

@Service
class MyService(@Autowired private val validator: Validator)

注入 Spring Validator

除了实现 jakarta.validation.Validator 之外，LocalValidatorFactoryBean 还适配了 org.springframework.validation.Validator，因此如果您的 bean 需要 Spring Validation API，您可以注入对后者的引用。

例如：

  • Java

  • Kotlin

import org.springframework.validation.Validator;

@Service
public class MyService {

	@Autowired
	private Validator validator;
}
import org.springframework.validation.Validator

@Service
class MyService(@Autowired private val validator: Validator)

当用作 org.springframework.validation.Validator 时，LocalValidatorFactoryBean 会调用底层的 jakarta.validation.Validator，然后将 ConstraintViolation 适配为 FieldError，并将它们注册到传递给 validate 方法的 Errors 对象中。

配置自定义约束

每个 bean 验证约束都包含两部分：

  • 一个 @Constraint 注解，声明约束及其可配置属性。

  • jakarta.validation.ConstraintValidator 接口的一个实现，实现约束的行为。

为了将声明与实现关联起来，每个 @Constraint 注解都引用一个相应的 ConstraintValidator 实现类。在运行时，当在您的领域模型中遇到约束注解时，ConstraintValidatorFactory 会实例化引用的实现。

默认情况下，LocalValidatorFactoryBean 配置了一个 SpringConstraintValidatorFactory，它使用 Spring 创建 ConstraintValidator 实例。这使得您的自定义 ConstraintValidator 能够像任何其他 Spring bean 一样从依赖注入中受益。

以下示例显示了一个自定义 @Constraint 声明，后跟一个关联的 ConstraintValidator 实现，该实现使用 Spring 进行依赖注入：

  • Java

  • Kotlin

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=MyConstraintValidator.class)
public @interface MyConstraint {
}
@Target(AnnotationTarget.FUNCTION, AnnotationTarget.FIELD)
@Retention(AnnotationRetention.RUNTIME)
@Constraint(validatedBy = MyConstraintValidator::class)
annotation class MyConstraint

  • Java

  • Kotlin

import jakarta.validation.ConstraintValidator;

public class MyConstraintValidator implements ConstraintValidator {

	@Autowired;
	private Foo aDependency;

	// ...
}
import jakarta.validation.ConstraintValidator

class MyConstraintValidator(private val aDependency: Foo) : ConstraintValidator {

	// ...
}

如上例所示，ConstraintValidator 实现可以像任何其他 Spring bean 一样 @Autowired 注入其依赖项。

Spring 驱动的方法验证

您可以通过 MethodValidationPostProcessor bean 定义将 Bean Validation 的方法验证功能集成到 Spring 上下文中：

为了符合 Spring 驱动的方法验证条件，目标类需要使用 Spring 的 @Validated 注解进行注解，该注解还可以选择声明要使用的验证组。有关 Hibernate Validator 和 Bean Validation 提供程序的设置详细信息，请参阅 MethodValidationPostProcessor。

方法验证依赖于目标类周围的 AOP 代理，无论是接口方法上的 JDK 动态代理还是 CGLIB 代理。使用代理存在某些限制，其中一些在 理解 AOP 代理 中进行了描述。此外，请记住始终在代理类上使用方法和访问器；直接字段访问将不起作用。

Spring MVC 和 WebFlux 对相同的基础方法验证有内置支持，但不需要 AOP。因此，请检查本节的其余部分，并参阅 Spring MVC 验证 和 错误响应 部分，以及 WebFlux 验证 和 错误响应 部分。

方法验证异常

默认情况下，jakarta.validation.ConstraintViolationException 会抛出 jakarta.validation.Validator 返回的 ConstraintViolation 集合。作为替代方案，您可以抛出 MethodValidationException，其中 ConstraintViolation 已适配为 MessageSourceResolvable 错误。要启用此功能，请设置以下标志：

MethodValidationException 包含一个 ParameterValidationResult 列表，该列表按方法参数对错误进行分组，并且每个都公开一个 MethodParameter、参数值以及从 ConstraintViolation 适配的 MessageSourceResolvable 错误列表。对于带有字段和属性级联违规的 @Valid 方法参数，ParameterValidationResult 是 ParameterErrors，它实现了 org.springframework.validation.Errors 并将验证错误公开为 FieldError。

自定义验证错误

适配的 MessageSourceResolvable 错误可以通过配置的 MessageSource 和特定于区域设置和语言的资源包转换为向用户显示错误消息。本节提供一个示例进行说明。

给定以下类声明：

  • Java

  • Kotlin

record Person(@Size(min = 1, max = 10) String name) {
}

@Validated
public class MyService {

	void addStudent(@Valid Person person, @Max(2) int degrees) {
		// ...
	}
}
@JvmRecord
internal data class Person(@Size(min = 1, max = 10) val name: String)

@Validated
class MyService {

	fun addStudent(person: @Valid Person?, degrees: @Max(2) Int) {
		// ...
	}
}

Person.name() 上的 ConstraintViolation 被适配为 FieldError，包含以下内容：

  • 错误代码 "Size.person.name"、"Size.name"、"Size.java.lang.String" 和 "Size"

  • 消息参数 "name"、10 和 1（字段名和约束属性）

  • 默认消息 "size must be between 1 and 10"

要自定义默认消息，您可以将属性添加到 MessageSource 资源包中，使用上述任何错误代码和消息参数。另请注意，消息参数 "name" 本身是一个 MessageSourceResolvable，其错误代码为 "person.name" 和 "name"，也可以自定义。例如：

Properties
Size.person.name=Please, provide a {0} that is between {2} and {1} characters long
person.name=username

degrees 方法参数上的 ConstraintViolation 被适配为 MessageSourceResolvable，包含以下内容：

  • 错误代码 "Max.myService#addStudent.degrees"、"Max.degrees"、"Max.int"、"Max"

  • 消息参数 "degrees" 和 2（字段名和约束属性）

  • 默认消息 "must be less than or equal to 2"

要自定义上述默认消息，您可以添加一个属性，例如：

Properties
Max.degrees=You cannot provide more than {1} {0}

其他配置选项

默认的 LocalValidatorFactoryBean 配置足以满足大多数情况。对于各种 Bean Validation 构造，从消息插值到遍历解析，都有许多配置选项。有关这些选项的更多信息，请参阅 LocalValidatorFactoryBean javadoc。

配置 DataBinder

您可以为 DataBinder 实例配置 Validator。配置后，您可以通过调用 binder.validate() 来调用 Validator。任何验证 Errors 都会自动添加到绑定器的 BindingResult 中。

以下示例展示了如何以编程方式使用 DataBinder 在绑定到目标对象后调用验证逻辑：

  • Java

  • Kotlin

Foo target = new Foo();
DataBinder binder = new DataBinder(target);
binder.setValidator(new FooValidator());

// bind to the target object
binder.bind(propertyValues);

// validate the target object
binder.validate();

// get BindingResult that includes any validation errors
BindingResult results = binder.getBindingResult();
val target = Foo()
val binder = DataBinder(target)
binder.validator = FooValidator()

// bind to the target object
binder.bind(propertyValues)

// validate the target object
binder.validate()

// get BindingResult that includes any validation errors
val results = binder.bindingResult

您还可以通过 dataBinder.addValidators 和 dataBinder.replaceValidators 为 DataBinder 配置多个 Validator 实例。当将全局配置的 bean 验证与在 DataBinder 实例上本地配置的 Spring Validator 结合使用时，这非常有用。请参阅 Spring MVC 验证配置。

Spring MVC 验证

请参阅 Spring MVC 章中的 验证。