JavaWeb篇-Filter

Filter

概述

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

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

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

Filter的工作原理:

在这里插入图片描述

Filter 过滤器的使用步骤

编写一个类去实现 Filter 接口

public class AdminFilter implements Filter { 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException { 
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { 
    }
    @Override
    public void destroy() { 
    }
}

实现过滤方法 doFilter()

@Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { 
        System.out.println("doFilter");
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");
        // 如果等于 null，说明还没有登录
        if (user == null) { 
            request.getRequestDispatcher("/").forward(request,response);
            return;
        } else { 
            // 让程序继续往下访问用户的目标资源
            chain.doFilter(request,response);
        }
    }

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

<!--filter 标签用于配置一个 Filter 过滤器-->
    <filter>
        <!--给 filter 起一个别名-->
        <filter-name>AdminFilter</filter-name>
        <!--配置 filter 的全类名-->
        <filter-class>com.atguigu.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>

Filter的生命周期

Filter 的生命周期包含几个方法
1、构造器方法
2、init 初始化方法

第 1，2 步，在 web 工程启动的时候执行（Filter 已经创建）

3、doFilter 过滤方法

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

4、destroy 销毁

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

FilterConfig 类

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

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

作用:

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

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

代码实现；

@Override
public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("2.Filter 的 init(FilterConfig filterConfig)初始化");
    // 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());
}

web.xml中:

<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://localhost3306/test</param-value>
</init-param>

FilterChain 过滤器链

多个过滤器一起工作的原理图:

在这里插入图片描述

Filter 的拦截路径

1、精确匹配

在这里插入图片描述

2、目录匹配

在这里插入图片描述

3、后缀名匹配

<url-pattern>*.html</url-pattern>
以上配置的路径，表示请求地址必须以.html 结尾才会拦截到
<url-pattern>*.do</url-pattern>
以上配置的路径，表示请求地址必须以.do 结尾才会拦截到
<url-pattern>*.action</url-pattern>
以上配置的路径，表示请求地址必须以.action 结尾才会拦截到