Spring XML配置的十二个最佳实践

 Spring是一个强大的Java应用框架，它广泛地应用于Java应用程序中，为Plain Old Java Objects（POJO）提供企业级服务。Spring利用依赖注入机制来简化工作，同时提高可测试性。其配置文件（通常是XML格式）中指定了 Spring bean、依赖性以及bean所需的服务。但是，这些XML配置文件既冗长又不实用。对于需要定义大量Spring bean的大型项目来说，它们难以阅读和管理。
       在本文中，我将向您展示12种用于Spring XML配置的最佳实践。其中的一些实践与其说是最佳实践，倒不如说是必要实践。注意，其他因素（如域模型的设置）也可能影响XML的配置，但是本文重点研究XML配置的可读性和可管理性。

1。避免使用自动绑定（autowiring）功能 
       Spring可以通过bean类的自省自动绑定依赖 性，所以不必显式指明bean的属性和构造函数。Bean属性可以通过属性名称或类型匹配来实现自动绑定。构造函数通过类型匹配来实现自动绑定。甚至可以 指定自动检测autowiring模式，它可以引导Spring选择一种适当的运行机制。先来看看下面的一个例子：

<bean id="orderService" class="com.lizjason.spring.OrderService" autowire="byName"/>

 

OrderService 类的属性名在容器中用于匹配bean实例。自动绑定可能会节省一些键入工作量并减少混乱。但是在现实项目中不应该使用这种方式，因为它牺牲了配置的可读性 和可维护性。许多指南和介绍中大肆吹捧自动绑定是Spring的一项极好的特性，而没有提到这一特性所带来的牺牲。依我来看，这就像Spring中的对象 池（object－pooling），更大程度上只是宣传的噱头。对于精简XML配置文件来说，它是一个好办法，但它实际上增加了复杂性，尤其是在运行包 含大量类声明的项目时。虽然Spring允许混合使用自动绑定和显式绑定，但这会使XML配置更加晦涩难懂。

2.使用命名约定 
       该原则对于Java编码也一样适用。在项目中使用清晰的、描述性的、一致的命名约定将 非常有利于开发人员理解XML配置。例如，对于bean ID，可以按照Java类字段名约定来命名它。OrderServiceDAO实例的bean ID应该命名为orderServiceDAO。对于大型项目，可以在bean ID前面加上包名作为前缀。

3. 使用简洁形式 
       简洁形式避免了冗长，因为它将属性值和引用从子元素中移入属性中。例如下面的例子：

 <bean id="orderService"
        class="com.lizjason.spring.OrderService">
        <property name="companyName">
            <value>lizjason</value>
        </property>
        <constructor-arg>
            <ref bean="orderDAO">
        </constructor-arg>
    </bean>

 

可以使用简洁形式将上述代码重写为：

    <bean id="orderService"
        class="com.lizjason.spring.OrderService">
        <property name="companyName"
            value="lizjason"/>
        <constructor-arg ref="orderDAO"/>
    </bean>

 

简洁形式自1.2版本起就可以使用。注意，对于<ref local="...">，没有简洁形式。

简洁形式不但可以节约键入工作量，而且可以使XML配置文件更清晰。当一个配置文件中定义了大量的类时，它可以显著提高可读性。

4. 对于构造函数参数匹配，类型比下标好 
当构造函数含有一个以上同种类型的参数，或者属性值的标签已经被占用时，Spring允许使用从0开始的下标来避免混淆。例如：

 <bean id="billingService"
        class="com.lizjason.spring.BillingService">
        <constructor-arg index="0" value="lizjason"/>
        <constructor-arg index="1" value="100"/>
    </bean>

 利用type属性来编写会更好一些，如下：

<bean id="billingService"
        class="com.lizjason.spring.BillingService">
        <constructor-arg type="java.lang.String"
            value="lizjason"/>
        <constructor-arg type="int" value="100"/>
    </bean>

  使用index可以减少一些代码，但是与type属性相比，它更易于出错且难于阅读。只有在构造函数参数不明确的时候，才应该使用index。

5. 尽可能重用已定义的bean 
      Spring提供了一种类似于继承的机制来减少配置信息的复制并简化 XML配置。定义一个子类，它就可以从父类那里继承配置信息，而父类实际上成为子类的一个模板。这就是大型项目中所谓的重用。只需在父类bean中设置 abstract=true，然后在子bean中指定parent引用。例如：

    <bean id="abstractService" abstract="true"
        class="com.lizjason.spring.AbstractService">
        <property name="companyName"
            value="lizjason"/>
    </bean>

  <bean id="shippingService"

        parent="abstractService"
        class="com.lizjason.spring.ShippingService">
        <property name="shippedBy" value="lizjason"/>
    </bean>

 

  ShippingService类从abstractService类继承companyName属性的值——lizjason。如果一个bean没有指定类或工厂方法，那么这个bean便是抽象的。

6. 在导入时，首选通过ApplicationContext来汇编bean定义 
像Ant脚本中的导入一样，Spring的import元素对于汇编模块化的bean定义来说是很有用的。例如：

<beans>
     <import resource="billingServices.xml"/>
     <import resource="shippingServices.xml"/>
    <bean id="orderService"
        class="com.lizjason.spring.OrderService"/>
<beans>

 

 然而，相对于使用import在XML配置中进行预汇编，通过ApplicationContext来配置这些bean则显得更加灵活。使用 ApplicationContext的话，XML配置也更易于管理。可以向ApplictionContext构造函数传递一组bean定义，如下：

String[] serviceResources ={"orderServices.xml",
                                            "billingServices.xml",
                                            "shippingServices.xml"};
ApplicationContext orderServiceContext = new
        ClassPathXmlApplicationContext(serviceResources);

 

7. 使用id作为bean标识符 

可以指定一个id或名称来作为bean标识符。虽然使用id不能提高 可读性，但是它可以利用XML分析程序来对bean引用进行验证。如果由于XML IDREF的约束而不能使用某个id，那么可以使用名称来作为bean的标识符。XML IDREF的约束是：id必须以字母（或者XML规范中定义的标点符号）开头，后面是字母、数字、连字符、下划线、冒号或句点。实际上，很少会遇到XML IDREF约束问题。

8. 在开发阶段使用依赖性检查（dependency-check） 
可以在bean定义中为dependency-check属性设置一个非默认值，比如simple、objects或all，以便容器进行依赖性检查。当需要显式或通过自动绑定设置bean的全部属性（或某类属性）时，依赖性检查便显得很有用。

<bean id="orderService"
    class="com.lizjason.spring.OrderService"
    dependency-check="objects">
    <property name="companyName"
        value="lizjason"/>
    <constructor-arg ref="orderDAO"/>
</bean>

  在这个例子中，容器确保为orderService bean设置的属性不是primitives或collections。也可以为所有的bean设置默认依赖性检查，但是我们很少这样做，因为有些bean属性根本就不必设置。

9. 为每个配置文件添加首部注释 
最好使用描述性的id和名称来取代XML配置文件中的内置注释。此外，添加一个配置文件首部也很有用，它可以概述文件中所定义的bean。可以选择将描述添加到description标签中。例如：

<beans>
    <description>
            This file defines billing service
            related beans and it depends on
            baseServices.xml,which provides
            service bean templates...
     </description>
        ...
</beans>

  使用description标签的一个好处是可以轻松地利用工具从标签中选获取描述内容。

10. 对于更改，团队成员要积极交流 
        在重构Java代码时，需要随时更新配置文件并通知团队成员。XML配置文件也是代码，它们是应用程序的至关重要的部分，但是它们难于阅读和维护。大部分情况下，需要同时阅读XML配置文件和运行中的Java代码。

11. Setter注入优于构造函数注入 
       Spring提供了3种类型的依赖注入：构造函数注入（constructor injection）、setter注入（setter injection）和方法注入（method injection）。我们一般只用前两种。    

<bean id="orderService"
    class="com.lizjason.spring.OrderService">
    <constructor-arg ref="orderDAO"/>
</bean>
<bean id="billingService"
    class="com.lizjason.spring.BillingService">
    <property name="billingDAO"
        ref="billingDAO">
</bean>

  在这个例子中，orderService类使用的是构造函数注入，而BillingService类使用的是setter注入。构造函数注入可以确 保bean不会在一个非法状态下被创建，但是setter注入更加灵活且更易于管理，尤其是在类包含许多属性并且其中一些可选的情况下。

12. 不要滥用依赖注入 
       最后一点，Spring ApplicationContext可以为您创建Java对象，但并不是所有的Java对象都应通过依赖注入来创建。例如，全局对象不应该通过 Application Context来创建。Spring是一个很棒的框架，但是，就可读性和易管理性而言，如果定义了大量bean，基于XML的配置 就可能成为问题。过度使用依赖注入会使XML配置变得复杂且臃肿。要知道，借助于功能强大的IDE（如Eclipse和IntelliJ），Java代码 比XML文件更加易读、易维护、易管理。

结束语 
        XML是通用的Spring配置方式。但如果定义了大量bean，基于XML的配置就会变得冗长 而不实用。Spring提供了丰富的配置选项，恰当地利用其中的选项可以使XML配置更清晰，但是，有些选项（如autowiring）往往会降低配置文 件的可读性和可维护性。遵循本文中所描述的最佳实践，将有助于您创建出清晰易读的XML配置文件。