Servlet過慮器 - tw511教學網

過濾器是在請求的預處理和後處理時呼叫的物件。

主要用於執行轉換，紀錄檔記錄，壓縮，加解密，輸入驗證等過濾任務。

servlet過濾器是可插拔的，即它在web.xml檔案中定義，如果從web.xml檔案中刪除過濾項，則過濾器將被自動刪除，因此不需要手動更改Servlet。所以過濾器維護成本會比較低。

參考模型圖 -

注意：與Servlet不同，一個過濾器不依賴於另一個過濾器。

過濾器的使用

記錄所有傳入的請求
記錄來自標計算機的IP地址的請求
轉變/轉換
資料壓縮
加密和解密
輸入驗證等

過濾器的優點

過濾器是可插拔的。
一個過濾器不依賴於另一個資源。
維護少，比較容易維護。

過濾器API

像Servlet一樣，過濾器也有自己的API。 javax.servlet包中包含Filter API的三個介面，它們分別如下所示 -

Filter
FilterChain
FilterConfig

Filter介面

要建立一個過濾器，必須要實現Filter介面。Filter介面為過濾器提供了生命周期方法。

方法	描述
`public void init(FilterConfig config)`	`init()`方法只被呼叫一次，用於初始化過濾器。
`public void doFilter(HttpServletRequest request,HttpServletResponse response, FilterChain chain)`	當使用者請求過濾器所對映到資源時，會呼叫`doFilter()`方法，它用於執行過濾任務。
`public void destroy()`	當過濾器從服務中取出時，呼叫此方法(僅一次)。

FilterChain介面

FilterChain物件負責呼叫鏈中的下一個過濾器或資源。物件在Filter介面的doFilter方法中傳遞。FilterChain介面只包含一個方法：

public void doFilter(HttpServletRequest request，HttpServletResponse response)：它將控制元件傳遞給下一個過濾器或資源。

如何定義過濾器

我們可以使用與servlet相同方式來定義過濾器。下面來看看過濾器和過濾器對映的元素。在web.xml檔案組態如下 -

<web-app>  

<filter>  
  <filter-name>...</filter-name>  
  <filter-class>...</filter-class>  
</filter>  

<filter-mapping>  
  <filter-name>...</filter-name>  
  <url-pattern>...</url-pattern>  
</filter-mapping>  

</web-app>

對於對映過濾器，可以使用url-pattern或servlet-name。 url-pattern元素比servlet-name元素具有優勢，即它可以應用於servlet，JSP或HTML資源。

過濾器的簡單範例

在這個例子中，只是顯示在請求的後處理後自動呼叫過濾器的資訊。

開啟Eclipse，建立一個動態Web專案：SimpleFilter，其完整的目錄結構如下所示 -

以下是這個專案中的幾個主要的程式碼檔案。

檔案：index.html -

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>過濾器的簡單範例</title>
</head>
<body>
    <div style="font-align: center;">
        <a href="servlet1">檢視過濾器呼叫資訊</a>
    </div>
</body>
</html>

檔案：MyFilter.java

package com.yiibai;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.*;

public class MyFilter implements Filter {

    public void init(FilterConfig arg0) throws ServletException {
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
        request.setCharacterEncoding("UTF-8");
        PrintWriter out = response.getWriter();
        out.print("過濾器呼叫之前<br/>");

        chain.doFilter(request, response);// sends request to next resource

        out.print("過濾器呼叫之後<br/>");
    }

    public void destroy() {
    }
}

檔案：MyServlet.java

package com.yiibai;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.http.*;

public class MyServlet extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
        request.setCharacterEncoding("UTF-8");
        PrintWriter out = response.getWriter();
        out.print("  -- 這是一個簡單的測試Servlet.<br>");

    }

}

檔案：web.xml -

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
    id="WebApp_ID" version="3.1">
    <display-name>SimpleFilter</display-name>
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
    <servlet>
        <servlet-name>s1</servlet-name>
        <servlet-class>com.yiibai.MyServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>s1</servlet-name>
        <url-pattern>/servlet1</url-pattern>
    </servlet-mapping>

    <filter>
        <filter-name>f1</filter-name>
        <filter-class>com.yiibai.MyFilter</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>f1</filter-name>
        <url-pattern>/servlet1</url-pattern>
    </filter-mapping>
</web-app>

在編寫上面程式碼後，部署此Web應用程式(在專案名稱上點選右鍵->」Run On Server…」)，開啟瀏覽器存取URL： http://localhost:8080/SimpleFilter/ ，如果沒有錯誤，應該會看到以下結果 -

點選連結，得到以下結果 -

在上圖中，可以看到過濾器呼叫的順序。