jsp 過濾器

jsp 和 servlet 中的過濾器都是 java 類。

過濾器可以動(dòng)態(tài)地?cái)r截請(qǐng)求和響應(yīng)，以變換或使用包含在請(qǐng)求或響應(yīng)中的信息。

可以將一個(gè)或多個(gè)過濾器附加到一個(gè) servlet 或一組 servlet。過濾器也可以附加到 javaserver pages (jsp) 文件和 html 頁面。

過濾器是可用于 servlet 編程的 java 類，可以實(shí)現(xiàn)以下目的：

在客戶端的請(qǐng)求訪問后端資源之前，攔截這些請(qǐng)求。
在服務(wù)器的響應(yīng)發(fā)送回客戶端之前，處理這些響應(yīng)。

根據(jù)規(guī)范建議的各種類型的過濾器：

身份驗(yàn)證過濾器（authentication filters）。
數(shù)據(jù)壓縮過濾器（data compression filters）。
加密過濾器（encryption filters）。
觸發(fā)資源訪問事件過濾器。
圖像轉(zhuǎn)換過濾器（image conversion filters）。
日志記錄和審核過濾器（logging and auditing filters）。
mime-type 鏈過濾器（mime-type chain filters）。
標(biāo)記化過濾器（tokenizing filters）。
xsl/t 過濾器（xsl/t filters），轉(zhuǎn)換 xml 內(nèi)容。

過濾器通過 web 部署描述符（web.xml）中的 xml 標(biāo)簽來聲明，然后映射到您的應(yīng)用程序的部署描述符中的 servlet 名稱或 url 模式。

當(dāng) web 容器啟動(dòng) web 應(yīng)用程序時(shí)，它會(huì)為您在部署描述符中聲明的每一個(gè)過濾器創(chuàng)建一個(gè)實(shí)例。

filter 的執(zhí)行順序與在 web.xml 配置文件中的配置順序一致，一般把 filter 配置在所有的 servlet 之前。

servlet 過濾器方法

過濾器是一個(gè)實(shí)現(xiàn)了 javax.servlet.filter 接口的 java 類。javax.servlet.filter 接口定義了三個(gè)方法：

序號(hào)	方法 & 描述
1	public void dofilter (servletrequest, servletresponse, filterchain) 該方法完成實(shí)際的過濾操作，當(dāng)客戶端的請(qǐng)求與過濾器設(shè)置的 url 匹配時(shí)，servlet 容器將先調(diào)用過濾器的 dofilter 方法。filterchain 用于訪問后續(xù)過濾器。
2	public void init(filterconfig filterconfig) web 應(yīng)用程序啟動(dòng)時(shí)，web 服務(wù)器將創(chuàng)建filter 的實(shí)例對(duì)象，并調(diào)用其init方法，讀取web.xml配置，完成對(duì)象的初始化功能，從而為后續(xù)的用戶請(qǐng)求作好攔截的準(zhǔn)備工作（filter對(duì)象只會(huì)創(chuàng)建一次，init方法也只會(huì)執(zhí)行一次）。開發(fā)人員通過init方法的參數(shù)，可獲得代表當(dāng)前filter配置信息的filterconfig對(duì)象。
3	public void destroy() servlet容器在銷毀過濾器實(shí)例前調(diào)用該方法，在該方法中釋放servlet過濾器占用的資源。

filterconfig 使用

filter 的 init 方法中提供了一個(gè) filterconfig 對(duì)象。

如 web.xml 文件配置如下：

<filter>
    <filter-name>logfilter</filter-name>
    <filter-class>com.yapf.test.logfilter</filter-class>
    <init-param>
        <param-name>site</param-name>
        <param-value>碩編程</param-value>
    </init-param>
    </filter>

在 init 方法使用 filterconfig 對(duì)象獲取參數(shù)：

public void  init(filterconfig config) throws servletexception {
    // 獲取初始化參數(shù)
    string site = config.getinitparameter("site"); 
    // 輸出初始化參數(shù)
    system.out.println("網(wǎng)站名稱: " + site); 
}

jsp 過濾器實(shí)例

以下是 servlet 過濾器的實(shí)例，將輸出網(wǎng)站名稱和地址。本實(shí)例讓您對(duì) servlet 過濾器有基本的了解，您可以使用相同的概念編寫更復(fù)雜的過濾器應(yīng)用程序：

//導(dǎo)入必需的 java 庫(kù)
import javax.servlet.*;
import java.util.*;

//實(shí)現(xiàn) filter 類
public class logfilter implements filter  {
    public void  init(filterconfig config) throws servletexception {
        // 獲取初始化參數(shù)
        string site = config.getinitparameter("site"); 

        // 輸出初始化參數(shù)
        system.out.println("網(wǎng)站名稱: " + site); 
    }
    public void  dofilter(servletrequest request, servletresponse response, filterchain chain) throws java.io.ioexception, servletexception {

        // 輸出站點(diǎn)名稱
        system.out.println("站點(diǎn)網(wǎng)址：http://www.slktour.com");

        // 把請(qǐng)求傳回過濾鏈
        chain.dofilter(request,response);
    }
    public void destroy( ){
        /* 在 filter 實(shí)例被 web 容器從服務(wù)移除之前調(diào)用 */
    }
}

displayheader.java 文件代碼如下：

//導(dǎo)入必需的 java 庫(kù)
import java.io.ioexception;
import java.io.printwriter;
import java.util.enumeration;

import javax.servlet.servletexception;
import javax.servlet.annotation.webservlet;
import javax.servlet.http.httpservlet;
import javax.servlet.http.httpservletrequest;
import javax.servlet.http.httpservletresponse;

@webservlet("/displayheader")

//擴(kuò)展 httpservlet 類
public class displayheader extends httpservlet {

    // 處理 get 方法請(qǐng)求的方法
    public void doget(httpservletrequest request, httpservletresponse response) throws servletexception, ioexception
    {
        // 設(shè)置響應(yīng)內(nèi)容類型
        response.setcontenttype("text/html;charset=utf-8");

        printwriter out = response.getwriter();
        string title = "http header 請(qǐng)求實(shí)例 - 碩編程實(shí)例";
        string doctype =
            "<!doctype html> \n";
            out.println(doctype +
            "<html>\n" +
            "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+
            "<body bgcolor=\"#f0f0f0\">\n" +
            "<h1 align=\"center\">" + title + "</h1>\n" +
            "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
            "<tr bgcolor=\"#949494\">\n" +
            "<th>header 名稱</th><th>header 值</th>\n"+
            "</tr>\n");

        enumeration headernames = request.getheadernames();

        while(headernames.hasmoreelements()) {
            string paramname = (string)headernames.nextelement();
            out.print("<tr><td>" + paramname + "</td>\n");
            string paramvalue = request.getheader(paramname);
            out.println("<td> " + paramvalue + "</td></tr>\n");
        }
        out.println("</table>\n</body></html>");
    }
    // 處理 post 方法請(qǐng)求的方法
    public void dopost(httpservletrequest request, httpservletresponse response) throws servletexception, ioexception {
        doget(request, response);
    }
}

web.xml 中的 servlet 過濾器映射（servlet filter mapping）

定義過濾器，然后映射到一個(gè) url 或 servlet，這與定義 servlet，然后映射到一個(gè) url 模式方式大致相同。在部署描述符文件 web.xml 中為 filter 標(biāo)簽創(chuàng)建下面的條目：

<?xml version="1.0" encoding="utf-8"?>  
<web-app>  
<filter>
  <filter-name>logfilter</filter-name>
  <filter-class>com.yapf.test.logfilter</filter-class>
  <init-param>
    <param-name>site</param-name>
    <param-value>碩編程</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>logfilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>  
  <!-- 類名 -->  
  <servlet-name>displayheader</servlet-name>  
  <!-- 所在的包 -->  
  <servlet-class>com.yapf.test.displayheader</servlet-class>  
</servlet>  
<servlet-mapping>  
  <servlet-name>displayheader</servlet-name>  
  <!-- 訪問的網(wǎng)址 -->  
  <url-pattern>/tomcattest/displayheader</url-pattern>  
</servlet-mapping>  
</web-app>

上述過濾器適用于所有的 servlet，因?yàn)槲覀冊(cè)谂渲弥兄付?/* 。如果您只想在少數(shù)的 servlet 上應(yīng)用過濾器，您可以指定一個(gè)特定的 servlet 路徑。

現(xiàn)在試著以常用的方式調(diào)用任何 servlet，您將會(huì)看到在 web 服務(wù)器中生成的日志。您也可以使用 log4j 記錄器來把上面的日志記錄到一個(gè)單獨(dú)的文件中。

接下來我們?cè)L問這個(gè)實(shí)例地址 http://localhost:8080/tomcattest/displayheader, 然后在控制臺(tái)看下輸出內(nèi)容，如下所示：

使用多個(gè)過濾器

web 應(yīng)用程序可以根據(jù)特定的目的定義若干個(gè)不同的過濾器。假設(shè)您定義了兩個(gè)過濾器 authenfilter 和 logfilter。您需要?jiǎng)?chuàng)建一個(gè)如下所述的不同的映射，其余的處理與上述所講解的大致相同：

<filter>
   <filter-name>logfilter</filter-name>
   <filter-class>com.yapf.test.logfilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>initialization paramter</param-value>
   </init-param>
</filter>

<filter>
   <filter-name>authenfilter</filter-name>
   <filter-class>com.yapf.test.authenfilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>initialization paramter</param-value>
   </init-param>
</filter>

<filter-mapping>
   <filter-name>logfilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

<filter-mapping>
   <filter-name>authenfilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

過濾器的應(yīng)用順序

web.xml 中的 filter-mapping 元素的順序決定了 web 容器應(yīng)用過濾器到 servlet 的順序。若要反轉(zhuǎn)過濾器的順序，您只需要在 web.xml 文件中反轉(zhuǎn) filter-mapping 元素即可。

例如，上面的實(shí)例將先應(yīng)用 logfilter，然后再應(yīng)用 authenfilter，但是下面的實(shí)例將顛倒這個(gè)順序：

<filter-mapping>
   <filter-name>authenfilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

<filter-mapping>
   <filter-name>logfilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

web.xml配置各節(jié)點(diǎn)說明

<filter>指定一個(gè)過濾器。
- <filter-name>用于為過濾器指定一個(gè)名字，該元素的內(nèi)容不能為空。
- <filter-class>元素用于指定過濾器的完整的限定類名。
- <init-param>元素用于為過濾器指定初始化參數(shù)，它的子元素<param-name>指定參數(shù)的名字，<param-value>指定參數(shù)的值。
- 在過濾器中，可以使用filterconfig接口對(duì)象來訪問初始化參數(shù)。
<filter-mapping>元素用于設(shè)置一個(gè) filter 所負(fù)責(zé)攔截的資源。一個(gè)filter攔截的資源可通過兩種方式來指定：servlet 名稱和資源訪問的請(qǐng)求路徑
- <filter-name>子元素用于設(shè)置filter的注冊(cè)名稱。該值必須是在<filter>元素中聲明過的過濾器的名字
- <url-pattern>設(shè)置 filter 所攔截的請(qǐng)求路徑(過濾器關(guān)聯(lián)的url樣式)
<servlet-name>指定過濾器所攔截的servlet名稱。
<dispatcher>指定過濾器所攔截的資源被 servlet 容器調(diào)用的方式，可以是request,include,forward和error之一，默認(rèn)request。用戶可以設(shè)置多個(gè)<dispatcher>子元素用來指定 filter 對(duì)資源的多種調(diào)用方式進(jìn)行攔截。
<dispatcher>子元素可以設(shè)置的值及其意義
- request：當(dāng)用戶直接訪問頁面時(shí)，web容器將會(huì)調(diào)用過濾器。如果目標(biāo)資源是通過requestdispatcher的include()或forward()方法訪問時(shí)，那么該過濾器就不會(huì)被調(diào)用。
- include：如果目標(biāo)資源是通過requestdispatcher的include()方法訪問時(shí)，那么該過濾器將被調(diào)用。除此之外，該過濾器不會(huì)被調(diào)用。
- forward：如果目標(biāo)資源是通過requestdispatcher的forward()方法訪問時(shí)，那么該過濾器將被調(diào)用，除此之外，該過濾器不會(huì)被調(diào)用。
- error：如果目標(biāo)資源是通過聲明式異常處理機(jī)制調(diào)用時(shí)，那么該過濾器將被調(diào)用。除此之外，過濾器不會(huì)被調(diào)用。

相關(guān)文章

JSP基礎(chǔ)