javaEE-04-Filter

文章目录

Filter
- Filter 的生命周期
- FilterConfig类
- FilterChain过滤器链
- Filter 的拦截路径

Filter

Filter 过滤器它是 JavaWeb 的三大组件之一,它是 JavaEE 的规范。也就是接口,它的作用是：拦截请求，过滤响应。

Filter的工作流程图解：
在这里插入图片描述

以管理员登录为例介绍一下过滤器的使用：

在web资源目录下面创建一个admin目录，在这里面存放一个index.html界面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>管理员管理界面</h1>
</body>
</html>

在src目录下面创建一个filter目录，创建一个过滤类AdminFilter

package 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 方法，专门用于拦截请求。可以做权限检查
     */
    @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("/login.jsp").forward(servletRequest, servletResponse);
        } 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>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>

启动服务器，访问http://localhost:8080/javaee_tomcat_war_exploded/admin/index.html这个路径。

在我们访问这个请求的时候直接就被请求转发到了login.html界面，这是因为我们在web.xml中配置了该过滤器的访问请求，就是所有项目路径下面的admin路径下面的资源都会被过滤到，当我们发送http://localhost:8080/javaee_tomcat_war_exploded/admin/index.html这个请求的时候就会经过过滤器，此时，过滤器就会执行到doFilter（）方法来对这个请求进行拦截，在这个方法中会对session中的值user进行获取，如果获取不到值就会请求转发到login.html界面。

Filter 的生命周期

构造器方法
init 初始化方法
doFilter 过滤方法
destroy 销毁

注意：
第 1，2 步，在 web 工程启动的时候执行（Filter 已经创建），第 3 步，每次拦截到请求，就会执行，第 4 步，停止 web 工程的时候，就会执行（停止 web 工程，也会销毁 Filter 过滤器）

FilterConfig类

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

作用：

获取 Filter 的名称 filter-name 的内容
获取在 Filter 中配置的 init-param 初始化参数
获取 ServletContext 对象

在web.xml中添加filter的配置

<?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>filter.AdminFilter</filter-class>

        <init-param>
            <param-name>username</param-name>
            <param-value>root</param-value>
        </init-param>

        <init-param>
            <param-name>password</param-name>
            <param-value>123456</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/*
        -->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
</web-app>

在AdminFilter中的init（）方法中编写如下代码

@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("初始化参数 password 的值是：" + filterConfig.getInitParameter("password"));
        // 3、获取ServletContext 对象
        System.out.println(filterConfig.getServletContext());
    }

启动项目查看运行结果

这里我们可以看到当我们web项目启动的时候就会调用init（）方法，这是就会获取到过滤器的名称、初始化的参数。

FilterChain过滤器链

Filter表示的就是过滤器，Chain表示的就是链条，FilterChain表示的就是过滤器链，这个类主要是用来处理多个过滤器之间的关系。

图解：
在这里插入图片描述

Filter 的拦截路径

精确匹配(基本不用)

<!--filter-mapping 配置Filter 过滤器的拦截路径-->
    <filter-mapping>
        <!--filter-name 表示当前的拦截路径给哪个filter 使用-->
        <filter-name>AdminFilter</filter-name>
        <!--url-pattern 配置拦截路径
        / 表示请求地址为：http://ip:port/工程路径/	映射到IDEA 的 web 目录
        表示请求地址必须是http://ip:port/工程路径/target.jsp
        -->
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>

<!--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>

后缀名匹配(较少)

<!--filter-mapping 配置Filter 过滤器的拦截路径-->
    <filter-mapping>
        <!--filter-name 表示当前的拦截路径给哪个filter 使用-->
        <filter-name>AdminFilter</filter-name>
        <!--url-pattern 配置拦截路径
        / 表示请求地址为：http://ip:port/工程路径/	映射到IDEA 的 web 目录
        表示请求的地址必须以html、do、action结尾才会拦截到
        -->
        <url-pattern>*.html</url-pattern>
        <url-pattern>*.do</url-pattern>
        <url-pattern>*.action</url-pattern>
    </filter-mapping>