Filter过滤器

WindyDante
196 阅读3分钟

1、什么是Filter过滤器

Filter过滤器是JavaWeb的三大组件之一。

三大组件分别是：Servlet程序、Listener监听器、Filter过滤器

Filter过滤器是JavaEE的规范，是一个接口。

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

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

​ 1、权限检查

​ 2、日记操作

​ 3、事务管理

​ 等等......

2、Filter过滤器的基本使用案例（拦截请求）

案例需要一个目录，目录里面可以有一些任意的文件

这里我使用的是一个admin目录，目录下有一些文件

图片.png

我在src目录下新建一个package，里面有一个AdminFilter类，用于实现拦截请求的方法

图片.png

AdminFilter类代码如下：

package com.eastwind.filter;

/*
@author zhangJH
@create 2023-06-27-16:51
*/


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

// 实现Filter接口
public class AdminFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    // doFilter方法：拦截请求，过滤响应
    // 拦截请求后，可以做权限检查
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 获取session域中的属性user
        HttpServletRequest httpServlet = (HttpServletRequest) servletRequest;
        HttpSession session = httpServlet.getSession();
        Object user = session.getAttribute("user");
        // 这里的案例user是没有设置的，所以一直会是null，你可以自己设置
        if (user == null) {
            // 如果用户未登录
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
        }
        else{
            // 用户已登录
            // doFilter让用户继续往下访问用户的目标资源
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }

    @Override
    public void destroy() {

    }
}

我们需要配置一下web.xml文件，因为Filter也需要配置，配置方法与Servlet程序类似

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

此时，访问目录图片.png

你会回到被拦截的那个路径下也就是图片.png

因为Filter过滤器，将你的请求过滤了，因为你没有登录，无法得到权限

根据用户是否有权限这个情况，决定是否要让你访问当前资源

图片.png

3、Filter的生命周期

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

​ 1、构造器方法

​ 在web工程启动时执行(Filter已经创建)

​ 2、init初始化方法

​ 在web工程启动时执行(Filter已经创建)

​ 3、doFilter过滤方法

​ 每次拦截到请求就会执行

​ 4、destory销毁方法

​ 停止web工程时执行，停止web工程也会销毁Filter过滤器

4、FilterConfig类

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

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

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

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

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

​ 3、获取ServletContext对象

获取init-param参数时，需要先在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.eastwind.filter.AdminFilter</filter-class>
        <init-param>
            <param-name>username</param-name>
            <param-value>root</param-value>
        </init-param>
        <init-param>
            <param-name>passwd</param-name>
            <param-value>123</param-value>
        </init-param>
    </filter>
<!--    配置Filter过滤器的拦截路径-->
    <filter-mapping>
<!--        filter-name表示当前的拦截路径给哪个Filter使用-->
        <filter-name>AdminFilter</filter-name>
<!--        配置Filter的拦截路径-->
<!--        /admin/*表示请求地址为：http://ip:port/工程路径/admin/*-->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>


</web-app>

@Override
    public void init(FilterConfig filterConfig) throws ServletException {
//        1、获取Filter的名称filter-name的内容
        System.out.println(filterConfig.getFilterName());
//        2、获取在Filter中配置的init-param初始化参数
        System.out.println(filterConfig.getInitParameter("username"));
        System.out.println(filterConfig.getInitParameter("passwd"));
//       3、获取ServletContext对象
        System.out.println(filterConfig.getServletContext());
    }

5、FilterChain 过滤器链

FilterChain过滤器链的执行步骤

多个Filter过滤器的执行特点：

​ 1、所有Filter和目标资源默认都执行在同一个线程中

​ 2、多个Filter和目标资源都使用同一个Request对象

FilterChain.doFilter()方法的作用

​ 1、执行下一个Filter过滤器(如果有Filter)

​ 2、执行目标资源(没有Filter)

例如下图所示：执行顺序为

​ Filter1前置代码1 --> Filter1chain.doFilter() --> Filter2前置代码1 --> Filter2chain.doFilter() --> 目标资源 --> Filter2后置代码2 --> Filter1后置代码2 --> 回到浏览器

图片.png

6、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>*.jsp</url-pattern>

以上配置的路径，表示请求地址必须以.jsp文件结尾才会拦截到

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

avatar
文章
阅读
粉丝