Filter过滤器

一、Filter过滤器是什么？

1、Filter过滤器它是javaWeb的三大组件之一。三大组件分别是：Servlet程序、Listener监听器、Filter过滤器。

2、Filter过滤器它是javaEE的规范，也就是接口。

3、Filter过滤器它的作用是：拦截请求，过滤响应。

拦截请求常见的应用场景有：①权限检查，②日记操作，③事务管理等等。

二、Filter的初体验

要求在你的web工程下，有一个admin目录，这个admin目录下的所有资源(html页面，jpg图片，jsp文件)都必须是用户登录后才允许访问。

实现原理：

首先在web下面创建admin目录，并且创建一些资源,a.html  a.jsp. login.jsp,在没有登录的情况下访问admin下面的资源的时候，跳转到login.jsp

package com.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 {

    }

    /**
     * doFilter方法，专门用于拦截请求。可以做权限检查
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        HttpServletRequest request = (HttpServletRequest)servletRequest;
        HttpSession session  =request.getSession();

        Object user = session.getAttribute("user");
        //如果user为Null，说明还没有登陆
        if(user == null)
        {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
            return;
        }else
        {
            //让程序继续往下访问用户的目标资源
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }

    @Override
    public void destroy() {

    }
}

<?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.Filter.AdminFilter</filter-class>
    </filter>
    <!--filter-mapping配置Filter过滤器的拦截路径-->
    <filter-mapping>
        <!--filter-name表示当前的拦截路径给哪个filter使用-->
        <filter-name>AdminFilter</filter-name>
        <!--url-pattern配置拦截路径
               /  表示请求地址为：http://ip:port/工程路径/    映射到idea的web目录
               /admin/*  表示请求地址为：http://ip:port/工程路径/admin/*
        -->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
</web-app>

 

 

Filter过滤器的使用步骤：

     1、编写一个类去实现Filter接口

     2、实现拦截方法doFilter()

     3、到web.xml中配置Filter的拦截路径

三、Filter的生命周期 

Filter的生命周期 包含几个方法

      1、构造器方法

     2、init()方法

           第一二步在web工程启动的时候执行(Filter已经创建)

     3、doFilter()方法

          第三步，每次拦截到请求，就会执行

     4、destroy()方法

          第四步，停止web工程的时候就会执行(停止web工程也会销毁Filter)

四、FilterConfig类

      FilterConfig类见名知义，它是Filter过滤器的配置文件

      Tomcat每次创建Filter的时候，也会同时创建一个FilterConfig类，这里包含了Filter配置文件的配置信息

          FilterConfig类的作用是获取filter过滤器的配置内容

            1、获取Filter的名称   filter-name的内容

            2、获取在Filter中配置的init-parm初始化参数(在web.xml中配置的init-parm初始化参数)

            3、获取ServletContext对象

五、FilterChain过滤器链

多个过滤器执行的细节

Filter1

package com.Filter;

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

public class Filter1 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("Filter1前置代码");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("Filter1后置代码代码");
    }

    @Override
    public void destroy() {

    }
}

 Filter2

package com.Filter;

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

public class Filter2 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("Filter2前置代码");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("Filter2后置代码代码");
    }

    @Override
    public void destroy() {

    }
}

Target.jsp页面 

<%--
  Created by IntelliJ IDEA.
  User: lenovo
  Date: 2020/5/18
  Time: 21:14
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<%
    System.out.println("target.jsp页面执行了");
%>
</body>
</html>

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-name>Filter1</filter-name>
    <!--配置filter的全类名-->
    <filter-class>com.Filter.Filter1</filter-class>
</filter>
    <!--filter-mapping配置Filter过滤器的拦截路径-->
    <filter-mapping>
        <!--filter-name表示当前的拦截路径给哪个filter使用-->
        <filter-name>Filter1</filter-name>
        <!--url-pattern配置拦截路径
               /  表示请求地址为：http://ip:port/工程路径/    映射到idea的web目录
               /admin/*  表示请求地址为：http://ip:port/工程路径/admin/*
        -->
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
    <filter>
        <!--给filter起一个别名-->
        <filter-name>Filter2</filter-name>
        <!--配置filter的全类名-->
        <filter-class>com.Filter.Filter2</filter-class>
    </filter>
    <!--filter-mapping配置Filter过滤器的拦截路径-->
    <filter-mapping>
        <!--filter-name表示当前的拦截路径给哪个filter使用-->
        <filter-name>Filter2</filter-name>
        <!--url-pattern配置拦截路径
               /  表示请求地址为：http://ip:port/工程路径/    映射到idea的web目录
               /admin/*  表示请求地址为：http://ip:port/工程路径/admin/*
        -->
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
</web-app>

 

访问http://localhost:8080/15_Filter/target.jsp打印下面结果：

Filter1前置代码
Filter2前置代码
target.jsp页面执行了
Filter2后置代码代码
Filter1后置代码代码

六、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结尾才会拦截