servlet和JSP過濾器Filter
阿新 • • 發佈：2019-01-16
或許，servlet API的2.3版本中最重要的一個新功能就是能夠為servlet和JSP頁面定義過濾器。過濾器提供了某些早期伺服器所支援的非標準“servlet連結”的一種功能強大且標準的替代品。
過濾器是一個程式，它先於與之相關的servlet或JSP頁面執行在伺服器上。過濾器可附加到一個或多個servlet或JSP頁面上，並且可以檢查進入這些資源的請求資訊。在這之後，過濾器可以作如下的選擇：
l 以常規的方式呼叫資源（即，呼叫servlet或JSP頁面）。
l 利用修改過的請求資訊呼叫資源。
l 呼叫資源，但在傳送響應到客戶機前對其進行修改
l 阻止該資源呼叫，代之以轉到其他的資源，返回一個特定的狀態程式碼或生成替換輸出。
過濾器提供了幾個重要好處。
首先，它以一種模組化的或可重用的方式封裝公共的行為。你有30個不同的serlvet或JSP頁面，需要壓縮它們的內容以減少下載時間嗎？沒問題：構造一個壓縮過濾器（參閱第11節），然後將它應用到30個資源上即可。
其次，利用它能夠將高階訪問決策與表現程式碼相分離。這對於JSP特別有價值，其中一般希望將幾乎整個頁面集中在表現上，而不是集中在業務邏輯上。例如，希望阻塞來自某些站點的訪問而不用修改各頁面（這些頁面受到訪問限制）嗎？沒問題：建立一個訪問限制過濾器（參閱第8節）並把它應用到想要限制訪問的頁面上即可。
最後，過濾器使你能夠對許多不同的資源進行批量性的更改。你有許多現存資源，這些資源除了公司名要更改外其他的保持不變，能辦到麼？沒問題：構造一個串替換過濾器（參閱第10節），只要合適就使用它。
但要注意，過濾器只在與servlet規範2.3版相容的伺服器上有作用。如果你的Web應用需要支援舊版伺服器，就不能使用過濾器。
1． 建立基本過濾器
建立一個過濾器涉及下列五個步驟：
1）建立一個實現Filter介面的類。這個類需要三個方法，分別是：doFilter、init和destroy。doFilter方法包含主要的過濾程式碼（見第2步），init方法建立設定操作，而destroy方法進行清楚。
2）在doFilter方法中放入過濾行為。doFilter方法的第一個引數為ServletRequest物件。此物件給過濾器提供了對進入的資訊（包括表單資料、cookie和HTTP請求頭）的完全訪問。第二個引數為ServletResponse，通常在簡單的過濾器中忽略此引數。最後一個引數為FilterChain，如下一步所述，此引數用來呼叫servlet或JSP頁。
3）呼叫FilterChain物件的doFilter方法。Filter介面的doFilter方法取一個FilterChain物件作為它的一個引數。在呼叫此物件的doFilter方法時，啟用下一個相關的過濾器。如果沒有另一個過濾器與servlet或JSP頁面關聯，則servlet或JSP頁面被啟用。
4）對相應的servlet和JSP頁面註冊過濾器。在部署描述符檔案（web.xml）中使用filter和filter-mapping元素。
5）禁用啟用器servlet。防止使用者利用預設servlet URL繞過過濾器設定。
1.1 建立一個實現Filter介面的類
所有過濾器都必須實現javax.servlet.Filter。這個介面包含三個方法，分別為doFilter、init和destroy。
l public void doFilter(ServletRequset request,
ServletResponse response,
FilterChain chain)
thows ServletException, IOException
每當呼叫一個過濾器（即，每次請求與此過濾器相關的servlet或JSP頁面）時，就執行其doFilter方法。正是這個方法包含了大部分過濾邏輯。
第一個引數為與傳入請求有關的ServletRequest。對於簡單的過濾器，大多數過濾邏輯是基於這個物件的。如果處理HTTP請求，並且需要訪問諸如getHeader或getCookies等在ServletRequest中無法得到的方法，就要把此物件構造成HttpServletRequest。
第二個引數為ServletResponse。除了在兩個情形下要使用它以外，通常忽略這個引數。首先，如果希望完全阻塞對相關servlet或JSP頁面的訪問。可呼叫response.getWriter並直接傳送一個響應到客戶機。第7節給出詳細內容，第8節給出一個例子。其次，如果希望修改相關的servlet或JSP頁面的輸出，可把響應包含在一個收集所有傳送到它的輸出的物件中。然後，在呼叫serlvet或JSP頁面後，過濾器可檢查輸出，如果合適就修改它，之後傳送到客戶機。詳情請參閱第9節。
DoFilter的最後一個引數為FilterChain物件。對此物件呼叫doFilter以啟用與servlet或JSP頁面相關的下一個過濾器。如果沒有另一個相關的過濾器，則對doFilter的呼叫啟用servlet或JSP本身。
l public void init(FilterConfig config)
thows ServletException
init方法只在此過濾器第一次初始化時執行，不是每次呼叫過濾器都執行它。對於簡單的過濾器，可提供此方法的一個空體，但有兩個原因需要使用init。首先，FilterConfig物件提供對servlet環境及web.xml檔案中指派的過濾器名的訪問。因此，普遍的辦法是利用init將FilterConfig物件存放在一個欄位中，以便doFilter方法能夠訪問servlet環境或過濾器名。這種處理在第3節描述。其次，FilterConfig物件具有一個getInitParameter方法，它能夠訪問部署描述符檔案（web.xml）中分配的過濾器初始化引數。初始化引數的使用在第5節中描述。
l public void destroy( )
此方法在利用一個給定的過濾器物件永久地終止伺服器（如關閉伺服器）時呼叫。大多數過濾器簡單地為此方法提供一個空體，不過，可利用它來完成諸如關閉過濾器使用的檔案或資料庫連線池等清除任務。
1.2 將過濾行為放入doFilter方法
doFilter方法為大多數過濾器地關鍵部分。每當呼叫一個過濾器時，都要執行doFilter。對於大多數過濾器來說，doFilter執行的步驟是基於傳入的資訊的。因此，可能要利用作為doFilter的第一個引數提供的ServletRequest。這個物件常常構造為HttpServletRequest型別，以提供對該類的更特殊方法的訪問。
1.3 呼叫FilterChain物件的doFilter方法
Filter介面的doFilter方法以一個FilterChain物件作為它的第三個引數。在呼叫該物件的doFilter方法時，啟用下一個相關的過濾器。這個過程一般持續到鏈中最後一個過濾器為止。在最後一個過濾器呼叫其FilterChain物件的doFilter方法時，啟用servlet或頁面自身。
但是，鏈中的任意過濾器都可以通過不呼叫其FilterChain的doFilter方法中斷這個過程。在這樣的情況下，不再呼叫JSP頁面的serlvet，並且中斷此呼叫過程的過濾器負責將輸出提供給客戶機。詳情請參閱第7節。
1.4 對適當的servlet和JSP頁面註冊過濾器
部署描述符檔案的2.3版本引入了兩個用於過濾器的元素，分別是：filter和filter-mapping。filter元素向系統註冊一個過濾物件，filter-mapping元素指定該過濾物件所應用的URL。
1.filter元素
filter元素位於部署描述符檔案（web.xml）的前部，所有filter-mapping、servlet或servlet-mapping元素之前。filter元素具有如下六個可能的子元素：
l icon 這是一個可選的元素，它宣告IDE能夠使用的一個圖象檔案。
l filter-name 這是一個必需的元素，它給過濾器分配一個選定的名字。
l display-name 這是一個可選的元素，它給出IDE使用的短名稱。
l description 這也是一個可選的元素，它給出IDE的資訊，提供文字文件。
l filter-class 這是一個必需的元素，它指定過濾器實現類的完全限定名。
l init-param 這是一個可選的元素，它定義可利用FilterConfig的getInitParameter方法讀取的初始化引數。單個過濾器元素可包含多個init-param元素。
請注意，過濾是在serlvet規範2.3版中初次引入的。因此，web.xml檔案必須使用DTD的2.3版本。下面介紹一個簡單的例子：
<?xml version="1.0" encoding="ISO-8859-1"?>
web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
MyFilter
myPackage.FilterClass
<?xml version="1.0" encoding="ISO-8859-1"?>
web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
MyFilter
myPackage.FilterClass
SomeFilter
somePackage.SomeFilterClass
SomeFilter
somePackage.SomeFilterClass
<?xml version="1.0" encoding="ISO-8859-1"?>
web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
package moreservlets.filters;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*; // For Date class
/** Simple filter that prints a report on the standard output
* each time an associated servlet or JSP page is accessed.
*/
public class ReportFilter implements Filter {
public void doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
throws ServletException, IOException {
HttpServletRequest req = (HttpServletRequest)request;
System.out.println(req.getRemoteHost() +
" tried to access " +
req.getRequestURL() +
" on " + new Date() + ".");
chain.doFilter(request,response);
}
public void init(FilterConfig config)
throws ServletException {
}
public void destroy() {}
}
程式清單9-3 web.xml（針對報告過濾器的摘錄）
過濾器是一個程式，它先於與之相關的servlet或JSP頁面執行在伺服器上。過濾器可附加到一個或多個servlet或JSP頁面上，並且可以檢查進入這些資源的請求資訊。在這之後，過濾器可以作如下的選擇：
l 以常規的方式呼叫資源（即，呼叫servlet或JSP頁面）。
l 利用修改過的請求資訊呼叫資源。
l 呼叫資源，但在傳送響應到客戶機前對其進行修改
l 阻止該資源呼叫，代之以轉到其他的資源，返回一個特定的狀態程式碼或生成替換輸出。
過濾器提供了幾個重要好處。
首先，它以一種模組化的或可重用的方式封裝公共的行為。你有30個不同的serlvet或JSP頁面，需要壓縮它們的內容以減少下載時間嗎？沒問題：構造一個壓縮過濾器（參閱第11節），然後將它應用到30個資源上即可。
其次，利用它能夠將高階訪問決策與表現程式碼相分離。這對於JSP特別有價值，其中一般希望將幾乎整個頁面集中在表現上，而不是集中在業務邏輯上。例如，希望阻塞來自某些站點的訪問而不用修改各頁面（這些頁面受到訪問限制）嗎？沒問題：建立一個訪問限制過濾器（參閱第8節）並把它應用到想要限制訪問的頁面上即可。
最後，過濾器使你能夠對許多不同的資源進行批量性的更改。你有許多現存資源，這些資源除了公司名要更改外其他的保持不變，能辦到麼？沒問題：構造一個串替換過濾器（參閱第10節），只要合適就使用它。
但要注意，過濾器只在與servlet規範2.3版相容的伺服器上有作用。如果你的Web應用需要支援舊版伺服器，就不能使用過濾器。
1． 建立基本過濾器
建立一個過濾器涉及下列五個步驟：
1）建立一個實現Filter介面的類。這個類需要三個方法，分別是：doFilter、init和destroy。doFilter方法包含主要的過濾程式碼（見第2步），init方法建立設定操作，而destroy方法進行清楚。
2）在doFilter方法中放入過濾行為。doFilter方法的第一個引數為ServletRequest物件。此物件給過濾器提供了對進入的資訊（包括表單資料、cookie和HTTP請求頭）的完全訪問。第二個引數為ServletResponse，通常在簡單的過濾器中忽略此引數。最後一個引數為FilterChain，如下一步所述，此引數用來呼叫servlet或JSP頁。
3）呼叫FilterChain物件的doFilter方法。Filter介面的doFilter方法取一個FilterChain物件作為它的一個引數。在呼叫此物件的doFilter方法時，啟用下一個相關的過濾器。如果沒有另一個過濾器與servlet或JSP頁面關聯，則servlet或JSP頁面被啟用。
4）對相應的servlet和JSP頁面註冊過濾器。在部署描述符檔案（web.xml）中使用filter和filter-mapping元素。
5）禁用啟用器servlet。防止使用者利用預設servlet URL繞過過濾器設定。
1.1 建立一個實現Filter介面的類
所有過濾器都必須實現javax.servlet.Filter。這個介面包含三個方法，分別為doFilter、init和destroy。
l public void doFilter(ServletRequset request,
ServletResponse response,
FilterChain chain)
thows ServletException, IOException
每當呼叫一個過濾器（即，每次請求與此過濾器相關的servlet或JSP頁面）時，就執行其doFilter方法。正是這個方法包含了大部分過濾邏輯。
第一個引數為與傳入請求有關的ServletRequest。對於簡單的過濾器，大多數過濾邏輯是基於這個物件的。如果處理HTTP請求，並且需要訪問諸如getHeader或getCookies等在ServletRequest中無法得到的方法，就要把此物件構造成HttpServletRequest。
第二個引數為ServletResponse。除了在兩個情形下要使用它以外，通常忽略這個引數。首先，如果希望完全阻塞對相關servlet或JSP頁面的訪問。可呼叫response.getWriter並直接傳送一個響應到客戶機。第7節給出詳細內容，第8節給出一個例子。其次，如果希望修改相關的servlet或JSP頁面的輸出，可把響應包含在一個收集所有傳送到它的輸出的物件中。然後，在呼叫serlvet或JSP頁面後，過濾器可檢查輸出，如果合適就修改它，之後傳送到客戶機。詳情請參閱第9節。
DoFilter的最後一個引數為FilterChain物件。對此物件呼叫doFilter以啟用與servlet或JSP頁面相關的下一個過濾器。如果沒有另一個相關的過濾器，則對doFilter的呼叫啟用servlet或JSP本身。
l public void init(FilterConfig config)
thows ServletException
init方法只在此過濾器第一次初始化時執行，不是每次呼叫過濾器都執行它。對於簡單的過濾器，可提供此方法的一個空體，但有兩個原因需要使用init。首先，FilterConfig物件提供對servlet環境及web.xml檔案中指派的過濾器名的訪問。因此，普遍的辦法是利用init將FilterConfig物件存放在一個欄位中，以便doFilter方法能夠訪問servlet環境或過濾器名。這種處理在第3節描述。其次，FilterConfig物件具有一個getInitParameter方法，它能夠訪問部署描述符檔案（web.xml）中分配的過濾器初始化引數。初始化引數的使用在第5節中描述。
l public void destroy( )
此方法在利用一個給定的過濾器物件永久地終止伺服器（如關閉伺服器）時呼叫。大多數過濾器簡單地為此方法提供一個空體，不過，可利用它來完成諸如關閉過濾器使用的檔案或資料庫連線池等清除任務。
1.2 將過濾行為放入doFilter方法
doFilter方法為大多數過濾器地關鍵部分。每當呼叫一個過濾器時，都要執行doFilter。對於大多數過濾器來說，doFilter執行的步驟是基於傳入的資訊的。因此，可能要利用作為doFilter的第一個引數提供的ServletRequest。這個物件常常構造為HttpServletRequest型別，以提供對該類的更特殊方法的訪問。
1.3 呼叫FilterChain物件的doFilter方法
Filter介面的doFilter方法以一個FilterChain物件作為它的第三個引數。在呼叫該物件的doFilter方法時，啟用下一個相關的過濾器。這個過程一般持續到鏈中最後一個過濾器為止。在最後一個過濾器呼叫其FilterChain物件的doFilter方法時，啟用servlet或頁面自身。
但是，鏈中的任意過濾器都可以通過不呼叫其FilterChain的doFilter方法中斷這個過程。在這樣的情況下，不再呼叫JSP頁面的serlvet，並且中斷此呼叫過程的過濾器負責將輸出提供給客戶機。詳情請參閱第7節。
1.4 對適當的servlet和JSP頁面註冊過濾器
部署描述符檔案的2.3版本引入了兩個用於過濾器的元素，分別是：filter和filter-mapping。filter元素向系統註冊一個過濾物件，filter-mapping元素指定該過濾物件所應用的URL。
1.filter元素
filter元素位於部署描述符檔案（web.xml）的前部，所有filter-mapping、servlet或servlet-mapping元素之前。filter元素具有如下六個可能的子元素：
l icon 這是一個可選的元素，它宣告IDE能夠使用的一個圖象檔案。
l filter-name 這是一個必需的元素，它給過濾器分配一個選定的名字。
l display-name 這是一個可選的元素，它給出IDE使用的短名稱。
l description 這也是一個可選的元素，它給出IDE的資訊，提供文字文件。
l filter-class 這是一個必需的元素，它指定過濾器實現類的完全限定名。
l init-param 這是一個可選的元素，它定義可利用FilterConfig的getInitParameter方法讀取的初始化引數。單個過濾器元素可包含多個init-param元素。
請注意，過濾是在serlvet規範2.3版中初次引入的。因此，web.xml檔案必須使用DTD的2.3版本。下面介紹一個簡單的例子：
<?xml version="1.0" encoding="ISO-8859-1"?>
web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
MyFilter
myPackage.FilterClass
<?xml version="1.0" encoding="ISO-8859-1"?>
web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
MyFilter
myPackage.FilterClass
SomeFilter
somePackage.SomeFilterClass
SomeFilter
somePackage.SomeFilterClass
<?xml version="1.0" encoding="ISO-8859-1"?>
web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
package moreservlets.filters;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*; // For Date class
/** Simple filter that prints a report on the standard output
* each time an associated servlet or JSP page is accessed.
*/
public class ReportFilter implements Filter {
public void doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
throws ServletException, IOException {
HttpServletRequest req = (HttpServletRequest)request;
System.out.println(req.getRemoteHost() +
" tried to access " +
req.getRequestURL() +
" on " + new Date() + ".");
chain.doFilter(request,response);
}
public void init(FilterConfig config)
throws ServletException {
}
public void destroy() {}
}
程式清單9-3 web.xml（針對報告過濾器的摘錄）