Java Bean 验证 (Java Bean Validation) _ Spring Framework 6.0.23-SNAPSHOT 中文文档(官方文档中文翻译) —

此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Framework 6.1.10！Spring中文文档

Spring Framework 提供了对 Java Bean 验证 API 的支持。Spring中文文档

Bean 验证概述

Bean Validation 通过约束声明和 Java 应用程序的元数据。要使用它，您可以使用声明性验证约束，然后由运行时强制执行。有内置约束，您还可以定义自己的自定义约束。Spring中文文档

请考虑以下示例，该示例显示了一个具有两个属性的简单模型：PersonFormSpring中文文档

JavaSpring中文文档
KotlinSpring中文文档

public class PersonForm {
	private String name;
	private int age;
}

class PersonForm(
		private val name: String,
		private val age: Int
)

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

JavaSpring中文文档
KotlinSpring中文文档

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 验证器根据声明的约束。请参阅 Bean Validation 以获取有关 API。请参阅 Hibernate Validator 文档特定约束。了解如何将 Bean 验证提供程序设置为 Spring 豆子，继续阅读。Spring中文文档

配置 Bean 验证提供程序

Spring 提供了对 Bean 验证 API 的完全支持，包括 Bean Validation 提供程序作为 Spring Bean。这允许您注入 or where 验证是您的应用程序中需要的。jakarta.validation.ValidatorFactoryjakarta.validation.ValidatorSpring中文文档

您可以使用将默认验证器配置为 Spring bean，如以下示例所示：LocalValidatorFactoryBeanSpring中文文档

JavaSpring中文文档
XMLSpring中文文档

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 验证提供程序，例如 Hibernate 验证者，应存在于类路径中，并被自动检测。Spring中文文档

注入验证器

LocalValidatorFactoryBean实现和，以及 Spring 的 . 您可以将对其中任一接口的引用注入到需要调用的 Bean 中验证逻辑。jakarta.validation.ValidatorFactoryjakarta.validation.Validatororg.springframework.validation.ValidatorSpring中文文档

您可以注入对是否喜欢使用 Bean 的引用直接验证 API，如以下示例所示：jakarta.validation.ValidatorSpring中文文档

JavaSpring中文文档
KotlinSpring中文文档

import jakarta.validation.Validator;

@Service
public class MyService {

	@Autowired
	private Validator validator;
}

import jakarta.validation.Validator;

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

你可以注入一个引用，如果你的 bean 需要 Spring Validation API，如以下示例所示：org.springframework.validation.ValidatorSpring中文文档

JavaSpring中文文档
KotlinSpring中文文档

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)

配置自定义约束

每个 Bean 验证约束由两部分组成：Spring中文文档

声明约束及其可配置属性的批注。@ConstraintSpring中文文档
实现的接口的实现约束的行为。jakarta.validation.ConstraintValidatorSpring中文文档

若要将声明与实现相关联，每个批注引用相应的实现类。在运行时，当在域模型中会遇到约束注释。@ConstraintConstraintValidatorConstraintValidatorFactorySpring中文文档

默认情况下，配置一个使用 Spring 创建实例的实例。这让您的自定义对象像任何其他 Spring Bean 一样从依赖注入中受益。LocalValidatorFactoryBeanSpringConstraintValidatorFactoryConstraintValidatorConstraintValidatorsSpring中文文档

下面的示例显示了一个自定义声明，后跟一个使用 Spring 进行依赖项注入的关联实现：@ConstraintConstraintValidatorSpring中文文档

JavaSpring中文文档
KotlinSpring中文文档

@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

JavaSpring中文文档
KotlinSpring中文文档

import jakarta.validation.ConstraintValidator;

public class MyConstraintValidator implements ConstraintValidator {

	@Autowired;
	private Foo aDependency;

	// ...
}

import jakarta.validation.ConstraintValidator

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

	// ...
}

如前面的示例所示，实现可以像任何其他 Spring Bean 一样具有依赖关系。ConstraintValidator@AutowiredSpring中文文档

弹簧驱动方法验证

您可以集成 Bean Validation 1.1 支持的方法验证功能（并且，作为一个自定义扩展，也由 Hibernate Validator 4.3）通过 Bean 定义进入 Spring 上下文：MethodValidationPostProcessorSpring中文文档

JavaSpring中文文档
XMLSpring中文文档

import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;

@Configuration
public class AppConfig {

	@Bean
	public MethodValidationPostProcessor validationPostProcessor() {
		return new MethodValidationPostProcessor();
	}
}

<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>

要获得 Spring 驱动的方法验证资格，需要对所有目标类进行注释带有 Spring 的注解，也可以选择性地声明验证要使用的组。请参阅 MethodValidationPostProcessor，了解 Hibernate Validator 和 Bean Validation 1.1 提供程序的设置详细信息。@ValidatedSpring中文文档

方法验证依赖于围绕目标类，接口上方法的 JDK 动态代理或 CGLIB 代理。使用代理存在某些限制，了解 AOP 代理中介绍了其中一些限制。另外，请记住始终在代理类上使用方法和访问器;直接字段访问将不起作用。Spring中文文档

其他配置选项

默认配置对大多数人来说就足够了例。有许多配置选项可用于各种 Bean 验证构造，从消息插值到遍历解析。有关这些选项的更多信息，请参阅 LocalValidatorFactoryBean javadoc。LocalValidatorFactoryBeanSpring中文文档

配置`DataBinder`

您可以使用 .配置完成后，您可以调用 by 调用 .任何验证都是自动添加到活页夹的 .DataBinderValidatorValidatorbinder.validate()ErrorsBindingResultSpring中文文档

下面的示例演示如何以编程方式使用绑定到目标对象后的逻辑：DataBinderSpring中文文档

JavaSpring中文文档
KotlinSpring中文文档

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

您还可以通过和配置具有多个实例的 a。这在以下情况下很有用将全局配置的 Bean 验证与配置的 Spring 相结合在 DataBinder 实例上本地。请参阅 Spring MVC 验证配置。DataBinderValidatordataBinder.addValidatorsdataBinder.replaceValidatorsValidatorSpring中文文档

Spring MVC 3 验证

请参阅 Spring MVC 一章中的验证。Spring中文文档

Bean 验证概述

配置 Bean 验证提供程序

注入验证器

配置自定义约束

弹簧驱动方法验证

其他配置选项

配置DataBinder

Spring MVC 3 验证

配置`DataBinder`