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 模式的版本更简洁，清晰地表达了开发者的意图（“注入此常量值”），并且可读性更好：

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

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

FieldRetrievingFactoryBean是一个检索static或非静态字段值的FactoryBean。它通常用于检索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（类型为int）的 Bean，其值等于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模式创作的章节所述）时才有用）。

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

<?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定义并设置一些使用提供的元数据的缓存基础结构。