javax.servlet.Filter 新增過濾器
阿新 • • 發佈：2019-02-09
在請求到達Servlet/JSP之前，過濾器截獲請求。 在響應送給客戶端之前，過濾器截獲響應。
多個過濾器形成一個過濾器鏈，過濾器鏈中不同過濾器的先後順序由部署檔案web.xml中過濾器對映<filter-mapping>的順序決定。 最先截獲客戶端請求的過濾器將最後截獲Servlet/JSP的響應資訊。
可以為一個Web應用元件部署多個過濾器，這些過濾器組成一個過濾器鏈，每個過濾器只執行某個特定的操作或者檢查。這樣請求在到達被訪問的目標之前，需要經過這個過濾器鏈。
Servlet API的2.3版本的一個新功能就是能夠為servlet和JSP頁面定義過濾器。過濾器提供了某些早期伺服器所支援的非標準“servlet連結”的一種功能強大且標準的替代品。過濾器是一個程式，它先於與之相關的servlet或JSP頁面執行在伺服器上。過濾器可附加到一個或多個servlet或 JSP頁面上，並且可以檢查進入這些資源的請求資訊。在這之後，過濾器可以作如下的選擇：
以常規的方式呼叫資源（即，呼叫servlet或JSP頁面）。
利用修改過的請求資訊呼叫資源。
呼叫資源，但在傳送響應到客戶機前對其進行修改。
阻止該資源呼叫，代之以轉到其他的資源，返回一個特定的狀態程式碼或生成替換輸出。
過濾器只在與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繞過過濾器設定。
例如：建立一個實現Filter介面的類
所有過濾器都必須實現javax.servlet.Filter。這個介面包含三個方法，分別為doFilter、init和destroy。
1、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並直接傳送一個響應到客戶機。其次，如果希望修改相關的servlet或 JSP頁面的輸出，可把響應包含在一個收集所有傳送到它的輸出的物件中。然後，在呼叫serlvet或JSP頁面後，過濾器可檢查輸出，如果合適就修改它，之後傳送到客戶機。
DoFilter的最後一個引數為FilterChain物件。對此物件呼叫doFilter以啟用與servlet或JSP頁面相關的下一個過濾器。如果沒有另一個相關的過濾器，則對doFilter的呼叫啟用servlet或JSP本身。
2、public void init(FilterConfig config)thows ServletException
init 方法只在此過濾器第一次初始化時執行，不是每次呼叫過濾器都執行它。對於簡單的過濾器，可提供此方法的一個空體，但有兩個原因需要使用init。首先，FilterConfig物件提供對servlet環境及web.xml檔案中指派的過濾器名的訪問。因此，普遍的辦法是利用init將 FilterConfig物件存放在一個欄位中，以便doFilter方法能夠訪問servlet環境或過濾器名。其次，FilterConfig物件具有一個getInitParameter方法，它能夠訪問部署描述符檔案（web.xml）中分配的過濾器初始化引數。
3、public void destroy( )
此方法在利用一個給定的過濾器物件永久地終止伺服器（如關閉伺服器）時呼叫。大多數過濾器簡單地為此方法提供一個空體，不過，可利用它來完成諸如關閉過濾器使用的檔案或資料庫連線池等清除任務。
4、註冊過濾器
部署描述符檔案的2.3版本引入了兩個用於過濾器的元素，分別是：filter和filter-mapping。filter元素向系統註冊一個過濾物件，filter-mapping元素指定該過濾物件所應用的URL。
4.1)filter元素
filter元素位於部署描述符檔案（web.xml）的前部，所有filter-mapping、servlet或servlet-mapping元素之前。filter元素具有如下六個可能的子元素：
icon 這是一個可選的元素，它宣告IDE能夠使用的一個圖象檔案。
filter-name 這是一個必需的元素，它給過濾器分配一個選定的名字。
display-name 這是一個可選的元素，它給出IDE使用的短名稱。
description 這也是一個可選的元素，它給出IDE的資訊，提供文字文件。
filter-class 這是一個必需的元素，它指定過濾器實現類的完全限定名。
init-param 這是一個可選的元素，它定義可利用FilterConfig的getInitParameter方法讀取的初始化引數。單個過濾器元素可包含多個init-param元素。
filter-mapping元素
filter-mapping元素位於web.xml檔案中filter元素之後serlvet元素之前。它包含如下三個可能的子元素
@filter-name 這個必需的元素必須與用filter元素宣告時給予過濾器的名稱相匹配。
@url-pattern 此元素宣告一個以斜槓（/）開始的模式，它指定過濾器應用的URL。所有filter-mapping元素中必須提供url-pattern或 servlet-name。但不能對單個filter-mapping元素提供多個url-pattern元素項。如果希望過濾器適用於多個模式，可重複整個filter-mapping元素。
@servlet-name 此元素給出一個名稱，此名稱必須與利用servlet元素給予servlet或JSP頁面的名稱相匹配。不能給單個filter-mapping元素提供多個servlet-name元素項。如果希望過濾器適合於多個servlet名，可重複這個filter-mapping元素。
--------------------------------------------------------------------------------------------------
##程式碼示例一：
未登入無權訪問系統相關內容（如：使用者只有登陸之後才能瀏覽resource目錄下的資源，而這些resource的地址都是靜態地址，這時候就用到了過濾器）
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) req;
HttpServletResponse resp = (HttpServletResponse) res;
HttpSession session=req.getSession();
ServletContext application=session.getServletContext();
if(session.getAttribute("username")==null)
{
response.sendRedirect("error/priv_error.jsp");
return;
}
else
{
chain.doFilter(request, response);
}
}
web.xml中如下配置：
<filter>
<filter-name>myFilter</filter-name>
<filter-class>cn.com.test.filter.myFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>myFilter</filter-name>
<url-pattern>/resource/*</url-pattern>
</filter-mapping>
多個過濾器形成一個過濾器鏈，過濾器鏈中不同過濾器的先後順序由部署檔案web.xml中過濾器對映<filter-mapping>的順序決定。 最先截獲客戶端請求的過濾器將最後截獲Servlet/JSP的響應資訊。
可以為一個Web應用元件部署多個過濾器，這些過濾器組成一個過濾器鏈，每個過濾器只執行某個特定的操作或者檢查。這樣請求在到達被訪問的目標之前，需要經過這個過濾器鏈。
Servlet API的2.3版本的一個新功能就是能夠為servlet和JSP頁面定義過濾器。過濾器提供了某些早期伺服器所支援的非標準“servlet連結”的一種功能強大且標準的替代品。過濾器是一個程式，它先於與之相關的servlet或JSP頁面執行在伺服器上。過濾器可附加到一個或多個servlet或 JSP頁面上，並且可以檢查進入這些資源的請求資訊。在這之後，過濾器可以作如下的選擇：
以常規的方式呼叫資源（即，呼叫servlet或JSP頁面）。
利用修改過的請求資訊呼叫資源。
呼叫資源，但在傳送響應到客戶機前對其進行修改。
阻止該資源呼叫，代之以轉到其他的資源，返回一個特定的狀態程式碼或生成替換輸出。
過濾器只在與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繞過過濾器設定。
例如：建立一個實現Filter介面的類
所有過濾器都必須實現javax.servlet.Filter。這個介面包含三個方法，分別為doFilter、init和destroy。
1、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並直接傳送一個響應到客戶機。其次，如果希望修改相關的servlet或 JSP頁面的輸出，可把響應包含在一個收集所有傳送到它的輸出的物件中。然後，在呼叫serlvet或JSP頁面後，過濾器可檢查輸出，如果合適就修改它，之後傳送到客戶機。
DoFilter的最後一個引數為FilterChain物件。對此物件呼叫doFilter以啟用與servlet或JSP頁面相關的下一個過濾器。如果沒有另一個相關的過濾器，則對doFilter的呼叫啟用servlet或JSP本身。
2、public void init(FilterConfig config)thows ServletException
init 方法只在此過濾器第一次初始化時執行，不是每次呼叫過濾器都執行它。對於簡單的過濾器，可提供此方法的一個空體，但有兩個原因需要使用init。首先，FilterConfig物件提供對servlet環境及web.xml檔案中指派的過濾器名的訪問。因此，普遍的辦法是利用init將 FilterConfig物件存放在一個欄位中，以便doFilter方法能夠訪問servlet環境或過濾器名。其次，FilterConfig物件具有一個getInitParameter方法，它能夠訪問部署描述符檔案（web.xml）中分配的過濾器初始化引數。
3、public void destroy( )
此方法在利用一個給定的過濾器物件永久地終止伺服器（如關閉伺服器）時呼叫。大多數過濾器簡單地為此方法提供一個空體，不過，可利用它來完成諸如關閉過濾器使用的檔案或資料庫連線池等清除任務。
4、註冊過濾器
部署描述符檔案的2.3版本引入了兩個用於過濾器的元素，分別是：filter和filter-mapping。filter元素向系統註冊一個過濾物件，filter-mapping元素指定該過濾物件所應用的URL。
4.1)filter元素
filter元素位於部署描述符檔案（web.xml）的前部，所有filter-mapping、servlet或servlet-mapping元素之前。filter元素具有如下六個可能的子元素：
icon 這是一個可選的元素，它宣告IDE能夠使用的一個圖象檔案。
filter-name 這是一個必需的元素，它給過濾器分配一個選定的名字。
display-name 這是一個可選的元素，它給出IDE使用的短名稱。
description 這也是一個可選的元素，它給出IDE的資訊，提供文字文件。
filter-class 這是一個必需的元素，它指定過濾器實現類的完全限定名。
init-param 這是一個可選的元素，它定義可利用FilterConfig的getInitParameter方法讀取的初始化引數。單個過濾器元素可包含多個init-param元素。
filter-mapping元素
filter-mapping元素位於web.xml檔案中filter元素之後serlvet元素之前。它包含如下三個可能的子元素
@filter-name 這個必需的元素必須與用filter元素宣告時給予過濾器的名稱相匹配。
@url-pattern 此元素宣告一個以斜槓（/）開始的模式，它指定過濾器應用的URL。所有filter-mapping元素中必須提供url-pattern或 servlet-name。但不能對單個filter-mapping元素提供多個url-pattern元素項。如果希望過濾器適用於多個模式，可重複整個filter-mapping元素。
@servlet-name 此元素給出一個名稱，此名稱必須與利用servlet元素給予servlet或JSP頁面的名稱相匹配。不能給單個filter-mapping元素提供多個servlet-name元素項。如果希望過濾器適合於多個servlet名，可重複這個filter-mapping元素。
--------------------------------------------------------------------------------------------------
##程式碼示例一：
未登入無權訪問系統相關內容（如：使用者只有登陸之後才能瀏覽resource目錄下的資源，而這些resource的地址都是靜態地址，這時候就用到了過濾器）
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) req;
HttpServletResponse resp = (HttpServletResponse) res;
HttpSession session=req.getSession();
ServletContext application=session.getServletContext();
if(session.getAttribute("username")==null)
{
response.sendRedirect("error/priv_error.jsp");
return;
}
else
{
chain.doFilter(request, response);
}
}
web.xml中如下配置：
<filter>
<filter-name>myFilter</filter-name>
<filter-class>cn.com.test.filter.myFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>myFilter</filter-name>
<url-pattern>/resource/*</url-pattern>
</filter-mapping>