Data Binding

数据绑定对于将用户输入绑定到目标对象很有用,其中用户输入是包含属性路径作为密钥的映射,遵循 [JavaBeans 约定,beans-beans-conventions]DataBinder 是支持此功能的主要类,它提供两种绑定用户输入的方法:

  • Constructor binding - 将用户输入绑定到公共数据构造函数,在用户输入中查找构造函数参数值。

  • Property binding - 将用户输入绑定到 setter,将用户输入中的键与目标对象结构的属性匹配。

可以应用构造函数和属性绑定,也可以仅应用其中一种绑定。

Constructor Binding

要使用构造函数绑定:

  1. 使用 null 作为目标对象创建 DataBinder

  2. targetType 设置为目标类。

  3. Call construct.

目标类应该具有一个公共构造函数或一个具有参数的非公共构造函数。如果有多个构造函数,则在存在的情况下使用默认构造函数。

默认情况下,参数值是通过构造函数参数名称查找的。如果存在,Spring MVC 和 WebFlux 通过构造函数参数或字段上的 @BindParam 注解支持自定义名称映射。如有必要,还可以在 DataBinder 上配置 NameResolver,以自定义要使用的参数名称。

根据需要应用 [类型转换,beans-beans-conventions] 来转换用户输入。如果构造函数参数是对象,则以相同方式递归构造它,但通过嵌套属性路径。这意味着构造函数绑定既创建目标对象又创建其包含的任何对象。

构造函数绑定支持`List`、Map`和数组参数,这些参数从单个字符串(例如,逗号分隔的列表)转换而来,或者基于索引键(例如`accounts[2].name`或`account[KEY].name)。

绑定和转换错误在 DataBinderBindingResult 中反映出来。如果成功创建目标,则在调用 construct 之后将 target 设置为创建的实例。

Property Binding with BeanWrapper

`org.springframework.beans`包遵守 JavaBeans 标准。JavaBean 是一个类,它有一个默认的无参数构造函数,并遵循一个命名约定,其中(例如)名为`bingoMadness`的属性将有一个名为`setBingoMadness(..)`的 setter 方法和一个名为`getBingoMadness()`的 getter 方法。有关 JavaBeans 和规范的更多信息,请参见https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/beans/package-summary.html[javabeans]。

beans 包中一个非常重要的类是 BeanWrapper 接口及其对应实现 (BeanWrapperImpl)。正如 javadoc 中所述,BeanWrapper 提供了设置和获取属性值(单个或批量)、获取属性描述符以及查询属性以确定它们是否可读或可写。此外,BeanWrapper 还支持嵌套属性,使属性设置能够设置无限深度的子属性。BeanWrapper 还支持添加标准 JavaBean PropertyChangeListenersVetoableChangeListeners,而无需在目标类中提供支持代码。最后但并非最不重要的一点是,BeanWrapper 提供了设置索引属性的支持。通常不由应用程序代码直接使用 BeanWrapper,而由 DataBinderBeanFactory 使用。

BeanWrapper 的工作方式部分由其名称指示:它包装一个 Bean 以对该 Bean 执行操作,例如设置和检索属性。

Setting and Getting Basic and Nested Properties

设置和获取属性是通过 BeanWrappersetPropertyValuegetPropertyValue 重载方法变体完成的。有关详细信息,请参见其 Javadoc。下表显示了这些约定的示例:

Table 1. Examples of properties
Expression Explanation

name

指代与或 getName()/isName()setName(..) 方法对应的属性 name

account.name

指代属性 account 的嵌套属性 name,它对应于(例如)方法 getAccount().setName()getAccount().getName()

accounts[2]

指代索引属性 accountthird 元素。索引属性可以是类型 array, list 或其他自然排序的集合。

accounts[KEY]

指代由 KEY 值索引的地图条目的值。

(如果您不打算直接使用 BeanWrapper,那么本节对您来说并不重要。如果你只使用 DataBinderBeanFactory 以及它们的默认实现,你应该跳到 xref:core/validation/beans-beans.adoc#beans-beans-conversion[section on PropertyEditors。)

以下两个示例类使用 BeanWrapper 获取和设置属性:

  • Java

  • Kotlin

public class Company {

	private String name;
	private Employee managingDirector;

	public String getName() {
		return this.name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Employee getManagingDirector() {
		return this.managingDirector;
	}

	public void setManagingDirector(Employee managingDirector) {
		this.managingDirector = managingDirector;
	}
}
class Company {
	var name: String? = null
	var managingDirector: Employee? = null
}
  • Java

  • Kotlin

public class Employee {

	private String name;

	private float salary;

	public String getName() {
		return this.name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public float getSalary() {
		return salary;
	}

	public void setSalary(float salary) {
		this.salary = salary;
	}
}
class Employee {
	var name: String? = null
	var salary: Float? = null
}

以下代码段展示了一些有关如何检索和操作实例化的 CompanyEmployee 的属性的示例:

  • Java

  • Kotlin

BeanWrapper company = new BeanWrapperImpl(new Company());
// setting the company name..
company.setPropertyValue("name", "Some Company Inc.");
// ... can also be done like this:
PropertyValue value = new PropertyValue("name", "Some Company Inc.");
company.setPropertyValue(value);

// ok, let's create the director and tie it to the company:
BeanWrapper jim = new BeanWrapperImpl(new Employee());
jim.setPropertyValue("name", "Jim Stravinsky");
company.setPropertyValue("managingDirector", jim.getWrappedInstance());

// retrieving the salary of the managingDirector through the company
Float salary = (Float) company.getPropertyValue("managingDirector.salary");
val company = BeanWrapperImpl(Company())
// setting the company name..
company.setPropertyValue("name", "Some Company Inc.")
// ... can also be done like this:
val value = PropertyValue("name", "Some Company Inc.")
company.setPropertyValue(value)

// ok, let's create the director and tie it to the company:
val jim = BeanWrapperImpl(Employee())
jim.setPropertyValue("name", "Jim Stravinsky")
company.setPropertyValue("managingDirector", jim.wrappedInstance)

// retrieving the salary of the managingDirector through the company
val salary = company.getPropertyValue("managingDirector.salary") as Float?

`PropertyEditor’s

Spring 使用`PropertyEditor`的概念来实现`Object`和`String`之间的转换。用一种与对象自身不同的方式表示属性可能会很方便。例如,一个`Date`可以用一种人类可读的方式来表示(像`String`一样:‘2007-14-09'),同时我们仍然可以将人类可读的形式转换为原始日期(或者,更好的是,可以将以人类可读的形式输入的任何日期转换为`Date`对象)。可以通过注册类型为`java.beans.PropertyEditor`的自定义编辑器来实现此行为。在`BeanWrapper`中注册自定义编辑器,或在特定的 IoC 容器中(如前一章中所述),可以使它了解如何将属性转换为所需的类型。有关`PropertyEditor`的更多信息,请参见https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/beans/package-summary.html[Oracle 中`java.beans`包的 javadoc]。

Spring 中使用属性编辑功能的一些示例:

  • 通过使用 PropertyEditor 实现设置 bean 上的属性,当您将 String 用作在 XML 文件中声明的某个 bean 的属性值时,Spring(如果相应属性的 setter 具有 Class`参数)将使用 `ClassEditor 尝试将该参数解析到 Class 对象。

  • 在 Spring 的 MVC 框架中解析 HTTP 请求参数是通过使用所有类型的 PropertyEditor 实现完成的,您可以在 `CommandController`的所有子类中手动绑定这些实现。

Spring 提供了大量内置的 PropertyEditor 实现来简化生活。它们都位于 org.springframework.beans.propertyeditors 包中。大多数(但并非全部,如下表所示)默认情况下均由 BeanWrapperImpl 注册。在某些方面可以配置属性编辑器的情况下,你仍可以注册自己的变体来覆盖默认变体。下表描述了 Spring 提供的各种 PropertyEditor 实现:

Table 2. Built-in PropertyEditor Implementations
Class Explanation

ByteArrayPropertyEditor

字节数组编辑器。将字符串转换成它们相应的字节表示。由 BeanWrapperImpl 默认注册。

ClassEditor

将表示类的字符串解析为实际类,反之亦然。如果未找到类,就会抛出一个 IllegalArgumentException。默认情况下,由 BeanWrapperImpl 注册。

CustomBooleanEditor

Boolean 属性的可自定义属性编辑器。默认情况下,由 BeanWrapperImpl 注册,但可以覆盖它成为自定义编辑器的自定义实例。

CustomCollectionEditor

集合属性编辑器,将任何源 Collection 转换成给定的目标 Collection 类型。

CustomDateEditor

java.util.Date 的可自定义属性编辑器,支持自定义 DateFormat。默认情况下未注册。必须根据需要以适当的格式由用户注册。

CustomNumberEditor

任何 Number 子类的可自定义属性编辑器,例如 Integer, Long, FloatDouble。默认情况下,由 BeanWrapperImpl 注册,但可以覆盖它成为自定义编辑器的自定义实例。

FileEditor

将字符串解析为 java.io.File 对象。默认情况下,由 BeanWrapperImpl 注册。

InputStreamEditor

一个单向属性编辑器,它可以采用一个字符串并生成(通过一个中间 ResourceEditorResource)一个 InputStream,以便 InputStream 属性可以直接设置成字符串。注意,默认用法不会关闭 InputStream。默认情况下,由 BeanWrapperImpl 注册。

LocaleEditor

可以将字符串解析 Locale`对象,反之亦然(字符串格式为 `[country][variant],与 `Locale`的 `toString()`方法相同)。也可以接受空格作为分隔符,而不是下划线。默认情况下,由 `BeanWrapperImpl`注册。

PatternEditor

能够将字符串解析为 java.util.regex.Pattern 对象,反之亦然。

PropertiesEditor

能够将字符串(格式为 java.util.Properties 类 javadoc 中定义的格式)转换为 Properties 对象。默认情况下,由 BeanWrapperImpl 注册。

StringTrimmerEditor

修剪字符串的属性编辑器。可选地允许将空字符串转换为 null 值。默认情况下未注册——必须由用户注册。

URLEditor

能够将 URL 的字符串表示形式解析为一个实际的 URL 对象。默认情况下,由 BeanWrapperImpl 注册。

Spring 使用 java.beans.PropertyEditorManager 来设置可能需要的属性编辑器的搜索路径。搜索路径还包括 sun.bean.editors,其中包含类型如 FontColor 和大多数原始类型这样的 PropertyEditor 实现。还需要注意的是,标准 JavaBean 基础设施如果在与其处理的类位于同一包中且具有相同名称(使用添加的 Editor)的情况下会自动发现 PropertyEditor 类(无需明确注册它们)。例如,可以有以下类和包结构,这将足以使 SomethingEditor 类被识别并用作 Something 类型属性的 PropertyEditor

com chank pop Something SomethingEditor // the PropertyEditor for the Something class

请注意,您还可以在此处使用标准`BeanInfo`JavaBeans 机制(某种程度上已在此处https://docs.oracle.com/javase/tutorial/javabeans/advanced/customization.html[描述])。以下示例使用`BeanInfo`机制将一个或多个`PropertyEditor`实例显式地注册到关联类的属性中:

com chank pop Something SomethingBeanInfo // the BeanInfo for the Something class

引用 SomethingBeanInfo 类的以下 Java 源代码将 CustomNumberEditorSomething 类的 age 属性相关联:

  • Java

  • Kotlin

public class SomethingBeanInfo extends SimpleBeanInfo {

	public PropertyDescriptor[] getPropertyDescriptors() {
		try {
			final PropertyEditor numberPE = new CustomNumberEditor(Integer.class, true);
			PropertyDescriptor ageDescriptor = new PropertyDescriptor("age", Something.class) {
				@Override
				public PropertyEditor createPropertyEditor(Object bean) {
					return numberPE;
				}
			};
			return new PropertyDescriptor[] { ageDescriptor };
		}
		catch (IntrospectionException ex) {
			throw new Error(ex.toString());
		}
	}
}
class SomethingBeanInfo : SimpleBeanInfo() {

	override fun getPropertyDescriptors(): Array<PropertyDescriptor> {
		try {
			val numberPE = CustomNumberEditor(Int::class.java, true)
			val ageDescriptor = object : PropertyDescriptor("age", Something::class.java) {
				override fun createPropertyEditor(bean: Any): PropertyEditor {
					return numberPE
				}
			}
			return arrayOf(ageDescriptor)
		} catch (ex: IntrospectionException) {
			throw Error(ex.toString())
		}

	}
}

Custom `PropertyEditor’s

在将 bean 属性设为字符串值时,Spring IoC 容器最终使用标准 JavaBean PropertyEditor 实现将这些字符串转换为属性的复杂类型。Spring 预先注册了大量自定义 PropertyEditor 实现(例如,将表示为字符串的类名转换为 Class 对象)。此外,Java 的标准 JavaBean PropertyEditor 查找机制允许对类的 PropertyEditor 适当命名并将其放置在与它提供支持的类的同一包中,以便可以自动找到它。

如果需要注册其他自定义 PropertyEditors,则可以采用几种机制。最手动的(通常不方便又不推荐)的方法是使用 ConfigurableBeanFactory 接口的 registerCustomEditor() 方法,假设你具有 BeanFactory 引用。另一种(稍微方便一些)的方法是使用称为 CustomEditorConfigurer 的特殊 bean 工厂后处理器。虽然你可以将 bean 工厂后处理器与 BeanFactory 实现配合使用,但 CustomEditorConfigurer 有一个嵌套的属性设置,因此我们强烈建议你将其与 ApplicationContext 一起使用,你可以在其中以类似于任何其他 bean 的方式部署它,并且可以在其中自动检测并应用它。

请注意,所有 Bean 工厂和应用程序上下文都通过使用 BeanWrapper 来处理属性转换,从而自动使用许多内置的属性编辑器。BeanWrapper 注册的标准属性编辑器列在 previous section 中。此外,ApplicationContext 还将覆盖或添加其他编辑器,以便以适合特定应用程序上下文类型的方式处理资源查找。

标准的 JavaBean PropertyEditor 实例用于将表示为字符串的属性值转换为属性的实际复杂类型。你可以使用 CustomEditorConfigurer,即一个 bean 工厂后处理器,向 ApplicationContext 方便地添加对其他 PropertyEditor 实例的支持。

考虑以下示例,它定义了一个名为 ExoticType 的用户类和另一个名为 DependsOnExoticType 的类,该类需要将 ExoticType 设置为一个属性:

  • Java

  • Kotlin

public class ExoticType {

	private String name;

	public ExoticType(String name) {
		this.name = name;
	}
}

public class DependsOnExoticType {

	private ExoticType type;

	public void setType(ExoticType type) {
		this.type = type;
	}
}
class ExoticType(val name: String)

class DependsOnExoticType {

	var type: ExoticType? = null
}

在正确设置好一切后,我们想能够将类型属性指定为一个字符串,PropertyEditor 会将其转换为一个实际的 ExoticType 实例。以下 bean 定义显示了如何设置此关系:

<bean id="sample" class="example.DependsOnExoticType">
	<property name="type" value="aNameForExoticType"/>
</bean>

PropertyEditor 实现可能看起来如下:

  • Java

  • Kotlin

import java.beans.PropertyEditorSupport;

// converts string representation to ExoticType object
public class ExoticTypeEditor extends PropertyEditorSupport {

	public void setAsText(String text) {
		setValue(new ExoticType(text.toUpperCase()));
	}
}
import java.beans.PropertyEditorSupport

// converts string representation to ExoticType object
class ExoticTypeEditor : PropertyEditorSupport() {

	override fun setAsText(text: String) {
		value = ExoticType(text.toUpperCase())
	}
}

最后,以下示例显示了如何使用 CustomEditorConfigurer 使用新 PropertyEditor 注册 ApplicationContext,然后根据需要使用它:

<bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
	<property name="customEditors">
		<map>
			<entry key="example.ExoticType" value="example.ExoticTypeEditor"/>
		</map>
	</property>
</bean>

PropertyEditorRegistrar

向 Spring 容器注册属性编辑器的另一种机制是创建并使用 PropertyEditorRegistrar。当需要在多个不同情况下使用同一组属性编辑器时,此接口特别有用。你可以编写一个相应的注册器,并将其在每种情况下重复使用。PropertyEditorRegistrar 实例与由 Spring BeanWrapper(和 DataBinder)实现的称为 PropertyEditorRegistry 的接口一起使用。PropertyEditorRegistrar 实例与 CustomEditorConfigurer 配合使用时非常方便(在 here 中已描述),它公开了称为 setPropertyEditorRegistrars(..) 的属性。以这种方式添加到 CustomEditorConfigurer 中的 PropertyEditorRegistrar 实例可以很容易地与 DataBinder 和 Spring MVC 控制器共享。此外,它避免了对自定义编辑器进行同步的需要:PropertyEditorRegistrar 预期为每次 Bean 创建尝试创建新的 PropertyEditor 实例。

以下示例显示了如何创建自己的 PropertyEditorRegistrar 实现:

  • Java

  • Kotlin

public final class CustomPropertyEditorRegistrar implements PropertyEditorRegistrar {

	public void registerCustomEditors(PropertyEditorRegistry registry) {

		// it is expected that new PropertyEditor instances are created
		registry.registerCustomEditor(ExoticType.class, new ExoticTypeEditor());

		// you could register as many custom property editors as are required here...
	}
}
import org.springframework.beans.PropertyEditorRegistrar
import org.springframework.beans.PropertyEditorRegistry

class CustomPropertyEditorRegistrar : PropertyEditorRegistrar {

	override fun registerCustomEditors(registry: PropertyEditorRegistry) {

		// it is expected that new PropertyEditor instances are created
		registry.registerCustomEditor(ExoticType::class.java, ExoticTypeEditor())

		// you could register as many custom property editors as are required here...
	}
}

另请参阅 org.springframework.beans.support.ResourceEditorRegistrar 以获取 PropertyEditorRegistrar 实现的示例。请注意,在 registerCustomEditors(..) 方法的实现中,它是如何为每个属性编辑器创建新实例的。

下一个示例显示了如何配置 CustomEditorConfigurer 并向其中注入我们自己的 CustomPropertyEditorRegistrar 实例:

<bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
	<property name="propertyEditorRegistrars">
		<list>
			<ref bean="customPropertyEditorRegistrar"/>
		</list>
	</property>
</bean>

<bean id="customPropertyEditorRegistrar"
	class="com.foo.editors.spring.CustomPropertyEditorRegistrar"/>

最后(与本章的重点有点背离),对于那些使用 Spring’s MVC web framework 的人来说,将 PropertyEditorRegistrar 与数据绑定 Web 控制器结合使用会非常方便。以下示例在 @InitBinder 方法的实现中使用了 PropertyEditorRegistrar

  • Java

  • Kotlin

@Controller
public class RegisterUserController {

	private final PropertyEditorRegistrar customPropertyEditorRegistrar;

	RegisterUserController(PropertyEditorRegistrar propertyEditorRegistrar) {
		this.customPropertyEditorRegistrar = propertyEditorRegistrar;
	}

	@InitBinder
	void initBinder(WebDataBinder binder) {
		this.customPropertyEditorRegistrar.registerCustomEditors(binder);
	}

	// other methods related to registering a User
}
@Controller
class RegisterUserController(
	private val customPropertyEditorRegistrar: PropertyEditorRegistrar) {

	@InitBinder
	fun initBinder(binder: WebDataBinder) {
		this.customPropertyEditorRegistrar.registerCustomEditors(binder)
	}

	// other methods related to registering a User
}

这种 PropertyEditor 注册样式可以生成简洁的代码(@InitBinder 方法的实现只有一行长),并允许将公共 PropertyEditor 注册代码封装在一个类中,然后在需要时在多个控制器中共享。