Filter（過濾器）的入門案例以及其相關配置的分析

Filter：過濾器

Filter：過濾器

1. 概念：

web中的過濾器：當訪問服務器的資源時，過濾器可以將請求攔截下來，完成一些特殊的功能。
過濾器的作用：一般用於完成通用的操作。如：登錄驗證、統一編碼處理、敏感字符過濾…

2. 快速入門：

（1）. 步驟：
①. 定義一個類，實現接口Filter
②. 複寫方法
③. 配置攔截路徑【可以在web.xml和類文件中配置攔截路徑】
（2）. 代碼：
首先在src文件中創建FilterDemo1類文件。

在下面的入門案例中我們先用"註解"的方式

package cn.itcast.web.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
/**
 * 過濾器快速入門
 */
@WebFilter("/*")//訪問所有資源之前，都會執行該過濾器
public class FilterDemo1 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
  	}
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo被執行了...");
    }
    @Override
    public void destroy() {
    }
}

然後再在index.jsp中，加入內容，方便當我們訪問的時候，可以觀察到過濾器的功能。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>FilterDemo1</title>
  </head>
  <body>
  index.jsp
  </body>
</html>

通過以上的配置，當我們訪問tomcat目錄中的index.jsp文件的時候，瀏覽器並不會輸出相關的內容，因爲已經將資源攔截了。但是控制檯會輸出" filterDemo被執行了… " 。

@Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo被執行了...");
        //放行
        filterChain.doFilter(servletRequest,servletResponse);
    }

不過如果在doFilter方法中加上面的放行語句的話，就可以在瀏覽器上面看到我們在index.jsp文件寫入的相關內容。

3. 過濾器細節：

（1）. web.xml配置，同樣在瀏覽器中訪問tomcat目錄中的index.jsp文件的時候，過濾器一樣會執行。

<filter>
        <filter-name>demo1</filter-name>
        <filter-class>cn.itcast.web.filter.FilterDemo1</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>demo1</filter-name>
        <!--攔截路徑-->
        <url-pattern>/*</url-pattern>
    </filter-mapping>

（2）. 過濾器執行流程

①. 執行過濾器。
②. 執行放行後的資源。
③. 回來執行過濾器放行代碼下邊的代碼。
我們可以演示一下上面的執行流程，新建FilterDemo2，在這裏我們可以快速的創建Filter文件，File—>New—>Create New Filter

package cn.itcast.web.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class FilterDemo2 implements Filter {
    public void destroy() {
    }
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        //對request對象請求消息增強
        System.out.println("filterDemo2執行了...");
        //放行
        chain.doFilter(req, resp);
        //對response對象的響應消息增強
        System.out.println("filterDemo2回來了...");
    }
    public void init(FilterConfig config) throws ServletException {
    }
}

爲了便於觀察，我們在先前的index.jsp文件中加入下面的代碼：

<body>
index.jsp
<%
    System.out.println("index.jsp....");
%>
</body>

控制檯輸出結果爲：

（3）. 過濾器生命週期方法

①. init:在服務器啓動後，會創建Filter對象，然後調用init方法。只執行一次。用於加載資源
②. doFilter:每一次請求被攔截資源時，會執行。執行多次
③. destroy:在服務器關閉後，Filter對象被銷燬。如果服務器是正常關閉，則會執行destroy方法。只執行一次。用於釋放資源
通過運行一下的代碼，來看一下過濾器的生命週期

package cn.itcast.web.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/*")
public class FilterDemo3 implements Filter {
    /**
     * 在服務器關閉後,Filter對象被銷燬，如果服務器是正常關閉，則會執行destroy方法，只執行一次，釋放資源
     */
    public void destroy() {
        System.out.println("destroy...");
    }
    
    /**
     * 每一次請求被攔截資源時，會執行，執行多次
     */
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("doFilter...");
        //放行
        chain.doFilter(req, resp);
    }

    /**
     * 在服務器啓動後，會創建Filter對象，然後調用init方法，只執行一次
     */
    public void init(FilterConfig config) throws ServletException {
        System.out.println("init....");
    }
}

啓動tomcat服務器，啓動完成後，然後關閉tomcat服務器，控制檯輸出的順序爲：

init....
doFilter...
index.jsp....
destroy...

（4）. 過濾器配置詳解

攔截路徑配置：
①. 具體資源路徑： /index.jsp 只有訪問index.jsp資源時，過濾器纔會被執行
②. 攔截目錄： /user/* 訪問/user下的所有資源時，過濾器都會被執行
③. 後綴名攔截： * .jsp 訪問所有後綴名爲jsp資源時，過濾器都會被執行
④. 攔截所有資源：/* 訪問所有資源時，過濾器都會被執行

攔截方式配置：資源被訪問的方式
Ⅰ、註解配置：
* 設置dispatcherTypes屬性
1. REQUEST：默認值。瀏覽器直接請求資源
2. FORWARD：轉發訪問資源
3. INCLUDE：包含訪問資源
4. ERROR：錯誤跳轉資源
5. ASYNC：異步訪問資源
Ⅱ、web.xml配置
* 設置< dispatcher >< /dispatcher>標籤即可，標籤裏面可以設置上面的屬性和值
爲了演示攔截方式配置即資源被訪問的方式，首先創建filterDemo5文件，

package cn.itcast.web.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

//瀏覽器直接請求index.jsp資源時，該過濾器會被執行
//@WebFilter(value = "/index.jsp",dispatcherTypes = DispatcherType.REQUEST)

//只有轉發訪問index.jsp時，該過濾器纔會被執行。
//@WebFilter(value = "/index.jsp", dispatcherTypes = DispatcherType.FORWARD)  

//瀏覽器直接請求index.jsp或者轉發訪問index.jsp，該過濾器都會被執行
@WebFilter(value = "/index.jsp", dispatcherTypes = {DispatcherType.FORWARD, DispatcherType.REQUEST})//輸出updateServlet...filterDemo5....index.jsp....  ->filterDemo5....index.jsp....

public class FilterDemo5 implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("filterDemo5....");
        //放行
        chain.doFilter(req, resp);
    }

    public void init(FilterConfig config) throws ServletException {
    }

}

再創建一個ServletDemo2文件，此文件是爲了轉發到index.jsp頁面。

package cn.itcast.web.servlet;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/user/updateServlet")
public class ServletDemo2 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("updateServlet...");

        //轉發到index.jsp
        request.getRequestDispatcher("/index.jsp").forward(request,response);
    }
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        this.doPost(request, response);
    }
}

然後通過訪問index.jsp和/user/updateServlet兩個路徑，便可以清楚的發現資源的攔截方式

（5）. 過濾器鏈(配置多個過濾器)

執行順序：如果有兩個過濾器：過濾器1和過濾器2
①. 過濾器1
②. 過濾器2
③. 資源執行
④. 過濾器2
⑤. 過濾器1
過濾器先後順序問題：
①. 註解配置：按照類名的字符串比較規則比較，值小的先執行
* 如： AFilter 和 BFilter，AFilter就先執行了。
②. web.xml配置： < filter-mapping >誰定義在上邊，誰先執行

Filter(過濾器)的入門案例以及其相關配置的分析