天天看點

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

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

  • Filter:過濾器
      • 1. 概念:
      • 2. 快速入門:
      • 3. 過濾器細節:
        • (1). web.xml配置,同樣在浏覽器中通路tomcat目錄中的index.jsp檔案的時候,過濾器一樣會執行。
        • (2). 過濾器執行流程
        • (3). 過濾器生命周期方法
        • (4). 過濾器配置詳解
        • (5). 過濾器鍊(配置多個過濾器)

Filter:過濾器

1. 概念:

  • web中的過濾器:當通路伺服器的資源時,過濾器可以将請求攔截下來,完成一些特殊的功能。
  • 過濾器的作用:一般用于完成通用的操作。如:登入驗證、統一編碼處理、敏感字元過濾…

2. 快速入門:

(1). 步驟:

①. 定義一個類,實作接口Filter

②. 複寫方法

③. 配置攔截路徑【可以在web.xml和類檔案中配置攔截路徑】

(2). 代碼:

首先在src檔案中建立FilterDemo1類檔案。

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

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

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>
           

控制台輸出結果為:

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

(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 >誰定義在上邊,誰先執行