XML 模式

本附录部分列出了与核心容器相关的 XML 架构。

`util` 架构

顾名思义，util 标签处理常见的实用程序配置问题，例如配置集合、引用常量等等。要使用 util 架构中的标签，您需要在 Spring XML 配置文件的顶部添加以下前缀（代码段中的文本引用了正确的架构，以便 util 命名空间中的标签对您可用）

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:util="http://www.springframework.org/schema/util"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/util https://www.springframework.org/schema/util/spring-util.xsd">

		<!-- bean definitions here -->

</beans>

使用 `<util:constant/>`

考虑以下 Bean 定义

<bean id="..." class="...">
	<property name="isolation">
		<bean id="java.sql.Connection.TRANSACTION_SERIALIZABLE"
				class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean" />
	</property>
</bean>

前面的配置使用 Spring FactoryBean 实现（FieldRetrievingFactoryBean）将 Bean 上的 isolation 属性的值设置为 java.sql.Connection.TRANSACTION_SERIALIZABLE 常量的值。这很好，但它冗长且（不必要地）将 Spring 的内部机制暴露给最终用户。

以下基于 XML Schema 的版本更加简洁，清晰地表达了开发者的意图（“注入此常量值”），并且可读性更好。

<bean id="..." class="...">
	<property name="isolation">
		<util:constant static-field="java.sql.Connection.TRANSACTION_SERIALIZABLE"/>
	</property>
</bean>

从字段值设置 Bean 属性或构造函数参数

FieldRetrievingFactoryBean 是一个 FactoryBean，它检索 static 或非静态字段值。它通常用于检索 public static final 常量，这些常量随后可用于设置另一个 bean 的属性值或构造函数参数。

以下示例展示了如何使用 staticField 属性来公开 static 字段。

<bean id="myField"
		class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean">
	<property name="staticField" value="java.sql.Connection.TRANSACTION_SERIALIZABLE"/>
</bean>

还有一种方便的用法形式，其中 static 字段被指定为 bean 名称，如下例所示。

<bean id="java.sql.Connection.TRANSACTION_SERIALIZABLE"
		class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean"/>

这意味着不再有任何关于 bean id 的选择（因此任何引用它的其他 bean 也必须使用这个更长的名称），但这种形式非常简洁，并且作为内部 bean 使用起来非常方便，因为不需要为 bean 引用指定 id，如下例所示。

<bean id="..." class="...">
	<property name="isolation">
		<bean id="java.sql.Connection.TRANSACTION_SERIALIZABLE"
				class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean" />
	</property>
</bean>

您还可以访问另一个 bean 的非静态（实例）字段，如 FieldRetrievingFactoryBean 类 API 文档中所述。

将枚举值注入 bean 作为属性或构造函数参数，在 Spring 中很容易实现。您实际上不需要做任何事情，也不需要了解任何 Spring 内部机制（甚至像 FieldRetrievingFactoryBean 这样的类）。以下枚举示例展示了注入枚举值是多么容易。

Java
Kotlin

package jakarta.persistence;

public enum PersistenceContextType {

	TRANSACTION,
	EXTENDED
}

package jakarta.persistence

enum class PersistenceContextType {

	TRANSACTION,
	EXTENDED
}

现在考虑以下类型为 PersistenceContextType 的 setter 和相应的 bean 定义。

Java
Kotlin

package example;

public class Client {

	private PersistenceContextType persistenceContextType;

	public void setPersistenceContextType(PersistenceContextType type) {
		this.persistenceContextType = type;
	}
}

package example

class Client {

	lateinit var persistenceContextType: PersistenceContextType
}

<bean class="example.Client">
	<property name="persistenceContextType" value="TRANSACTION"/>
</bean>

使用 `<util:property-path/>`

考虑以下示例。

<!-- target bean to be referenced by name -->
<bean id="testBean" class="org.springframework.beans.TestBean" scope="prototype">
	<property name="age" value="10"/>
	<property name="spouse">
		<bean class="org.springframework.beans.TestBean">
			<property name="age" value="11"/>
		</bean>
	</property>
</bean>

<!-- results in 10, which is the value of property 'age' of bean 'testBean' -->
<bean id="testBean.age" class="org.springframework.beans.factory.config.PropertyPathFactoryBean"/>

前面的配置使用 Spring 的 FactoryBean 实现（PropertyPathFactoryBean）来创建一个名为 testBean.age 的 bean（类型为 int），其值等于 testBean bean 的 age 属性。

现在考虑以下示例，它添加了一个 <util:property-path/> 元素

<!-- target bean to be referenced by name -->
<bean id="testBean" class="org.springframework.beans.TestBean" scope="prototype">
	<property name="age" value="10"/>
	<property name="spouse">
		<bean class="org.springframework.beans.TestBean">
			<property name="age" value="11"/>
		</bean>
	</property>
</bean>

<!-- results in 10, which is the value of property 'age' of bean 'testBean' -->
<util:property-path id="name" path="testBean.age"/>

<property-path/> 元素的 path 属性的值遵循 beanName.beanProperty 的形式。在本例中，它获取名为 testBean 的 bean 的 age 属性。该 age 属性的值为 10。

使用 `<util:property-path/>` 设置 Bean 属性或构造函数参数

PropertyPathFactoryBean 是一个 FactoryBean，它在给定的目标对象上评估属性路径。目标对象可以直接指定，也可以通过 bean 名称指定。然后，您可以在另一个 bean 定义中使用此值作为属性值或构造函数参数。

以下示例显示了针对另一个 bean（按名称）使用的路径

<!-- target bean to be referenced by name -->
<bean id="person" class="org.springframework.beans.TestBean" scope="prototype">
	<property name="age" value="10"/>
	<property name="spouse">
		<bean class="org.springframework.beans.TestBean">
			<property name="age" value="11"/>
		</bean>
	</property>
</bean>

<!-- results in 11, which is the value of property 'spouse.age' of bean 'person' -->
<bean id="theAge"
		class="org.springframework.beans.factory.config.PropertyPathFactoryBean">
	<property name="targetBeanName" value="person"/>
	<property name="propertyPath" value="spouse.age"/>
</bean>

在以下示例中，路径针对内部 bean 进行评估

<!-- results in 12, which is the value of property 'age' of the inner bean -->
<bean id="theAge"
		class="org.springframework.beans.factory.config.PropertyPathFactoryBean">
	<property name="targetObject">
		<bean class="org.springframework.beans.TestBean">
			<property name="age" value="12"/>
		</bean>
	</property>
	<property name="propertyPath" value="age"/>
</bean>

还有一种快捷形式，其中 bean 名称是属性路径。以下示例显示了快捷形式

<!-- results in 10, which is the value of property 'age' of bean 'person' -->
<bean id="person.age"
		class="org.springframework.beans.factory.config.PropertyPathFactoryBean"/>

此形式确实意味着 bean 的名称没有选择。对它的任何引用也必须使用相同的 id，即路径。如果用作内部 bean，则根本不需要引用它，如下面的示例所示

<bean id="..." class="...">
	<property name="age">
		<bean id="person.age"
				class="org.springframework.beans.factory.config.PropertyPathFactoryBean"/>
	</property>
</bean>

您可以在实际定义中专门设置结果类型。对于大多数用例来说，这不是必需的，但有时可能有用。有关此功能的更多信息，请参见 javadoc。

使用 `<util:properties/>`

考虑以下示例。

<!-- creates a java.util.Properties instance with values loaded from the supplied location -->
<bean id="jdbcConfiguration" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
	<property name="location" value="classpath:com/foo/jdbc-production.properties"/>
</bean>

前面的配置使用 Spring 的 FactoryBean 实现（PropertiesFactoryBean）来实例化一个 java.util.Properties 实例，并使用从提供的 Resource 位置加载的值对其进行初始化。

以下示例使用 util:properties 元素来创建更简洁的表示

<!-- creates a java.util.Properties instance with values loaded from the supplied location -->
<util:properties id="jdbcConfiguration" location="classpath:com/foo/jdbc-production.properties"/>

使用 `<util:list/>`

考虑以下示例。

<!-- creates a java.util.List instance with values loaded from the supplied 'sourceList' -->
<bean id="emails" class="org.springframework.beans.factory.config.ListFactoryBean">
	<property name="sourceList">
		<list>
			<value>[email protected]</value>
			<value>[email protected]</value>
			<value>[email protected]</value>
			<value>[email protected]</value>
		</list>
	</property>
</bean>

前面的配置使用 Spring 的 FactoryBean 实现（ListFactoryBean）来创建一个 java.util.List 实例，并使用从提供的 sourceList 中获取的值对其进行初始化。

以下示例使用 <util:list/> 元素来创建更简洁的表示

<!-- creates a java.util.List instance with the supplied values -->
<util:list id="emails">
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
</util:list>

您也可以通过在 <util:list/> 元素上使用 list-class 属性来显式控制实例化和填充的 List 的确切类型。例如，如果我们确实需要实例化一个 java.util.LinkedList，我们可以使用以下配置

<util:list id="emails" list-class="java.util.LinkedList">
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>d'[email protected]</value>
</util:list>

如果未提供 list-class 属性，容器将选择一个 List 实现。

使用 `<util:map/>`

考虑以下示例。

<!-- creates a java.util.Map instance with values loaded from the supplied 'sourceMap' -->
<bean id="emails" class="org.springframework.beans.factory.config.MapFactoryBean">
	<property name="sourceMap">
		<map>
			<entry key="pechorin" value="[email protected]"/>
			<entry key="raskolnikov" value="[email protected]"/>
			<entry key="stavrogin" value="[email protected]"/>
			<entry key="porfiry" value="[email protected]"/>
		</map>
	</property>
</bean>

前面的配置使用 Spring FactoryBean 实现（MapFactoryBean）来创建一个 java.util.Map 实例，该实例使用从提供的 'sourceMap' 中获取的键值对进行初始化。

以下示例使用 <util:map/> 元素来进行更简洁的表示

<!-- creates a java.util.Map instance with the supplied key-value pairs -->
<util:map id="emails">
	<entry key="pechorin" value="[email protected]"/>
	<entry key="raskolnikov" value="[email protected]"/>
	<entry key="stavrogin" value="[email protected]"/>
	<entry key="porfiry" value="[email protected]"/>
</util:map>

您也可以通过在 <util:map/> 元素上使用 'map-class' 属性来显式控制实例化和填充的 Map 的确切类型。例如，如果我们确实需要实例化一个 java.util.TreeMap，我们可以使用以下配置

<util:map id="emails" map-class="java.util.TreeMap">
	<entry key="pechorin" value="[email protected]"/>
	<entry key="raskolnikov" value="[email protected]"/>
	<entry key="stavrogin" value="[email protected]"/>
	<entry key="porfiry" value="[email protected]"/>
</util:map>

如果未提供 'map-class' 属性，容器将选择一个 Map 实现。

使用 `<util:set/>`

考虑以下示例。

<!-- creates a java.util.Set instance with values loaded from the supplied 'sourceSet' -->
<bean id="emails" class="org.springframework.beans.factory.config.SetFactoryBean">
	<property name="sourceSet">
		<set>
			<value>[email protected]</value>
			<value>[email protected]</value>
			<value>[email protected]</value>
			<value>[email protected]</value>
		</set>
	</property>
</bean>

前面的配置使用 Spring FactoryBean 实现（SetFactoryBean）来创建一个 java.util.Set 实例，该实例使用从提供的 sourceSet 中获取的值进行初始化。

以下示例使用 <util:set/> 元素来进行更简洁的表示

<!-- creates a java.util.Set instance with the supplied values -->
<util:set id="emails">
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
</util:set>

您也可以通过在 <util:set/> 元素上使用 set-class 属性来显式控制实例化和填充的 Set 的确切类型。例如，如果我们确实需要实例化一个 java.util.TreeSet，我们可以使用以下配置

<util:set id="emails" set-class="java.util.TreeSet">
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
	<value>[email protected]</value>
</util:set>

如果未提供 set-class 属性，容器将选择一个 Set 实现。

`aop` 模式

aop 标签用于配置 Spring 中所有与 AOP 相关的内容，包括 Spring 自身的基于代理的 AOP 框架和 Spring 与 AspectJ AOP 框架的集成。这些标签在名为使用 Spring 进行面向切面编程的章节中进行了全面介绍。

为了完整起见，要使用 aop 模式中的标签，您需要在 Spring XML 配置文件的顶部添加以下序言（片段中的文本引用了正确的模式，以便 aop 命名空间中的标签对您可用）

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd">

	<!-- bean definitions here -->

</beans>

`context` 模式

context 标签处理与管道相关的 ApplicationContext 配置，也就是说，通常不是对最终用户重要的 bean，而是执行 Spring 中许多“基础”工作的 bean，例如 BeanfactoryPostProcessors。以下代码片段引用了正确的模式，以便 context 命名空间中的元素可供您使用。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

	<!-- bean definitions here -->

</beans>

使用 `<property-placeholder/>`

此元素激活对 ${…} 占位符的替换，这些占位符将根据指定的属性文件（作为 Spring 资源位置）进行解析。此元素是一种便捷机制，它为您设置了一个 PropertySourcesPlaceholderConfigurer。如果您需要对特定 PropertySourcesPlaceholderConfigurer 设置进行更多控制，您可以自己显式地将其定义为 bean。

对于具有其所需属性的给定应用程序，应仅定义一个这样的元素。只要它们具有不同的占位符语法 (${…})，就可以配置多个属性占位符。

如果您需要模块化用于替换的属性来源，则不应创建多个属性占位符。相反，每个模块都应该向 Environment 贡献一个 PropertySource。或者，您可以创建自己的 PropertySourcesPlaceholderConfigurer bean 来收集要使用的属性。

使用 `<annotation-config/>`

此元素激活 Spring 基础设施以检测 bean 类中的注释

Spring 的 @Configuration 模型
@Autowired/@Inject、@Value 和 @Lookup
JSR-250 的 @Resource、@PostConstruct 和 @PreDestroy（如果可用）
JAX-WS 的 @WebServiceRef 和 EJB 3 的 @EJB（如果可用）
JPA 的 @PersistenceContext 和 @PersistenceUnit（如果可用）
Spring 的 @EventListener

或者，您可以选择显式地激活这些注释的各个 BeanPostProcessors。

此元素不会激活对 Spring 的 @Transactional 注解的处理；您可以使用 <tx:annotation-driven/> 元素来实现此目的。类似地，Spring 的缓存注解也需要显式启用。

使用 `<component-scan/>`

此元素在关于基于注解的容器配置的部分中详细介绍。

使用 `<load-time-weaver/>`

此元素在关于在 Spring 框架中使用 AspectJ 进行加载时编织的部分中详细介绍。

使用 `<spring-configured/>`

此元素在关于使用 AspectJ 对 Spring 注入域对象的部分中详细介绍。

使用 `<mbean-export/>`

此元素在关于配置基于注解的 MBean 导出的部分中详细介绍。

Beans 架构

最后但并非最不重要的一点是，我们有 beans 架构中的元素。这些元素从框架诞生之初就存在于 Spring 中。beans 架构中各种元素的示例在此处未显示，因为它们在依赖项和配置的详细信息（以及实际上，在整个章节）中得到了相当全面的介绍。

请注意，您可以向 <bean/> XML 定义添加零个或多个键值对。对这些额外的元数据执行什么操作（如果有的话）完全取决于您自己的自定义逻辑（因此，通常只有在您编写自己的自定义元素时才有用，如附录中题为 XML 架构创作的部分所述）。

以下示例显示了 <meta/> 元素在周围 <bean/> 的上下文中（请注意，如果没有解释它的任何逻辑，元数据实际上是无用的，因为它本身就存在）。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">

	<bean id="foo" class="x.y.Foo">
		<meta key="cacheName" value="foo"/> (1)
		<property name="name" value="Rick"/>
	</bean>

</beans>

1	这是示例 `meta` 元素

在前面的示例中，您可以假设存在一些逻辑来使用 bean 定义并设置一些使用提供的元数据的缓存基础设施。

XML 模式

util 架构

使用 <util:constant/>

从字段值设置 Bean 属性或构造函数参数

使用 <util:property-path/>

使用 <util:property-path/> 设置 Bean 属性或构造函数参数

使用 <util:properties/>

使用 <util:list/>

使用 <util:map/>

使用 <util:set/>

aop 模式

context 模式

使用 <property-placeholder/>

使用 <annotation-config/>

使用 <component-scan/>

使用 <load-time-weaver/>

使用 <spring-configured/>

使用 <mbean-export/>

Beans 架构

`util` 架构

使用 `<util:constant/>`

使用 `<util:property-path/>`

使用 `<util:property-path/>` 设置 Bean 属性或构造函数参数

使用 `<util:properties/>`

使用 `<util:list/>`

使用 `<util:map/>`

使用 `<util:set/>`

`aop` 模式

`context` 模式

使用 `<property-placeholder/>`

使用 `<annotation-config/>`

使用 `<component-scan/>`

使用 `<load-time-weaver/>`

使用 `<spring-configured/>`

使用 `<mbean-export/>`