Filter 過濾器的使用詳解

一.Filter 什么是過濾器

1、Filter 過濾器它是 JavaWeb 的三大組件之一。三大組件分別是：Servlet 程序、Listener 監聽器、Filter 過濾器

2、Filter 過濾器它是 JavaEE 的規范。也就是接口

3、Filter 過濾器它的作用是：攔截請求，過濾響應。

攔截請求常見的應用場景有：權限檢查、日記操作、事務管理……等等

 

二.Filter 的初體驗

要求：在你的 web 工程下，有一個 admin 目錄。這個 admin 目錄下的所有資源（html 頁面、jpg 圖片、jsp 文件、等等）都必須是用戶登錄之后才允許訪問。

思考：根據之前我們學過內容。我們知道，用戶登錄之后都會把用戶登錄的信息保存到 Session 域中。所以要檢查用戶是否登錄，可以判斷 Session 中是否包含有用戶登錄的信息即可！！！

Object user = session.getAttribute("user"); 
// 如果等於 null，說明還沒有登錄 
if (user == null) {     
request.getRequestDispatcher("/login.jsp").forward(request,response);
 return; 
}

 

Filter 的工作流程圖：

 

Filter 的代碼：

package com.atguigu.filter;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.io.IOException;

public class AdminFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    /**
     * 專門用於攔截請求，過濾響應。可以做權限檢查。
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");
        if (user == null) {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
            return;
        } else {
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }

    @Override
    public void destroy() {

    }
}

 

web.xml 中的配置：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--filter標簽用於配置一個Filter過濾器-->
    <filter>
        <!--給filter起一個別名-->
        <filter-name>AdminFilter</filter-name>
        <!--配置filter的全類名-->
        <filter-class>com.atguigu.filter.AdminFilter</filter-class>
    </filter>
    <!--filter-mapping配置Filter過濾器的攔截路徑-->
    <filter-mapping>
        <!--filter-name表示當前的攔截路徑給哪個filter使用-->
        <filter-name>AdminFilter</filter-name>
        <!--url-pattern配置攔截路徑-->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
</web-app>

 

Filter 過濾器的使用步驟：

1、編寫一個類去實現 Filter 接口

2、實現過濾方法 doFilter()

3、到 web.xml 中去配置 Filter 的攔截路徑

 

三.Filter 的生命周期 

Filter 的生命周期包含幾個方法

1、構造器方法

2、init 初始化方法

3、doFilter 過濾方法

4、destroy 銷毀

第 1，2 步，在 web 工程啟動的時候執行（Filter 已經創建）。第 3 步，每次攔截到請求，就會執行。第 4 步，停止 web 工程的時候，就會執行（停止 web 工程，也會銷毀 Filter 過濾器）

 

四.FilterConfig 類 

　　FilterConfig 類見名知義，它是 Filter 過濾器的配置文件類。Tomcat 每次創建 Filter 的時候，也會同時創建一個 FilterConfig 類，這里包含了 Filter 配置文件的配置信息。FilterConfig 類的作用是獲取 filter 過濾器的配置內容。

1、獲取 Filter 的名稱 filter-name 的內容

2、獲取在 Filter 中配置的 init-param 初始化參數

3、獲取 ServletContext 對象 

 

java 代碼：

@Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("2.Filter 的 init(FilterConfig filterConfig)初始化");
        // 1、獲取 Filter 的名稱 filter-name 的內容
        System.out.println("filter-name 的值是：" + filterConfig.getFilterName());
        // 2、獲取在 web.xml 中配置的 init-param 初始化參數
        System.out.println("初始化參數 username 的值是：" + filterConfig.getInitParameter("username"));
        System.out.println("初始化參數 url 的值是：" + filterConfig.getInitParameter("url"));
        // 3、獲取 ServletContext 對象 
        System.out.println(filterConfig.getServletContext());
    }

 

web.xml 配置：

<!--filter標簽用於配置一個Filter過濾器-->
    <filter>
        <!--給filter起一個別名-->
        <filter-name>AdminFilter</filter-name>
        <!--配置filter的全類名-->
        <filter-class>com.atguigu.filter.AdminFilter</filter-class>

        <init-param>
            <param-name>username</param-name>
            <param-value>root</param-value>
        </init-param>
        <init-param>
            <param-name>url</param-name>
            <param-value>jdbc:mysql://localhost3306/test</param-value>
        </init-param>
    </filter>

 

五.FilterChain 過濾器鏈

Filter　　過濾器

Chain　　鏈，鏈條

FilterChain 就是過濾器鏈（多個過濾器如何一起工作）

 

六.Filter 的攔截路徑

--精確匹配

<url-pattern>/target.jsp</url-pattern>

以上配置的路徑，表示請求地址必須為：http://ip:port/工程路徑/target.jsp

--目錄匹配

<url-pattern>/admin/*</url-pattern>

以上配置的路徑，表示請求地址必須為：http://ip:port/工程路徑/admin/*

--后綴名匹配

<url-pattern>*.html</url-pattern>

以上配置的路徑，表示請求地址必須以.html 結尾才會攔截到

<url-pattern>*.do</url-pattern>

以上配置的路徑，表示請求地址必須以.do 結尾才會攔截到

<url-pattern>*.action</url-pattern>

以上配置的路徑，表示請求地址必須以.action 結尾才會攔截到

Filter 過濾器它只關心請求的地址是否匹配，不關心請求的資源是否存在！！！