web.xml詳解_動力節(jié)點Java學院整理

更新時間：2017年07月18日 11:32:03 投稿：mrr

這篇文章給大家詳細介紹了web.xml的相關(guān)知識,需要的朋友可以參考下

一、 Web.xml詳解：

(一) web.xml加載過程（步驟）

首先簡單說一下，web.xml的加載過程。

當我們?nèi)右粋€WEB項目時，容器包括（JBoss、Tomcat等）首先會讀取項目web.xml配置文件里的配置，當這一步驟沒有出錯并且完成之后，項目才能正常地被啟動起來。

 啟動WEB項目的時候，容器首先會去它的配置文件web.xml讀取兩個節(jié)點:

<listener></listener>和<context-param></context-param>

 緊接著，容器創(chuàng)建一個ServletContext（application），這個WEB項目所有部分都將共享這個上下文。
 容器以<context-param></context-param>的name作為鍵，value作為值，將其轉(zhuǎn)化為鍵值對，存入ServletContext。
 容器創(chuàng)建<listener></listener>中的類實例，根據(jù)配置的class類路徑<listener-class>來創(chuàng)建監(jiān)聽，在監(jiān)聽中會有contextInitialized(ServletContextEvent args)初始化方法，啟動Web應(yīng)用時，系統(tǒng)調(diào)用Listener的該方法，在這個方法中獲得：

ServletContext application =ServletContextEvent.getServletContext();
context-param的值= application.getInitParameter("context-param的鍵");

得到這個context-param的值之后，你就可以做一些操作了。

 舉例：你可能想在項目啟動之前就打開數(shù)據(jù)庫，那么這里就可以在<context-param>中設(shè)置數(shù)據(jù)庫的連接方式（驅(qū)動、url、user、password），在監(jiān)聽類中初始化數(shù)據(jù)庫的連接。這個監(jiān)聽是自己寫的一個類，除了初始化方法，它還有銷毀方法，用于關(guān)閉應(yīng)用前釋放資源。比如:說數(shù)據(jù)庫連接的關(guān)閉，此時，調(diào)用contextDestroyed(ServletContextEvent args)，關(guān)閉Web應(yīng)用時，系統(tǒng)調(diào)用Listener的該方法。
 接著，容器會讀取<filter></filter>，根據(jù)指定的類路徑來實例化過濾器。
 以上都是在WEB項目還沒有完全啟動起來的時候就已經(jīng)完成了的工作。如果系統(tǒng)中有Servlet，則Servlet是在第一次發(fā)起請求的時候被實例化的，而且一般不會被容器銷毀，它可以服務(wù)于多個用戶的請求。所以，Servlet的初始化都要比上面提到的那幾個要遲。

總的來說，web.xml的加載順序是: <context-param>-> <listener> -> <filter> -> <servlet>。其中，如果web.xml中出現(xiàn)了相同的元素，則按照在配置文件中出現(xiàn)的先后順序來加載。

對于某類元素而言，與它們出現(xiàn)的順序是有關(guān)的。以<filter>為例，web.xml中當然可以定義多個<filter>，與<filter>相關(guān)的一個元素是<filter-mapping>，注意，對于擁有相同<filter-name>的<filter>和<filter-mapping>元素而言，<filter-mapping>必須出現(xiàn)在<filter>之后，否則當解析到<filter-mapping>時，它所對應(yīng)的<filter-name>還未定義。web容器啟動初始化每個<filter>時，按照<filter>出現(xiàn)的順序來初始化的，當請求資源匹配多個<filter-mapping>時，<filter>攔截資源是按照<filter-mapping>元素出現(xiàn)的順序來依次調(diào)用doFilter()方法的。<servlet>同<filter>類似，此處不再贅述。

(二) web.xml標簽詳解

1.XML文檔有效性檢查

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://Java.sun.com/dtd/web-app_2_3.dtd" >

這段代碼指定文件類型定義(DTD)，可以通過它檢查XML文檔的有效性。下面顯示的<!DOCTYPE>元素有幾個特性，這些特性告訴我們關(guān)于DTD的信息：

2.web-app定義該文檔(部署描述符，不是DTD文件)的根元素

PUBLIC意味著DTD文件可以被公開使用

"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"意味著DTD由Sun Microsystems, Inc.維護。該信息也表示它描述的文檔類型是DTD Web Application 2.3，而且DTD是用英文書寫的。

URL"

<web-app></web-app>

部署描述符的根元素是<web-app>。DTD文件規(guī)定<web-app>元素的子元素的語法如下：

<!ELEMENT web-app (icon?, display-name?, description?, 
distributable?, context-param*, filter*, filter-mapping*, 
listener*, servlet*, servlet-mapping*, session-config?, 
mime-mapping*, welcome-file-list?, 
error-page*, taglib*, resource-env-ref*, resource-ref*, 
security-constraint*, login-config?, security-role*,env-entry*, 
ejb-ref*, ejb-local-ref*)>

正如您所看到的，這個元素含有23個子元素，而且子元素都是可選的。問號(？)表示子元素是可選的，而且只能出現(xiàn)一次。星號(*)表示子元素可在部署描述符中出現(xiàn)零次或多次。有些子元素還可以有它們自己的子元素。web.xml文件中<web-app>元素聲明的是下面每個子元素的聲明。下面講述部署描述符中可能包含的所有子元素。

注意：

在Servlet 2.3中，子元素必須按照DTD文件語法描述中指定的順序出現(xiàn)。比如：如果部署描述符中的<web-app>元素有<servlet>和<servlet-mapping>兩個子元素，則<servlet>子元素必須出現(xiàn)在<servlet-mapping>子元素之前。在Servlet2.4中，順序并不重要。

3. <display-name></display-name>

<display-name>test-hwp-web-application</display-name>定義了web應(yīng)用的名稱，可以在

http://localhost:8080/manager/html中顯示。如下所示：

4.<distributable/>

<distributable/>可以使用distributable元素來告訴servlet/JSP容器，Web容器中部署的應(yīng)用程序適合在分布式環(huán)境下運行。

5.<context-param></context-param>

<!--****************************上下文初始化參數(shù)配***************************--> 
<context-param> 
 <param-name>webAppRootKey</param-name> 
 <param-value>business.root</param-value> 
</context-param> 
<!-- spring config --> 
<context-param> 
 <param-name>contextConfigLocation</param-name> 
 <param-value>/WEB-INF/spring-configuration/*.xml</param-value> 
</context-param>

<context-param>解釋：

<context-param>元素含有一對參數(shù)名和參數(shù)值，用作應(yīng)用的Servlet上下文初始化參數(shù)，參數(shù)名在整個Web應(yīng)用中必須是惟一的，在web應(yīng)用的整個生命周期中上下文初始化參數(shù)都存在，任意的Servlet和jsp都可以隨時隨地訪問它。<param-name>子元素包含有參數(shù)名，而<param-value>子元素包含的是參數(shù)值。作為選擇，可用<description>子元素來描述參數(shù)。

什么情況下使用，為什么使用<context-param>：

比如：定義一個管理員email地址用來從程序發(fā)送錯誤，或者與你整個應(yīng)用程序有關(guān)的其他設(shè)置。使用自己定義的設(shè)置文件需要額外的代碼和管理；直接在你的程序中使用硬編碼（Hard-coding）參數(shù)值會給你之后修改程序帶來麻煩，更困難的是，要根據(jù)不同的部署使用不同的設(shè)置；通過這種辦法，可以讓其他開發(fā)人員更容易找到相關(guān)的參數(shù)，因為它是一個用于設(shè)置這種參數(shù)的標準位置。

Spring配置文件：

配置Spring，必須需要<listener>，而<context-param>可有可無，如果在web.xml中不寫<context-param>配置信息，默認的路徑是/WEB-INF/applicationContext.xml，在WEB-INF目錄下創(chuàng)建的xml文件的名稱必須是applicationContext.xml。如果是要自定義文件名可以在web.xml里加入contextConfigLocation這個context參數(shù)：在<param-value>里指定相應(yīng)的xml文件名，如果有多個xml文件，可以寫在一起并以“,”號分隔，比如在business-client工程中，我們采用了自定義配置方式，<context-param>配置如下：

<!-- spring config --> 
<context-param> 
 <param-name>contextConfigLocation</param-name> 
 <param-value>/WEB-INF/spring-configuration/*.xml</param-value> 
</context-param> 
<listener> 
  <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 
 </listener>

對應(yīng)工程目錄結(jié)構(gòu)如下所示：

webAppRootKey配置：

部署在同一容器中的多個Web項目，要配置不同的webAppRootKey，web.xml文件中最好定義webAppRootKey參數(shù)，如果不定義，將會缺省為“webapp.root”，如下：

<!-- 應(yīng)用路徑 --> 
 <context-param> 
  <param-name>webAppRootKey</param-name> 
  <param-value>webapp.root</param-value> 
 </context-param>

當然也不能重復，否則報類似下面的錯誤：

Web app root system property already set to different value: 'webapp.root' = [/home/user/tomcat/webapps/project1/] instead of [/home/user/tomcat/webapps/project2/] - Choose unique values for the 'webAppRootKey' context-param in your web.xml files!

意思是“webapp.root”這個key已經(jīng)指向了項目1，不可以再指向項目2。多個項目要對webAppRootKey進行配置，我們工程主要是讓log4j能將日志寫到對應(yīng)項目根目錄下，比如：我們的項目的webAppRootKey為

<!—business-client應(yīng)用路徑 --> 
 <context-param> 
  <param-name>webAppRootKey</param-name> 
  <param-value> business.root </param-value> 
 </context-param> 
<!—public-base應(yīng)用路徑 --> 
 <context-param> 
  <param-name>webAppRootKey</param-name> 
  <param-value> pubbase.root</param-value> 
 </context-param>

這樣就不會出現(xiàn)沖突了。就可以在運行時動態(tài)地找到項目路徑，在log4j.properties配置文件中可以按下面的方式使用${webapp.root}：

log4j.appender.file.File=${webapp.root}/WEB-INF/logs/sample.log

就可以在運行時動態(tài)地找出項目的路徑。

多個配置文件交叉引用處理：

如果web.xml中有contextConfigLocation參數(shù)指定的Spring配置文件，則會去加載相應(yīng)的配置文件，而不會去加載/WEB-INF/下的applicationContext.xml。但是如果沒有指定的話，默認會去/WEB-INF/下加載applicationContext.xml。
在一個團隊使用Spring的實際項目中，應(yīng)該需要多個Spring的配置文件，如何使用和交叉引用的問題：

多個配置文件可以在web.xml里用空格分隔寫入，如：

 <context-param> 
<param-name>contextConfigLocation </param-name> 
<param-value> applicationContext-database.xml,applicationContext.xml</param-value> 
<context-param>

多個配置文件里的交叉引用可以用ref的external或bean解決，例如：

applicationContext.xml

<bean id="userService" class="domain.user.service.impl.UserServiceImpl"> 
<property name="dbbean"> 
<ref bean="dbBean"/> 
</property> 
</bean>

dbBean在applicationContext-database.xml中。

在不同環(huán)境下如何獲?。?/p>

范例:

<context-param> 
<param-name>param_name</param-name> 
<param-value>param_value</param-value> 
</context-param>

此所設(shè)定的參數(shù)，在JSP網(wǎng)頁中可以使用下列方法來取得：

${initParam.param_name}

若在Servlet可以使用下列方法來獲得：

String param_name=getServletContext().getInitParamter("param_name");

Servlet的ServletConfig對象擁有該Servlet的ServletContext的一個引用，所以可這樣取得上下文初始化參數(shù)：getServletConfig().getServletContext().getInitParameter()也可以在Servlet中直接調(diào)用getServletContext().getInitParameter()，兩者是等價的。

6.<session-config></session-config>

<!-- Set timeout to 120 minutes --> 
<session-config> 
<session-timeout>120</session-timeout> 
</session-config>

<session-config> 用于設(shè)置容器的session參數(shù)，比如：<session-timeout>用于指定http session的失效時間。默認時間設(shè)置在<jakarta>/conf/web.xml (30 minutes)。<session-timeout>用來指定默認的會話超時時間間隔，以分鐘為單位。該元素值必須為整數(shù)。如果 session-timeout元素的值為零或負數(shù)，則表示會話將永遠不會超時。

7.<listener></listener>

<!--****************************監(jiān)聽器配置*********************************--> 
<!-- Spring的log4j監(jiān)聽器 --> 
<listener> 
 <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> 
</listener> 
<listener> 
 <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 
</listener> 
<!-- 與CAS Single Sign Out Filter配合，注銷登錄信息 --> 
<listener> 
<listener-class>com.yonyou.mcloud.cas.client.session.SingleSignOutHttpSessionListener</listener-class> 
</listener>

1. Listener介紹：

<listener>為web應(yīng)用程序定義監(jiān)聽器，監(jiān)聽器用來監(jiān)聽各種事件，比如：application和session事件，所有的監(jiān)聽器按照相同的方式定義，功能取決去它們各自實現(xiàn)的接口，常用的Web事件接口有如下幾個：

ServletContextListener：用于監(jiān)聽Web應(yīng)用的啟動和關(guān)閉；

ServletContextAttributeListener：用于監(jiān)聽ServletContext范圍（application）內(nèi)屬性的改變；

ServletRequestListener：用于監(jiān)聽用戶的請求；

ServletRequestAttributeListener：用于監(jiān)聽ServletRequest范圍（request）內(nèi)屬性的改變；

HttpSessionListener：用于監(jiān)聽用戶session的開始和結(jié)束；

HttpSessionAttributeListener：用于監(jiān)聽HttpSession范圍（session）內(nèi)屬性的改變。

<listener>主要用于監(jiān)聽Web應(yīng)用事件，其中有兩個比較重要的WEB應(yīng)用事件：應(yīng)用的啟動和停止（starting up or shutting down）和Session的創(chuàng)建和失效（created or destroyed）。應(yīng)用啟動事件發(fā)生在應(yīng)用第一次被Servlet容器裝載和啟動的時候；停止事件發(fā)生在Web應(yīng)用停止的時候。Session創(chuàng)建事件發(fā)生在每次一個新的session創(chuàng)建的時候，類似地Session失效事件發(fā)生在每次一個Session失效的時候。為了使用這些Web應(yīng)用事件做些有用的事情，我們必須創(chuàng)建和使用一些特殊的“監(jiān)聽類”。它們是實現(xiàn)了以下兩個接口中任何一個接口的簡單java類：javax.servlet.ServletContextListener或javax.servlet.http.HttpSessionListener，如果想讓你的類監(jiān)聽應(yīng)用的啟動和停止事件，你就得實現(xiàn)ServletContextListener接口；想讓你的類去監(jiān)聽Session的創(chuàng)建和失效事件，那你就得實現(xiàn)HttpSessionListener接口。

2. Listener配置：

配置Listener只要向Web應(yīng)用注冊Listener實現(xiàn)類即可，無序配置參數(shù)之類的東西，因為Listener獲取的是Web應(yīng)用ServletContext（application）的配置參數(shù)。為Web應(yīng)用配置Listener的兩種方式：

 使用@WebListener修飾Listener實現(xiàn)類即可。
 在web.xml文檔中使用<listener>進行配置。

我們選擇web.xml這種配置方式，只有一個元素<listener-class>指定Listener的實現(xiàn)類，如下所示：

<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

這里的<listener>用于Spring的加載，Spring加載可以利用ServletContextListener實現(xiàn)，也可以采用load-on-startup Servlet 實現(xiàn)，但是當<filter>需要用到bean時，但加載順序是：先加載<filter>后加載<servlet>，則<filter>中初始化操作中的bean為null；所以，如果過濾器中要使用到bean，此時就可以根據(jù)加載順序<listener> -> <filter> -> <servlet>，將spring的加載改成Listener的方式。

1) 利用ServletContextListener實現(xiàn)：

<servlet> 
   <servlet-name>context</servlet-narne> 
<servlet-class>org.springframework.web.context.ContextLoaderServlet</servlet-class> 
<load-on-startup>1</load-on-startup> 
</servlet>

2) 采用load-on-startup Servlet 實現(xiàn)：

<listener> 
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 
</listener>

我們選擇了第二種方式，在J2EE工程中web服務(wù)器啟動的時候最先調(diào)用web.xml，上面這段配置的意思是加載spring的監(jiān)聽器，其中ContextLoaderListener的作用就是啟動Web容器時，自動裝配applicationContext.xml的配置信息，執(zhí)行它所實現(xiàn)的方法。

8.<filter></filter>

<!--****************************過濾器配置*********************************--> 
 <!-- 字符集過濾器 --> 
 <filter> 
 <filter-name>CharacterEncodingFilter</filter-name> 
 <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> 
 <init-param> 
  <param-name>encoding</param-name> 
  <param-value>UTF-8</param-value> 
 </init-param> 
 <init-param> 
  <param-name>forceEncoding</param-name> 
  <param-value>true</param-value> 
 </init-param> 
 </filter> 
 <!-- 單點登出過濾器 --> 
 <filter> 
 <filter-name>CAS Single Sign Out Filter</filter-name> 
 <filter-class>com.yonyou.mcloud.cas.client.session.SingleSignOutFilter</filter-class> 
 </filter> 
 <!-- 認證過濾器 --> 
 <filter> 
 <filter-name>CAS Authentication Filter</filter-name> 
<filter-class>com.yonyou.mcloud.cas.client.authentication.ExpandAuthenticationFilter</filter-class> 
 <init-param> 
  <param-name>casServerLoginUrl</param-name> 
  <param-value>https://dev.yonyou.com:443/sso-server/login</param-value> 
 </init-param> 
 <init-param> 
  <!--這里的server是服務(wù)端的IP --> 
  <param-name>serverName</param-name> 
  <param-value>http://10.1.215.40:80</param-value> 
 </init-param> 
 </filter> 
 <!-- 驗證ST/PT過濾器 --> 
 <filter> 
 <filter-name>CAS Validation Filter</filter-name> 
<filter-class>org.jasig.cas.client.validation.Cas20ProxyReceivingTicketValidationFilter</filter-class> 
 <init-param> 
  <param-name>casServerUrlPrefix</param-name> 
  <param-value>https://dev.yonyou.com:443/sso-server</param-value> 
 </init-param> 
 <init-param> 
  <param-name>serverName</param-name> 
  <param-value>http://10.1.215.40:80</param-value> 
 </init-param> 
 <init-param> 
  <param-name>proxyCallbackUrl</param-name> 
  <param-value>https://dev.yonyou.com:443/business/proxyCallback</param-value> 
 </init-param> 
 <init-param> 
  <param-name>proxyReceptorUrl</param-name> 
  <param-value>/proxyCallback</param-value> 
 </init-param> 
 <init-param> 
  <param-name>proxyGrantingTicketStorageClass</param-name> 
<param-value>com.yonyou.mcloud.cas.client.proxy.MemcachedBackedProxyGrantingTicketStorageImpl</param-value> 
 </init-param> 
 <!-- 解決中文問題 --> 
 <init-param> 
  <param-name>encoding</param-name> 
  <param-value>UTF-8</param-value> 
 </init-param> 
 </filter> 
 <filter> 
 <filter-name>CAS HttpServletRequest Wrapper Filter</filter-name> 
 <filter-class>org.jasig.cas.client.util.HttpServletRequestWrapperFilter</filter-class> 
 </filter> 
 <filter> 
 <filter-name>CAS Assertion Thread Local Filter</filter-name> 
 <filter-class>org.jasig.cas.client.util.AssertionThreadLocalFilter</filter-class> 
 </filter> 
 <filter> 
 <filter-name>NoCache Filter</filter-name> 
 <filter-class>com.yonyou.mcloud.cas.client.authentication.NoCacheFilter</filter-class> 
 </filter> 
 <!--****************************映射關(guān)系配置********************************--> 
 <filter-mapping> 
 <filter-name>CharacterEncodingFilter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>NoCache Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>CAS Single Sign Out Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>CAS Validation Filter</filter-name> 
 <url-pattern>/proxyCallback</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>CAS Authentication Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>CAS Validation Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>CAS HttpServletRequest Wrapper Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
 <filter-mapping> 
 <filter-name>CAS Assertion Thread Local Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping>

1. Filter介紹：

Filter可認為是Servle的一種“加強版”，主要用于對用戶請求request進行預處理，也可以對Response進行后處理，是個典型的處理鏈。使用Filter的完整流程是：Filter對用戶請求進行預處理，接著將請求HttpServletRequest交給Servlet進行處理并生成響應(yīng)，最后Filter再對服務(wù)器響應(yīng)HttpServletResponse進行后處理。Filter與Servlet具有完全相同的生命周期，且Filter也可以通過<init-param>來配置初始化參數(shù)，獲取Filter的初始化參數(shù)則使用FilterConfig的getInitParameter()。
換種說法，Servlet里有request和response兩個對象，F(xiàn)ilter能夠在一個request到達Servlet之前預處理request，也可以在離開Servlet時處理response，F(xiàn)ilter其實是一個Servlet鏈。以下是Filter的一些常見應(yīng)用場合，

(1)認證Filter

(2)日志和審核Filter

(3)圖片轉(zhuǎn)換Filter

(4)數(shù)據(jù)壓縮Filter

(5)密碼Filter

(6)令牌Filter

(7)觸發(fā)資源訪問事件的Filter

(8)XSLT Filter

(9)媒體類型鏈Filter

Filter可負責攔截多個請求或響應(yīng)；一個請求或響應(yīng)也可被多個Filter攔截。創(chuàng)建一個Filter只需兩步：

創(chuàng)建Filter處理類

Web.xml文件中配置Filter

Filter必須實現(xiàn)javax.servlet.Filter接口，在該接口中定義了三個方法：

void init(FilterConfig config)：用于完成Filter的初始化。FilteConfig用于訪問Filter的配置信息。

void destroy()：用于Filter銷毀前，完成某些資源的回收。

void doFilter(ServletRequest request,ServletResponse response,FilterChain chain)：實現(xiàn)過濾功能的核心方法，該方法就是對每個請求及響應(yīng)增加額外的處理。該方法實現(xiàn)對用戶請求request進行預處理，也可以實現(xiàn)對服務(wù)器響應(yīng)response進行后處理---它們的分界線為是否調(diào)用了chain.doFilter(request，response)，執(zhí)行該方法之前，即對用戶請求request進行預處理，執(zhí)行該方法之后，即對服務(wù)器響應(yīng)response進行后處理。

2. Filter配置：

Filter可認為是Servlet的“增強版”，因此Filter配置與Servlet的配置非常相似，需要配置兩部分：配置Filter名稱和Filter攔截器URL模式。區(qū)別在于Servlet通常只配置一個URL，而Filter可以同時配置多個請求的URL。配置Filter有兩種方式：

 在Filter類中通過Annotation進行配置。

 在web.xml文件中通過配置文件進行配置。

我們使用的是web.xml這種配置方式，下面重點介紹<filter>內(nèi)包含的一些元素。

<filter>用于指定Web容器中的過濾器，可包含<filter-name>、<filter-class>、<init-param>、<icon>、<display-name>、<description>。
 <filter-name>用來定義過濾器的名稱，該名稱在整個程序中都必須唯一。
 <filter-class>元素指定過濾器類的完全限定的名稱，即Filter的實現(xiàn)類。
 <init-param>為Filter配置參數(shù)，與<context-param>具有相同的元素描述符<param-name>和<param-value>。
 <filter-mapping>元素用來聲明Web應(yīng)用中的過濾器映射，過濾器被映射到一個servlet或一個URL 模式。這個過濾器的<filter>和<filter-mapping>必須具有相同的<filter-name>，指定該Filter所攔截的URL。過濾是按照部署描述符的<filter-mapping>出現(xiàn)的順序執(zhí)行的。

1) 字符集過濾器

<!-- 字符集過濾器 --> 
 <filter> 
 <filter-name>CharacterEncodingFilter</filter-name> 
 <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> 
 <init-param> 
  <param-name>encoding</param-name> 
  <param-value>UTF-8</param-value> 
 </init-param> 
 <init-param> 
  <param-name>forceEncoding</param-name> 
  <param-value>true</param-value> 
 </init-param> 
 </filter> 
<filter-mapping> 
 <filter-name>CharacterEncodingFilter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
CharacterEncodingFilter類可以通過簡單配置來幫我們實現(xiàn)字符集轉(zhuǎn)換的功能，參數(shù)encoding用于指定編碼類型，參數(shù)forceEncoding設(shè)為true時，強制執(zhí)行request.setCharacterEncoding(this.encoding)和reponse.setCharacterEncoding(this.encoding)中的方法。
) 緩存控制
<filter> 
 <filter-name>NoCache Filter</filter-name> 
 <filter-class>com.yonyou.mcloud.cas.client.authentication.NoCacheFilter</filter-class> 
</filter> 
 <filter-mapping> 
<filter-name>NoCache Filter</filter-name> 
<!—表示對URL全部過濾--> 
 <url-pattern>/*</url-pattern> 
</filter-mapping> 
) 登錄認證
<!-- 認證過濾器 -->
<filter> 
 <filter-name>CAS Authentication Filter</filter-name> 
<filter-class>com.yonyou.mcloud.cas.client.authentication.ExpandAuthenticationFilter</filter-class> 
<init-param> 
  <param-name>casServerLoginUrl</param-name> 
  <param-value>https://dev.yonyou.com:443/sso-server/login</param-value> 
 </init-param> 
 <init-param> 
  <!--這里的server是服務(wù)端的IP --> 
  <param-name>serverName</param-name> 
  <param-value>http://10.1.215.40:80</param-value> 
 </init-param> 
 </filter> 
 <filter-mapping> 
  <filter-name>CAS Authentication Filter</filter-name> 
  <url-pattern>/*</url-pattern> 
 </filter-mapping>

登錄認證，未登錄用戶導向CAS Server進行認證。

4) 單點登出

<filter> 
   <filter-name>CAS Single Sign Out Filter</filter-name> 
   <filter-class>org.jasig.cas.client.session.SingleSignOutFilter</filter-class> 
</filter> 
<filter-mapping> 
   <filter-name>CAS Single Sign Out Filter</filter-name> 
   <url-pattern>/*</url-pattern> 
 
</filter-mapping> 
<listener> 
<listener-class>org.jasig.cas.client.session.SingleSignOutHttpSessionListener</listener-class> 
</listener>

CAS Server通知CAS Client，刪除session，注銷登錄信息。

) 封裝request

<filter> 
 <filter-name>CAS HttpServletRequest Wrapper Filter</filter-name> 
 <filter-class>org.jasig.cas.client.util.HttpServletRequestWrapperFilter</filter-class> 
</filter> 
<filter-mapping> 
 <filter-name>CAS HttpServletRequest Wrapper Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
</filter-mapping>

封裝request, 支持getUserPrincipal等方法。

6) 存放Assertion到ThreadLocal中

<filter> 
 <filter-name>CAS Assertion Thread Local Filter</filter-name> 
 <filter-class>org.jasig.cas.client.util.AssertionThreadLocalFilter</filter-class> 
</filter> 
<filter-mapping> 
 <filter-name>CAS Assertion Thread Local Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
</filter-mapping>

7) 禁用瀏覽器緩存

<filter> 
 <filter-name>NoCache Filter</filter-name> 
 <filter-class>com.yonyou.mcloud.cas.client.authentication.NoCacheFilter</filter-class> 
 </filter> 
 <filter-mapping> 
 <filter-name>NoCache Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping>

8) CAS Client向CAS Server進行ticket驗證

<!-- 驗證ST/PT過濾器 --> 
<filter> 
 <filter-name>CAS Validation Filter</filter-name> 
 <filter-class>org.jasig.cas.client.validation.Cas20ProxyReceivingTicketValidationFilter</filter-class> 
 <init-param> 
  <param-name>casServerUrlPrefix</param-name> 
  <param-value>https://dev.yonyou.com:443/sso-server</param-value> 
 </init-param> 
 <init-param> 
  <param-name>serverName</param-name> 
  <param-value>http://10.1.215.40:80</param-value> 
 </init-param> 
 <init-param> 
  <param-name>proxyCallbackUrl</param-name> 
  <param-value>https://dev.yonyou.com:443/business/proxyCallback</param-value> 
 </init-param> 
 <init-param> 
  <param-name>proxyReceptorUrl</param-name> 
  <param-value>/proxyCallback</param-value> 
 </init-param> 
 <init-param> 
  <param-name>proxyGrantingTicketStorageClass</param-name> 
<param-value>com.yonyou.mcloud.cas.client.proxy.MemcachedBackedProxyGrantingTicketStorageImpl</param-value> 
 </init-param> 
 <!-- 解決中文問題 --> 
 <init-param> 
  <param-name>encoding</param-name> 
  <param-value>UTF-8</param-value> 
 </init-param> 
</filter> 
<filter-mapping> 
 <filter-name>CAS Validation Filter</filter-name> 
 <url-pattern>/proxyCallback</url-pattern> 
</filter-mapping> 
<filter-mapping> 
 <filter-name>CAS Validation Filter</filter-name> 
 <url-pattern>/*</url-pattern> 
</filter-mapping>

9.<servlet></servlet>

<!--****************************servlet配置******************************--> 
<!-- Spring view分發(fā)器 對所有的請求都由business對應(yīng)的類來控制轉(zhuǎn)發(fā) --> 
<servlet> 
 <servlet-name>business</servlet-name> 
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
 <init-param> 
  <param-name>publishContext</param-name> 
  <param-value>false</param-value> 
 </init-param> 
 <load-on-startup>1</load-on-startup> 
</servlet> 
<!-- 用戶登出 --> 
<servlet> 
 <servlet-name>LogOutServlet</servlet-name> 
 <servlet-class>com.yonyou.mcloud.cas.web.servlet.LogOutServlet</servlet-class> 
 <init-param> 
  <param-name>serverLogoutUrl</param-name> 
  <param-value>https://dev.yonyou.com:443/sso-server/logout</param-value> 
 </init-param> 
 <init-param> 
  <param-name>serverName</param-name> 
  <param-value>http://10.1.215.40:80/business/</param-value> 
 </init-param> 
</servlet> 
<!--****************************servlet映射關(guān)系配置*************************--> 
<servlet-mapping> 
 <servlet-name>LogOutServlet</servlet-name> 
 <url-pattern>/logout</url-pattern> 
</servlet-mapping> 
<servlet-mapping> 
 <servlet-name>business</servlet-name> 
 <url-pattern>/</url-pattern> 
</servlet-mapping>

1.Servlet介紹：

Servlet通常稱為服務(wù)器端小程序，是運行在服務(wù)器端的程序，用于處理及響應(yīng)客戶的請求。Servlet是個特殊的java類，繼承于HttpServlet。客戶端通常只有GET和POST兩種請求方式，Servlet為了響應(yīng)則兩種請求，必須重寫doGet()和doPost()方法。大部分時候，Servlet對于所有的請求響應(yīng)都是完全一樣的，此時只需要重寫service()方法即可響應(yīng)客戶端的所有請求。

另外HttpServlet有兩個方法

init(ServletConfig config)：創(chuàng)建Servlet實例時，調(diào)用該方法的初始化Servlet資源。

destroy()：銷毀Servlet實例時，自動調(diào)用該方法的回收資源。

通常無需重寫init()和destroy()兩個方法，除非需要在初始化Servlet時，完成某些資源初始化的方法，才考慮重寫init()方法，如果重寫了init()方法，應(yīng)在重寫該方法的第一行調(diào)用super.init(config)，該方法將調(diào)用HttpServlet的init()方法。如果需要在銷毀Servlet之前，先完成某些資源的回收，比如關(guān)閉數(shù)據(jù)庫連接，才需要重寫destory方法()。

Servlet的生命周期：

創(chuàng)建Servlet實例有兩個時機：

客戶端第一次請求某個Servlet時，系統(tǒng)創(chuàng)建該Servlet的實例，大部分Servlet都是這種Servlet。

Web應(yīng)用啟動時立即創(chuàng)建Servlet實例，即load-on-start Servlet。

每個Servlet的運行都遵循如下生命周期：

1.創(chuàng)建Servlet實例。

2.Web容器調(diào)用Servlet的init()方法，對Servlet進行初始化。

3.Servlet初始化后，將一直存在于容器中，用于響應(yīng)客戶端請求，如果客戶端發(fā)送GET請求，容器調(diào)用Servlet的doGet()方法處理并響應(yīng)請求；如果客戶端發(fā)送POST請求，容器調(diào)用Servlet的doPost()方法處理并響應(yīng)請求?；蛘呓y(tǒng)一使用service()方法處理來響應(yīng)用戶請求。

4.Web容器決定銷毀Servlet時，先調(diào)用Servlet的destory()方法，通常在關(guān)閉Web應(yīng)用時銷毀Servlet實例。

2.Servlet配置：

為了讓Servlet能響應(yīng)用戶請求，還必須將Servlet配置在web應(yīng)用中，配置Servlet需要修改web.xml文件。

從Servlet3.0開始，配置Servlet有兩種方式：

在Servlet類中使用@WebServlet Annotation進行配置。
在web.xml文件中進行配置。

我們用web.xml文件來配置Servlet，需要配置<servlet>和<servlet-mapping>。

<servlet>用來聲明一個Servlet。<icon>、<display-name>和<description>元素的用法和<filter>的用法相同。<init-param>元素與<context-param>元素具有相同的元素描述符，可以使用<init-param>子元素將初始化參數(shù)名和參數(shù)值傳遞給Servlet，訪問Servlet配置參數(shù)通過ServletConfig對象來完成，ServletConfig提供如下方法：

java.lang.String.getInitParameter(java.lang.String name)：用于獲取初始化參數(shù)

ServletConfig獲取配置參數(shù)的方法和ServletContext獲取配置參數(shù)的方法完全一樣，只是ServletConfig是取得當前Servlet的配置參數(shù)，而ServletContext是獲取整個Web應(yīng)用的配置參數(shù)。

1.<description>、<display-name>和<icon>

<description>：為Servlet指定一個文本描述。

<display-name>：為Servlet提供一個簡短的名字被某些工具顯示。

<icon>：為Servlet指定一個圖標，在圖形管理工具中表示該Servlet。

2.<servlet-name>、<servlet-class>和<jsp-file>元素

<servlet>必須含有<servlet-name>和<servlet-class>，或者<servlet-name>和<jsp-file>。描述如下：

<servlet-name>用來定義servlet的名稱，該名稱在整個應(yīng)用中必須是惟一的

<servlet-class>用來指定servlet的完全限定的名稱。

<jsp-file>用來指定應(yīng)用中JSP文件的完整路徑。這個完整路徑必須由/開始。

3.<load-on-startup>

如果load-on-startup元素存在，而且也指定了jsp-file元素，則JSP文件會被重新編譯成Servlet，同時產(chǎn)生的Servlet也被載入內(nèi)存。<load-on-startup>的內(nèi)容可以為空，或者是一個整數(shù)。這個值表示由Web容器載入內(nèi)存的順序。

舉個例子：如果有兩個Servlet元素都含有<load-on-startup>子元素，則<load-on-startup>子元素值較小的Servlet將先被加載。如果<load-on-startup>子元素值為空或負值，則由Web容器決定什么時候加載Servlet。如果兩個Servlet的<load-on-startup>子元素值相同，則由Web容器決定先加載哪一個Servlet。

<load-on-startup>1</load-on-startup>表示啟動容器時，初始化Servlet。

4.<servlet-mapping>

<servlet-mapping>含有<servlet-name>和<url-pattern>

<servlet-name>：Servlet的名字，唯一性和一致性，與<servlet>元素中聲明的名字一致。

<url-pattern>：指定相對于Servlet的URL的路徑。該路徑相對于web應(yīng)用程序上下文的根路徑。<servlet-mapping>將URL模式映射到某個Servlet，即該Servlet處理的URL。

5.加載Servlet的過程

容器的Context對象對請求路徑(URL)做出處理，去掉請求URL的上下文路徑后，按路徑映射規(guī)則和Servlet映射路徑（<url- pattern>）做匹配，如果匹配成功，則調(diào)用這個Servlet處理請求。

3.DispatcherServlet在web.xml中的配置：

<!-- Spring view分發(fā)器 對所有的請求都由business對應(yīng)的類來控制轉(zhuǎn)發(fā) --> 
<servlet> 
 <servlet-name>business</servlet-name> 
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
 <init-param> 
  <param-name>publishContext</param-name> 
  <param-value>false</param-value> 
 </init-param> 
 <load-on-startup>1</load-on-startup> 
</servlet>

配置Spring MVC，指定處理請求的Servlet，有兩種方式：

 默認查找MVC配置文件的地址是：/WEB-INF/${servletName}-servlet.xml
 可以通過配置修改MVC配置文件的位置，需要在配置DispatcherServlet時指定MVC配置文件的位置。

我們在平臺項目兩個工程中分別使用了不同的配置方式，介紹如下：

我們在business-client工程中按照默認方式查找MVC的配置文件，配置文件目錄為： /WEB-INF/business-servlet.xml。工程目錄結(jié)構(gòu)如下所示：

我們在public-base-server工程中，通過第2種方式進行配置，把spring-servlet.xml放到src/main/resources/config/spring-servlet.xml，則需要在配置DispatcherServlet時指定<init-param>標簽。具體代碼如下：

<servlet> 
 <servlet-name>spring</servlet-name> 
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
  <init-param> 
    <param-name>publishContext</param-name> 
    <param-value>false</param-value> 
</init-param> 
 <init-param> 
      <param-name>contextConfigLocation</param-name> 
     <param-value>classpath:config/spring-servlet.xml</param-value> 
   </init-param> 
  <load-on-startup>1</load-on-startup> 
</servlet>

工程目錄結(jié)構(gòu)如下：

其中，classpath是web項目的類路徑，可以理解為classes下面。因為無論這些配置文件放在哪，編譯之后如果沒有特殊情況的話都直接在classes下面。jar包的話雖然放在lib文件夾里，但實際上那些類可以直接引用，比如：com.test.ABC，仿佛也在classes下面一樣。

在我們的工程里，經(jīng)過驗證，maven工程這兩個

路徑經(jīng)過編譯后生成的文件都位于classes目錄下，即這兩個路徑相當于類路徑，在下面創(chuàng)建config文件夾（folder），然后創(chuàng)建自定義的xml配置文件即可。

classpath和classpath*區(qū)別：

同名資源存在時，classpath只從第一個符合條件的classpath中加載資源，而classpath*會從所有的classpath中加載符合條件的資源。classpath*，需要遍歷所有的classpath，效率肯定比不上classpath，因此在項目設(shè)計的初期就盡量規(guī)劃好資源文件所在的路徑，避免使用classpath*來加載。

4.ContextLoaderListener和DispatcherServlet初始化上下文關(guān)系和區(qū)別：

從上圖可以看出，ContextLoaderListener初始化的上下文加載的Bean是對于整個應(yīng)用程序共享的，一般如：DAO層、Service層Bean；DispatcherServlet初始化的上下文加載的Bean是只對Spring MVC有效的Bean，如：Controller、HandlerMapping、HandlerAdapter等，該初始化上下文只加載Web相關(guān)組件。

注意：用戶可以配置多個DispatcherServlet來分別處理不同的url請求，每個DispatcherServlet上下文都對應(yīng)一個自己的子Spring容器，他們都擁有相同的父Spring容器（業(yè)務(wù)層，持久（dao）bean所在的容器）。

10.<welcome-file-list></welcome-file-list>

<!-- welcome page --> 
<welcome-file-list> 
 <welcome-file>index.html</welcome-file> 
</welcome-file-list>

<welcome-file-list>包含一個子元素<welcome-file>，<welcome-file>用來指定首頁文件名稱。<welcome-file-list>元素可以包含一個或多個<welcome-file>子元素。如果在第一個<welcome-file>元素中沒有找到指定的文件，Web容器就會嘗試顯示第二個，以此類推。

您可能感興趣的文章: