Java程序員必須掌握Spring XML配置的12個技巧

Spring是一個強有力的Java程序框架，其被普遍應用於Java的程序中。它用POJO提供了企業級服務。Spring利用依賴注入能夠得到簡單而有效的測試能力。Spring beans，依賴關係，以及服務所須要的bean都將在配置文件中予以描述，配置文件通常採用XML格式。然而XML配置文件冗長而不易使用，在你進行一個使用了大量bean的大項目中它將變得難以閱讀和控制。

在這篇文章中我將給你展現12種的有關Spring XML配置文件的最佳技巧。它們中的一些具備更多的實際意義，而不只是最好的技巧。請注意另一些因素，例如域模型的設計，會影響到XML配置，可是這篇文章更關注於XML配置的可讀性和可操控性。

1． 避免使用自動裝配

Spring能夠經過bean類的自省來實現自動裝配依賴，這樣的話你就沒必要明確地描述bean的屬性或者構造函數的參數。根據屬性名稱活匹配類型，bean屬性能夠自動進行裝配。而構造函數能夠根據匹配類型自動裝配。你甚至能夠設置自動裝配進行自動偵測，這樣Spring替你就會選擇一個合適的機制。請看下面的例子：

Spring能夠經過bean類的自省來實現自動裝配依賴，這樣的話你就沒必要明確地描述bean的屬性或者構造函數的參數。根據屬性名稱活匹配類型，bean屬性能夠自動進行裝配。而構造函數能夠根據匹配類型自動裝配。你甚至能夠設置自動裝配進行自動偵測，這樣Spring替你就會選擇一個合適的機制。請看下面的例子：

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

OrderService類的屬性名被用來和容器中的一個bean實例進行匹配。自動裝配會默默的保存一些類型信息並下降混亂。然而，因爲它會犧牲掉這種配置的直觀性和可維護性，你在實際的項目中將不會用到它。許多指南和陳述材料都把它吹捧爲Spring的一個很是cool的特性，而沒有提到它的這個缺點。依我之見，就像Spring的對象池同樣，它更多了一些商業味道。它看起來好像可使XML配置文件更精簡一些，但實際上卻增長其複雜性，尤爲是在你的較大規模的工程中已經定義了不少bean的時候更是如此。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配置更加的清晰。當你的配置文件中存在大量的bean定義時，它能夠顯著地提升可讀性。

4． 儘可能使用type而不是index去解決構造函數參數的匹配問題

當構造函數中有多個同類型的參數時，Spring只容許你使用從0開始的index或者value標籤來解決這個問題。請看下面的例子：

<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能夠從它的父bean繼承配置信息，本質上這個父bean就像它的子bean的一個模板。這是一個在大型項目中必須使用的特性。全部你要作的就是把父bean的abstract屬性置爲true，並在子bean中加以引用。例如：

<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 bean繼承了abstractService bean的屬性companyName的值lizjason。注意，若是你爲bean聲名一個class或工廠方法，這個bean將會默認爲abstract

6． 儘可能使用ApplicationContext裝配bean，而不是用import

像Ant腳本中imports同樣，Spring的import 元素對於模塊化bean的裝配很是有用，例如：

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

然而，比起在XML中用imports預裝配這些bean，利用ApplicationContext來配置它們將更加靈活，也可使XML配置更加的易於管理。你能夠像下面這樣傳遞一個bean定義數組到ApplicationContext的構造函數中：

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

7． 用id來標識bean

你能夠用id或名字做爲bean的標識。用id可讀性較差，可是它能夠影響XML分析器使bean的reference有效。若是id因爲XML IDREF約束而沒法使用，你能夠用name做爲bean的標識。XML IDREF約束是指id必須以字母開始(或者是在XML聲名了的一個標點符號)，後面能夠是字母，數字，連字符，下劃線，冒號或full stops(不知道怎麼翻譯好)。在實際應用中不多會遇到XML IDREF約束問題。

8． 在開發階段使用依賴檢查

你能夠爲bean的dependency-check屬性設置一個值來取代默認的none，好比說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>

在這個例子中，容器將確保這些屬性不是privitives或者保證collections是爲orderService bean設置的。爲全部的bean設置默認的依賴檢查是可能的，但這個特性因爲有些bean的屬性不須要設置而不多使用。

9． 爲每一個配置文件加一個描述註釋

在XML配置文件中最好使用有描述性的id和name，而不是成堆的註釋。另外，加一個文件描述頭將會很是有用，這個描述能夠歸納文件中定義的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． 和team members溝通變動

當你修改java源碼後，要確保更改了配置文件中的相應部分並把這個狀況告知你的team members。XML配置文件也是代碼，它們是程序的重要組成部分，但它們很難閱讀和維護。大多數時間裏，你須要同時看XML配置文件和java代碼才能知道是怎麼回事。

11． setter注入和構造函數注入，優先使用前者

Spring提供了三種注入方式：構造函數注入，setter注入和方法注入。通常咱們使用前兩種。

<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 bean用了構造函數注入，而BillingService bean用了setter注入。構造函數注入能夠確保bean正確地構建，可是setter注入更加的靈活和易於控制，特別是當class有多個屬性而且它們中的一些是可選的狀況是更是如此。

12． 不要濫用注入

就像前面提到的，Spring的ApplicationContext能夠替你建立java對象，但不是全部的java對象都應該經過注入建立。例如，域對象就不該該經過ApplicationContext建立。Spring是一個優秀的框架，可是考慮到可讀性和可操控性，基於XML配置的配置會在定義不少bean的時候出現麻煩。過渡使用依賴注入將會使XML配置更加的複雜和冗長。切記，當使用高效的IDE時，例如Eclipse and IntelliJ，java代碼更加的易於閱讀，維護和管理比使XML文件

結論

XML是Spring流行的配置格式。存在大量bean定義時，基於XML的配置會變得冗長而不易使用。Spring提供了豐富的配置選項。適當地使用這些選項可使XML配置更加的清晰，但其它的一些選項，例如自動裝配，可能會下降可讀性和可維護性。參考本文中提到的這些技巧可能會幫助你建立乾淨而易讀的XML配置文件。

蘇先生ii：專一於Java開發技術的研究與知識分享！

————END————