2022.5.10 Filter 过滤器

Filter 过滤器

什么是Filter过滤器

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

• Filter 过滤器它是 JavaEE 的规范。也就是接口

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

拦截请求常见的应用场景有：

• 权限检查

• 日记操作

• 事务管理 ……等等

Filter 的初体验

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

思考：根据之前我们学过内容。我们知道，用户登录之后都会把用户登录的信息保存到 Session 域中。所以要检查用户是否 登录，可以判断 Session 中否包含有用户登录的信息即可！！！

Filter 的工作流程图：

Filter 的代码：

package com.xing.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 {
        Filter.super.init(filterConfig);
    }
​
    /**
    * Description: 专门用于拦截请求 过滤响应(可以做权限检查)  相当servlet中的server方法
    */
    @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");
        // 如果等于 null，说明还没有登录
        if (user == null) {
            servletRequest.getRequestDispatcher("/index.jsp").forward(servletRequest,servletResponse);
        } else {
            // 让程序继续往下访问用户的目标资源  不执行这行代码就拦截
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }
​
    @Override
    public void destroy() {
        Filter.super.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.xing.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/*
        意思就是拦截http://ip:port/工程路径/admin 这个地址下的请求，进入doFilter方法
        -->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
</web-app>

上面代码的意思就是如果没有登陆就拦截掉web/admin目录下的所有的资源，filterChain.doFilter(servletRequest,servletResponse);这行代码就是将程序继续执行下去，不进行拦截，不执行这行代码就拦截

访问 http://localhost:8080/filter/admin/a.html 就会进入拦截器执行

Filter 过滤器的使用步骤：

• 编写一个类去实现 Filter 接口

• 实现过滤方法 doFilter()

• 到 web.xml 中去配置 Filter 的拦截路径

Filter 的生命周期

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

• 1、构造器方法

• 2、init 初始化方法 第 1，2 步，在 web 工程启动的时候执行（Filter 已经创建）

• 3、doFilter 过滤方法 第 3 步，每次拦截到请求就会执行

• 4、destroy 销毁 第 4 步，停止 web 工程的时候，就会执行（停止 web 工程，也会销毁 Filter 过滤器）

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
public class AdminFilter implements Filter {
​
​
    public AdminFilter() {
        System.out.println("构造器方法");
    }
​
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("init方法");
    }
​
    /**
    * Description: 专门用于拦截请求 过滤响应(可以做权限检查)  相当servlet中的server方法
    */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
​
        System.out.println("doFilter方法");
    }
​
    @Override
    public void destroy() {
        System.out.println("destroy方法");
        Filter.super.destroy();
    }
}

FilterConfig 类

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

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

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

• 获取 Filter 的名称 filter-name 的内容

• 获取在 Filter 中配置的 init-param 初始化参数

• 获取 ServletContext 对象

java 代码：

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
public class AdminFilter implements Filter {
​
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
​
        // 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());
    }
​
​
    /**
    * Description: 专门用于拦截请求 过滤响应(可以做权限检查)  相当servlet中的server方法
    */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
​
    }
​
    @Override
    public void destroy() {
        System.out.println("destroy方法");
        Filter.super.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.xing.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://localhost:3306</param-value>
        </init-param>
    </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/*
        意思就是拦截http://ip:port/工程路径/admin 这个地址下的请求，进入doFilter方法
        -->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
</web-app>

启动tomcat

FilterChain 过滤器链

FilterChain 就是过滤器链（多个过滤器如何一起工作）

情形1

Filter1

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
​
public class Filter1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
​
    @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() {
        Filter.super.destroy();
    }
}

Filter2

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
​
public class Filter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
​
    @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() {
        Filter.super.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-name>Filter1</filter-name>
        <filter-class>com.xing.filter.Filter1</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
​
​
    <filter>
        <filter-name>Filter2</filter-name>
        <filter-class>com.xing.filter.Filter2</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter2</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
​
</web-app>

target.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <%
        System.out.println("target.jsp执行了");
​
    %>
</body>
</html>

访问http://localhost:8080/filter/target.jsp

情形2

Filter1

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
​
public class Filter1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
​
    @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() {
        Filter.super.destroy();
    }
}

Filter2

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
​
public class Filter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
​
    @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() {
        Filter.super.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-name>Filter1</filter-name>
        <filter-class>com.xing.filter.Filter1</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
​
​
    <filter>
        <filter-name>Filter2</filter-name>
        <filter-class>com.xing.filter.Filter2</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter2</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
​
</web-app>

target.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <%
        System.out.println("target.jsp执行了");
​
    %>
</body>
</html>

访问http://localhost:8080/filter/target.jsp

特点

Filter1

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
​
public class Filter1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
​
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter1 前置代码");
        System.out.println("filter1 线程"+Thread.currentThread().getName());
        System.out.println("filter1 "+servletRequest.getParameter("username"));
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("filter1 线程"+Thread.currentThread().getName());
        System.out.println("filter1 后置代码");
​
    }
​
    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

Filter2

package com.xing.filter;
​
import javax.servlet.*;
import java.io.IOException;
​
public class Filter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
​
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter2 前置代码");
        System.out.println("filter2 线程"+Thread.currentThread().getName());
        System.out.println("filter2 "+servletRequest.getParameter("username"));
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("filter2 线程"+Thread.currentThread().getName());
        System.out.println("filter2 后置代码");
    }
​
    @Override
    public void destroy() {
        Filter.super.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-name>Filter1</filter-name>
        <filter-class>com.xing.filter.Filter1</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
​
​
    <filter>
        <filter-name>Filter2</filter-name>
        <filter-class>com.xing.filter.Filter2</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter2</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
​
</web-app>

target.jsp

<%--
  Created by IntelliJ IDEA.
  User: LXingTou
  Date: 2023/6/12
  Time: 22:50
  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执行了");
        System.out.println("target.jsp 线程"+Thread.currentThread().getName());
        System.out.println("target.jsp "+request.getParameter("username"));
​
​
    %>
</body>
</html>

访问http://localhost:8080/filter/target.jsp?username=xiaoming

线程相同，request域相同

Filter 的拦截路径

• 精确匹配

<filter>
    <filter-name>Filter2</filter-name>
    <filter-class>com.xing.filter.Filter2</filter-class>
</filter>
<filter-mapping>
    <filter-name>Filter2</filter-name>
    <url-pattern>/target.jsp</url-pattern>
</filter-mapping>

/target.jsp 以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/target.jsp 

• 目录匹配

<filter>
    <filter-name>AdminFilter</filter-name>
    <filter-class>com.xing.filter.AdminFilter</filter-class>
</filter>
​
<filter-mapping>
    <filter-name>AdminFilter</filter-name>
    <url-pattern>/admin/*</url-pattern>
</filter-mapping>

/admin/* 以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/admin/* 

• 后缀名匹配

<filter>
    <filter-name>Filter2</filter-name>
    <filter-class>com.xing.filter.Filter2</filter-class>
</filter>
<filter-mapping>
    <filter-name>Filter2</filter-name>
    <url-pattern>*.html</url-pattern>
</filter-mapping>

不要斜杠
*.html 以上配置的路径，表示请求地址必须以.html 结尾才会拦截到 

Filter 过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在！！！