MVC框架實例—Spring MVC配置 - 全文

????????在本文中，我們提供了一系列的配置技巧，讓您在使用Spring MVC框架完成日常工作的時候更加輕松。本配置管理主題常被學(xué)術(shù)界所忽略，但是，這對于現(xiàn)實的web開發(fā)尤為重要。我們將根據(jù)Spring MVC框架，為基于本技術(shù)開發(fā)的項目提供一系列的解決方案。

　　Spring配置

　　人們經(jīng)常會在一臺以上的主機上配置一種Web應(yīng)用程序。例如，在生產(chǎn)中，一個網(wǎng)站可能只有一個實例。除了此實例外，開發(fā)人員可以在用于開發(fā)的機器上配置其他的（開發(fā)）實例。也可以在公司（機構(gòu)）內(nèi)部的本地開發(fā)服務(wù)器上維護其他應(yīng)用程序裝置，這將讓您受益匪淺。該實例的目的是使Web設(shè)計者可以獲得有質(zhì)量保證的材料，并為需要為應(yīng)用程序提供文件資料的人提供準入。

　　大家都知道，即使是最簡單的場景，也需要安裝、配置和維護三個實例。而對于位于不同地理位置的團隊來說，要從事這樣的項目便更加困難。對于任何不是特別簡單的Web應(yīng)用程序項目，都需要多名開發(fā)人員來安裝項目裝置和本地設(shè)置以及運行單元測試的裝置等。

　　很多組織都將自己開發(fā)的產(chǎn)品作為Web應(yīng)用程序。我們可以在很多產(chǎn)品中發(fā)現(xiàn)這種情況，例如電子商務(wù)系統(tǒng)、內(nèi)容管理系統(tǒng)（CMS），以及博客發(fā)布平臺等。這類產(chǎn)品可在多個服務(wù)器中進行部署。對于成功的多用途W(wǎng)eb應(yīng)用程序來說，他們的開發(fā)人員必須要保證他們的應(yīng)用程序便于安裝，并且能夠與其他Web應(yīng)用程序完美集成。經(jīng)過上述討論之后，我們應(yīng)該明了，作為本文主題的應(yīng)用程序配置是通用Web應(yīng)用程序項目開發(fā)人員所需要解決的重要問題之一。

　　諸如CVS或Subversion之類的版本控制系統(tǒng)是開發(fā)組織使用的一種標(biāo)準工具。這種工具代表了一些組織的中心源代碼版本庫，它們被用于保持源代碼的有序。用戶可以跟蹤應(yīng)用程序源代碼的變化，顯示不同版本的區(qū)別，并可以確定項目分支。而且，它們使得在應(yīng)用程序部署中進行部分更新成為可能。

　　很明顯，版本控制系統(tǒng)軟件是跟蹤源代碼所必需的，它對于解決應(yīng)用程序配置問題有非常大的幫助。在本文中，我們將不會把重點放在版本控制系統(tǒng)上，因為這方面已經(jīng)有很多相關(guān)的材料了。在此，我們將關(guān)注版本控制問題中的一個小話題：如何使Web應(yīng)用程序的配置更加便捷（尤其是使用Spring MVC框架編寫的Web應(yīng)用程序）。

　　問題是：我們在此討論的是一種什么樣的配置？任何Web應(yīng)用程序都需要一些資源，這些資源通常都是其所運行的服務(wù)器所特有的，例如數(shù)據(jù)庫URL、發(fā)送電子郵件的SMTP服務(wù)器，以及包含專用軟件文件的文件夾等。這樣的設(shè)置應(yīng)該集中，從而使應(yīng)用程序配置更加簡單。

　　但是，這只是這個問題最簡單的一種版本。有時候，在應(yīng)用程序開發(fā)中需要更加復(fù)雜的配置。這意味著，必須將各次部署中的不同Bean連接起來，而這會使問題更加復(fù)雜。

　　這些應(yīng)用程序配置問題的解決方案有諸多優(yōu)勢，包括：簡化應(yīng)用程序的安裝和配置過程，使源代碼版本控制更加簡便，減少源代碼版本庫中的沖突現(xiàn)象。下面，我們將通過示例詳細討論這個話題。

　　問題

　　我們首先來演示一下上文所提到的最簡單的版本。在這一場景中，我們希望在應(yīng)用程序部署中改變的是簡單的配置參數(shù)，例如鏈接、密碼等。如果您曾經(jīng)使用Spring MVC框架開發(fā)過Web應(yīng)用程序，那么您應(yīng)該知道這里將用到的兩個配置文件：

• /WEB-INF/applicationContext.xml，它讓您可以配置Bean，或者顯示應(yīng)用程序上下文。通過這個文件，您可以定義自己的業(yè)務(wù)邏輯Bean、資源以及其他可以與Web端口相關(guān)聯(lián)的所有Bean。
• /WEB-INF/[servlet-name]-servlet.xml，它被用于配置Web層、視圖解析器、控制器、校驗器以及其他所有MVC框架中必需的Bean。[servlet-name]指的是在web.xml部署描述符中定義的Spring dispatcher servlet的名稱。

　　那么問題在哪兒呢？問題就出在applicationContext.xml中將包括一些特定于主機的Bean定義。其中，最明顯的一個示例就是包含了JDBC連接信息的bean，但是任何一種稍微復(fù)雜些的應(yīng)用程序都有十幾個類似的Bean。看一下下面的示例：

class="org.springframework.jdbc.datasource.DriverManagerDataSource">

org.postgresql.Driver


jdbc:postgresql://localhost/test


postgres

　　這個解決方案的問題在于對applicationContext.xml文件的維護。對于初學(xué)者來說，設(shè)想一下，項目放在源代碼版本控制系統(tǒng)中，例如CVS。下面，假設(shè)您希望在網(wǎng)站中添加新的功能，那么就需要在應(yīng)用程序上下文定義中添加額外的Bean定義。問題是如何在生產(chǎn)服務(wù)器上體現(xiàn)這些改變。

　　通常情況下，應(yīng)用程序的本地實例不會與活動站點使用同樣的數(shù)據(jù)庫，因此applicationContext.xml文件將包括讓您能夠訪問本地數(shù)據(jù)庫的設(shè)置。當(dāng)您想提交在源代碼版本庫中的改變時，就需要注意這些特定于主機屬性的同步性。版本庫中的文件最終可能使用本地設(shè)置中的配置。如果想在生產(chǎn)服務(wù)器上更新配置，就必須手動同步這些屬性的值。這是非?？菰锏娜蝿?wù)，而且還非常容易出錯。

　　對于應(yīng)用程序的每個實例來說，這個問題更加重要。假如有三位開發(fā)人員正在使用代碼段基址，而且他們使用的是本地的數(shù)據(jù)庫。當(dāng)您提交更改的時候，他們每個人在本地服務(wù)器上更新源代碼的時候都必須非常謹慎。他們會手動同步這些更改，然后提交他們的工作。這樣一來，版本控制系統(tǒng)對于這些配置文件來說已經(jīng)毫無用處。如果曾經(jīng)使用過Spring MVC，那么您應(yīng)該知道applicationContext.xml是應(yīng)用程序中的關(guān)鍵組件，因為是它將所有的東西粘合在一起。所以，我們需要一種機制來幫助使應(yīng)用程序中各項保持有序，這點非常重要。

正如前面所提到的，這是您可能遇到的較簡單的配置問題。更難的問題出現(xiàn)在當(dāng)需要在不同服務(wù)器中進行不同的Bean連接的時候。這類問題常會出現(xiàn)在日常軟件開發(fā)任務(wù)中。例如，假如您的產(chǎn)品有一個客戶身份驗證模塊，可以對來自關(guān)系數(shù)據(jù)庫或LDAP服務(wù)器中的用戶進行身份驗證。自然，這一身份驗證模塊可以使用抽象了特定版本庫的Bean進行配置。如果您想改變不同應(yīng)用程序部署中驗證用戶的方式，就需要在applicationContext.xml文件中進行不同的Bean連接。這種配置問題常見于在部署中有可配置特性的所有應(yīng)用程序。

　　在下文中，我們將討論這兩種配置問題。首先我們會關(guān)注同步的Bean屬性問題及其解決方案，接下來，我們會討論更加復(fù)雜的同步Bean連接問題。

　　解決方案

　　同步Bean屬性

　　這個問題的一種可行的解決方案是將所有特定于主機的參數(shù)都放到普通的Java屬性文件中，使用Spring的PropertyPlaceHolderConfigurer類，將這些參數(shù)寫入Bean屬性中。

　　使用這一解決方案，我們可以生成如下的屬性文件（/WEB-INF/jdbc.properties）：

jdbc.driver=org.postgresql.Driver
jdbc.url=jdbc:postgresql://localhost/test
jdbc.user=postgres
jdbc.password=
　　我們的Bean配置如下：

class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

/WEB-INF/jdbc.properties



class="org.springframework.jdbc.datasource.DriverManagerDataSource">

${jdbc.driver}


${jdbc.url}


${jdbc.user}


${jdbc.password}


　　如上所述，我們定義了一個PropertyPlaceholderConfigurer類的實例，并將其位置屬性設(shè)置為我們的屬性文件。該類被實現(xiàn)為Bean工廠的后處理器，并將使用定義在文件中的屬性來代替所有的占位符（${...}value）。

　　利用這種技術(shù)，我們可以從applicationContext.xml中移除所有特定于主機的配置屬性。通過這種方式，我們可以自由地為該文件添加新的Bean，而不必擔(dān)心特定于主機屬性的同步性。這樣可以簡化生產(chǎn)部署和維護。

　　同步性連接

　　上面的技術(shù)解決了第一個問題，可是如果您計劃修改不同應(yīng)用程序部署之間的Bean連接，這一技術(shù)便不很適合。針對這一問題的一個解決方案便是額外創(chuàng)建一個名為applicationContext-[hostname].xml 的XML定義文件。其中[hostname]是部署應(yīng)用程序的主機的名稱。例如，在本地的機器上，這個文件通常名為applicationContext-localhost.xml，而在部署時，它可能更名為applicationContext-somehost.com.xml。

　　可以猜測，這一文件必須包括特定于某一主機的所有配置Bean。在本文中，我們將假設(shè)dataSource bean定義將位于這類文件中，而不是通用的applicationContext.xml定義。當(dāng)然，這種機制與前者并非沖突，但是為了更加簡單明了，我們將只關(guān)注這種方法。

　　既然我們已經(jīng)有了特定的配置，下面我們就來討論一下如何將其整合到整個Spring MVC配置概念中。要達到這一目的，可以有許多方法，我們將詳細地一一說明。但首先，我們應(yīng)該注意到，由于有些Bean可能位于獨立的配置文件中，因此在applicationContext.xml中，所有對它們的局部引用都必須更換成全局名稱。

　　例如，如下引用：




　　應(yīng)更改為：




　　在這之后，我們有很多可以添加額外的資源以用于配置的方式。其中最明顯的就是使用標(biāo)簽將這一額外資源包含在applicationContext.xml配置文件中。使用時，要將該標(biāo)簽放在applicationContext.xml文件開頭。例如：

　　現(xiàn)在，在獨立的XML定義文件和普通的應(yīng)用程序上下文定義文件中的所有通用Bean定義都有了特定于主機的連接。由于大多數(shù)的Bean都不是特定于主機的，因此我們可以像處理Web應(yīng)用程序中的其他資源一樣自由地處理applicationContext.xml文件，并可以通過合適的版本控制系統(tǒng)與其進行同步。

　　但是，上述方法也有一定的弊端。如果您想保留不同XML文件的不同配置，就仍然必須擔(dān)心applicationContext.xml的同步性，因為資源的名稱必須根據(jù)不同服務(wù)器進行更改。雖然與原有的解決方案相比有了很大提高，只需更改文件名，但是這還是需要開發(fā)人員的手動協(xié)助。

　　由于與applicationContext.xml相比，主機配置不需如此頻繁地進行更改，因此下一步便是將主機配置移動到web.xml文件中（如果可能的話）。幸運的是，我們有一個可用的解決方案?？匆幌孪旅骊P(guān)于web.xml配置的片斷：



org.springframework.web.context.ContextLoaderListener



contextConfigLocation

/WEB-INF/applicationContext.xml
/WEB-INF/applicationContext-somehost.com.xml


　　正如您所看到的，除了web.xml文件中常有的ContextLoaderListener之外，我們還添加了contextConfigLocation上下文參數(shù)配置。這一參數(shù)用于指示框架查找這些配置文件的位置。如果這一參數(shù)被省略，則Spring就只能到applicationContext.xml中查找。這里我們也定義了特定于主機的配置文件來使用。

　　利用這種方法，我們將所有特定于主機的配置從applicationContext.xml文件中移除，這樣便減輕了其在不同應(yīng)用程序部署中的同步性。

　　如果這種方法成為您的新習(xí)慣，您還可以使其更加靈活。通過遵守下列指令，也可以將特定于主機的配置從web.xml文件中移除。

　　為此，需要創(chuàng)建特定于我們的應(yīng)用程序上下文的類：

package net.nighttale.spring.util;

import java.net.InetAddress;

import org.springframework.web.context.support.XmlWebApplicationContext;

public class PerHostXmlWebApplicationContext
extends XmlWebApplicationContext {

protected String[] getDefaultConfigLocations() {
String hostname = "localhost";
try {
hostname = InetAddress.getLocalHost().getHostName();
} catch (Exception e) {
}

String perHostConfiguration = DEFAULT_CONFIG_LOCATION_PREFIX
"applicationContext-"
hostname
DEFAULT_CONFIG_LOCATION_SUFFIX
;

logger.debug(
"Adding per host configuration file: "
perHostConfiguration
);

if (getNamespace() != null) {
return new String[] {
DEFAULT_CONFIG_LOCATION_PREFIX
getNamespace()
DEFAULT_CONFIG_LOCATION_SUFFIX
, perHostConfiguration};
}
else {
return new String[] {
DEFAULT_CONFIG_LOCATION
, perHostConfiguration};
}
}
}
　　這個類拓展了Spring中常被作為默認值使用的XmlWebApplicationContext。XmlWebApplicationContext類將Web應(yīng)用程序的配置從XML定義文件中復(fù)制過來。默認情況下，它可以配置來自applicationContext.xml和[servlet-name]-servlet.xml文件中的應(yīng)用程序。這個類執(zhí)行的惟一一項額外任務(wù)便是獲取它所在的主機名稱，并將applicationContext-[hostname].xml文件添加到配置文件列表中。

　　為了使用這個類，我們需要對其進行編譯，將其包含在類途徑中，并指示Spring框架使用它。前兩步非常簡單，我們就不在此贅述。我們可以指示Sping通過contextClass上下文參數(shù)來使用它。除了web.xml文件中的原有配置，我們還可以添加下列內(nèi)容：


contextClass

net.nighttale.spring.util.PerHostXmlWebApplicationContext


　　如果我們使用這一配置片斷，將會有三個文件被用于初始化這個框架：[servlet-name]-servlet.xml、applicationContext-[hostname].xml以及applicationContext.xml。

　　正如您所看到的，applicationContext.xml和web.xml文件已經(jīng)完全擺脫了任何特定的配置細節(jié)，而且您也不必擔(dān)心會在更新應(yīng)用程序時破壞配置。

　　但是，這種方法有一個不足之處。因為，不論是否會使用，都需要在應(yīng)用程序部署中有第三個配置文件。在這種情況下，便不需要特定于主機的配置。例如：


"http://www.springframework.org/dtd/spring-beans.dtd">


　　最后，需要知道應(yīng)用程序上下文類需要查找的特定主機名。檢查主機名稱的最簡單的方法是在機器上運行下列代碼：

System.out.println(InetAddress.getLocalHost().getHostName())
　　可以將其作為Java代碼執(zhí)行，也可在喜歡使用的腳本語言（如BeanShell或Groovy）中作為一個具有Java風(fēng)格語法的腳本執(zhí)行。在獲取了主機的名稱之后，應(yīng)該創(chuàng)建一個默認的/WEB-INF/applicationContext-[hostname].xml空文件夾（如我們上面所定義的），然后便可以開始了。