🍊返回主站🤖参与贡献

10.1. XML 模式

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

10.1.1. 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>

前面的配置使用 SpringFactoryBean实现 ( 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"/>

这确实意味着 beanid是什么不再有任何选择（因此引用它的任何其他 bean 也必须使用这个更长的名称），但是这种形式定义非常简洁，用作内部 bean 非常方便因为id不必为 bean 引用指定 ，如以下示例所示：

<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 中很容易将枚举值作为属性或构造函数参数注入到 bean 中。您实际上不必对 Spring 内部结构（甚至诸如FieldRetrievingFactoryBean. 以下示例枚举显示了注入枚举值是多么容易：

package javax.persistence;

public enum PersistenceContextType {

    TRANSACTION,
    EXTENDED
}

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

package example;

public class Client {

    private PersistenceContextType persistenceContextType;

    public void setPersistenceContextType(PersistenceContextType type) {
        this.persistenceContextType = type;
    }
}
<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"/>

前面的配置使用 SpringFactoryBean实现 ( PropertyPathFactoryBean) 创建一个名为testBean.age 的 bean（类型为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"/>

path元素的属性值<property-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>

前面的配置使用 SpringFactoryBean的实现 ( 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>

前面的配置使用 SpringFactoryBean实现 ( 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>

前面的配置使用 SpringFactoryBean的实现 ( 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>

前面的配置使用 SpringFactoryBean的实现 (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实现。

10.1.2. aop Schema

aop标签处理在 Spring 中配置所有 AOP，包括 Spring 自己的基于代理的 AOP 框架和 Spring 与 AspectJ AOP 框架的集成。这些标签在标题为Aspect Oriented Programming with 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>

10.1.3. context Schema

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。

使用<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 Framework 中使用 AspectJ 进行加载时编织的部分中有详细说明。

使用<spring-configured/>

这个元素在使用 AspectJ 通过 Spring 依赖注入域对象的部分中有详细说明。

使用<mbean-export/>

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

10.1.4. Bean Schema

最后但同样重要的是，我们在beans Schema中有元素。这些元素自框架诞生之初就存在于 Spring 中。这里没有显示beans模式中各种元素的示例，因为它们在依赖项和详细配置中被非常全面地介绍 （实际上，在整个章节中）。

请注意，您可以向<bean/>XML 定义添加零个或多个键值对。如果有的话，如何使用这些额外的元数据完全取决于您自己的自定义逻辑（因此通常仅在您编写自己的自定义元素时使用，如题为XML Schema Authoring的附录中所述）。

以下示例显示了<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"/> 
        <property name="name" value="Rick"/>
    </bean>

</beans>

这是示例meta元素

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

上一页10. 附录下一页10.2. 自定义XML Schema

最后更新于

这有帮助吗？