此版本仍在开发中,尚未被视为稳定版本。最新的稳定版本请使用 Spring Framework 6.1.13spring-doc.cn

此版本仍在开发中,尚未被视为稳定版本。最新的稳定版本请使用 Spring Framework 6.1.13spring-doc.cn

附录的这一部分列出了与核心容器相关的 XML 模式。spring-doc.cn

架构util

顾名思义,这些标签处理常见的实用程序配置 问题,例如配置集合、引用常量等。 要在架构中使用标记,您需要在顶部具有以下序言 的 Spring XML 配置文件中(代码段中的文本引用了 correct schema,以便命名空间中的标记可供您使用):utilutilutilspring-doc.cn

<?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 定义:spring-doc.cn

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

前面的配置使用 Spring 实现 (the ) 来设置 bean 上属性的值 设置为 constant 的值。这是 一切都很好,但它很冗长,并且(不必要地)暴露了 Spring 的内部 向最终用户提供管道。FactoryBeanFieldRetrievingFactoryBeanisolationjava.sql.Connection.TRANSACTION_SERIALIZABLEspring-doc.cn

下面基于 XML Schema 的版本更简洁,清楚地表达了 developer's intent (“inject this constant value”),它读起来更好:spring-doc.cn

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

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

FieldRetrievingFactoryBean 是检索或非静态字段值的 Cookie。它通常是 用于检索常量,然后可以使用这些常量来设置 另一个 bean 的 property 值或 constructor 参数。FactoryBeanstaticpublicstaticfinalspring-doc.cn

下面的示例演示如何使用 staticField 属性公开字段:staticspring-doc.cn

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

还有一个方便的使用表单,其中字段被指定为 bean name,如下例所示:staticspring-doc.cn

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

这确实意味着 bean 是什么不再有任何选择(因此任何其他 引用它的 bean 也必须使用这个更长的名称),但这种形式非常 定义简洁,并且非常方便用作内部 bean,因为 没有 为 Bean 引用指定,如下例所示:ididspring-doc.cn

<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 文档中进行了描述。spring-doc.cn

将枚举值作为 property 或 constructor 参数注入 bean 是 Spring很容易做到。您实际上不需要做任何事情或了解任何事情 Spring 内部结构(甚至关于诸如 the 等类)。 以下示例枚举显示了注入枚举值是多么容易:FieldRetrievingFactoryBeanspring-doc.cn

package jakarta.persistence;

public enum PersistenceContextType {

	TRANSACTION,
	EXTENDED
}
package jakarta.persistence

enum class PersistenceContextType {

	TRANSACTION,
	EXTENDED
}

现在考虑以下类型的 setter 和相应的 bean 定义:PersistenceContextTypespring-doc.cn

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/>

请考虑以下示例:spring-doc.cn

<!-- 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 实现( ) 创建一个名为 的值等于 Bean 的属性。FactoryBeanPropertyPathFactoryBeaninttestBean.ageagetestBeanspring-doc.cn

现在考虑以下示例,该示例添加了一个元素:<util:property-path/>spring-doc.cn

<!-- 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"/>

元素的属性值遵循 .在这种情况下,它会选取名为 .该属性的值为 .path<property-path/>beanName.beanPropertyagetestBeanage10spring-doc.cn

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

PropertyPathFactoryBean是一个 a,用于评估给定 target 对象。可以直接指定目标对象,也可以通过 Bean 名称指定。然后,您可以使用此 value 作为属性值或构造函数 论点。FactoryBeanspring-doc.cn

以下示例显示了按名称对另一个 bean 使用的路径:spring-doc.cn

<!-- 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 评估路径:spring-doc.cn

<!-- 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 名称是属性路径。 以下示例显示了快捷方式表单:spring-doc.cn

<!-- 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 的名称没有选择。对它的任何引用 也必须使用相同的 ,即 路径。如果用作内部 bean,则完全不需要引用它,如下例所示:idspring-doc.cn

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

您可以在实际定义中专门设置结果类型。这不是必需的 对于大多数用例,但有时它可能很有用。请参阅 javadoc 以获取有关 此功能。spring-doc.cn

<util:properties/>

请考虑以下示例:spring-doc.cn

<!-- 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 实现 (the ) 来实例化具有 values 从提供的 Resource 位置加载)。FactoryBeanPropertiesFactoryBeanjava.util.Propertiesspring-doc.cn

下面的示例使用元素来制作更简洁的表示形式:util:propertiesspring-doc.cn

<!-- 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/>

请考虑以下示例:spring-doc.cn

<!-- 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 实现 (the ) 创建实例并使用采用的值对其进行初始化 从提供的 .FactoryBeanListFactoryBeanjava.util.ListsourceListspring-doc.cn

下面的示例使用元素来制作更简洁的表示形式:<util:list/>spring-doc.cn

<!-- 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>

您还可以显式控制实例化的确切类型,并且 使用元素上的属性填充。为 例如,如果我们真的需要实例化 A,我们可以使用 以下配置:Listlist-class<util:list/>java.util.LinkedListspring-doc.cn

<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-classListspring-doc.cn

<util:map/>

请考虑以下示例:spring-doc.cn

<!-- 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 implementation (the ) 创建使用键值对初始化的实例 取自提供的 .FactoryBeanMapFactoryBeanjava.util.Map'sourceMap'spring-doc.cn

下面的示例使用元素来制作更简洁的表示形式:<util:map/>spring-doc.cn

<!-- 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>

您还可以显式控制实例化的确切类型,并且 使用元素上的属性填充。为 例如,如果我们真的需要实例化 A,我们可以使用 以下配置:Map'map-class'<util:map/>java.util.TreeMapspring-doc.cn

<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'Mapspring-doc.cn

<util:set/>

请考虑以下示例:spring-doc.cn

<!-- 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 implementation (the ) 创建实例,该实例使用采用的值进行初始化 从提供的 .FactoryBeanSetFactoryBeanjava.util.SetsourceSetspring-doc.cn

下面的示例使用元素来制作更简洁的表示形式:<util:set/>spring-doc.cn

<!-- 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>

您还可以显式控制实例化的确切类型,并且 使用元素上的属性填充。为 例如,如果我们真的需要实例化 A,我们可以使用 以下配置:Setset-class<util:set/>java.util.TreeSetspring-doc.cn

<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-classSetspring-doc.cn

架构aop

这些标签处理在 Spring 中配置 AOP 的所有内容,包括 Spring 的 拥有基于代理的 AOP 框架以及 Spring 与 AspectJ AOP 框架的集成。 这些标签在标题为 Aspect Oriented Programming with Spring 的章节中全面介绍。aopspring-doc.cn

为了完整起见,要在 schema 中使用标记,您需要具有 Spring XML 配置文件顶部的以下序言( snippet 引用正确的架构,以便命名空间 可供您使用):aopaopspring-doc.cn

<?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

这些标记处理与管道相关的配置 — 也就是说,通常不是对最终用户很重要的 bean,而是重要的 bean Spring 中的许多 “grunt” 工作,例如 .以下内容 snippet 引用正确的架构,以便命名空间中的元素 可供您使用:contextApplicationContextBeanfactoryPostProcessorscontextspring-doc.cn

<?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 的便捷机制。如果您需要对特定设置进行更多控制,则可以自己将其显式定义为 bean。${…​}PropertySourcesPlaceholderConfigurerspring-doc.cn

对于具有 它需要。可以配置多个属性占位符,只要它们具有不同的 占位符语法 ()。${…​}spring-doc.cn

如果需要模块化用于替换的属性源,则应 不创建多个属性占位符。相反,每个模块都应该为 .或者,您可以创建自己的 bean 来收集要使用的属性。PropertySourceEnvironmentPropertySourcesPlaceholderConfigurerspring-doc.cn

<annotation-config/>

此元素激活 Spring 基础结构以检测 bean 类中的 Comments:spring-doc.cn

或者,您也可以选择为这些注释显式激活个人。BeanPostProcessorsspring-doc.cn

此元素不会激活 Spring 的 @Transactional Comments 的处理; 为此,可以使用 <tx:annotation-driven/> 元素。同样, Spring 的缓存 Comments 也需要显式启用

<component-scan/>

此元素在 基于 annotation 的容器配置 一节中详细介绍。spring-doc.cn

<load-time-weaver/>

<spring-configured/>

<mbean-export/>

此元素在 配置基于注释的 MBean 导出 一节中详细介绍。spring-doc.cn

对于具有 它需要。可以配置多个属性占位符,只要它们具有不同的 占位符语法 ()。${…​}spring-doc.cn

如果需要模块化用于替换的属性源,则应 不创建多个属性占位符。相反,每个模块都应该为 .或者,您可以创建自己的 bean 来收集要使用的属性。PropertySourceEnvironmentPropertySourcesPlaceholderConfigurerspring-doc.cn

此元素不会激活 Spring 的 @Transactional Comments 的处理; 为此,可以使用 <tx:annotation-driven/> 元素。同样, Spring 的缓存 Comments 也需要显式启用

Bean 架构

最后但并非最不重要的一点是,我们在 schema 中有元素。这些元素 自框架诞生之初就一直在Spring。各种元素的示例 在架构中未显示,因为它们已全面介绍 在依赖项和配置中详细介绍(实际上,在那整中)。beansbeansspring-doc.cn

请注意,您可以向 XML 定义添加零个或多个键值对。 使用这些额外的元数据做什么(如果有的话)完全取决于您自己的自定义 logic 的 API 中 (因此,通常只有在您按照所述编写自己的自定义元素时才有用 在标题为 XML 架构创作的附录中)。<bean/>spring-doc.cn

以下示例显示了周围环境中的元素(请注意,如果没有任何逻辑来解释它,元数据实际上是无用的 就目前而言)。<meta/><bean/>spring-doc.cn

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

1 这是示例元素meta