Filter--过滤器Filter概述、API、配置与使用详解

过滤器Filter概述

• 过滤器是一个运行在服务端的程序，在与之相关的Servlet或JSP页面之前运行，实现对请求资源的过滤功能。

• Filter是对客户端访问资源的过滤，符合条件放行，不符合条件不放行，并且可以对目标资源访问前后进行逻辑处理。

• 过滤器可附加到一个或多个Servlet或JSP页面上，可以检查请求信息，也可以处理响应信息。

• Filter的基本功能是对Servlet容器调用Servlet的过程进行拦截，从而在Servlet执行前后实现一些特殊的功能。

• 过滤器常用实例：

  • 自动登录
  • 解决全站乱码
  • 屏蔽非法文字
  • 进行响应数据压缩

• 过滤器的编写流程

  • 实现类：需要实现接口javax.servlet.Filter
  • 配置：在web.xml使用和进行配置

Filter的访问流程

FIlter的API

Filter声明周期及其与生命周期相关的方法：
Filter接口有三个方法，并且这三个都是与Filter的生命相关的方法。

• init(Filterconfig):
  代表filter对象初始化方法，filter对象创建时执行

• doFilter(ServletRequest, ServletResponse, FilterChain):
  代表filter执行过滤的核心方法，如果某资源已经被配置到这个filter进行过滤的话，那么每次访问这个资源都会执行doFilter方法

• destory():
  代表filter的销毁方法，当filter对象销毁时执行该方法

Filter对象的声明周期：

• Filter何时创建：服务器启动时就创建该filter对象
• Filter何时销毁：服务器关闭时filter销毁

FilterAPI详解：

@Override
public void init(FilterConfig filterConfig) throws ServletException {
	//参数config代表该Filter对象的配置信息的对象，内部封装的是该filter的配置信息。
}

@Override
public void destroy() {
   //Filter对象销毁时执行
}

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
   //ServletRequest、ServletResp：每次在执行doFilter方法时，web容器负责创建一个request和一个response对象作为doFilter的参数传递进来。
   //该request和response就是在访问目标资源的service方法时的request和response
   //FilterChain：过滤链对象，通过该对象的doFilter方法可以放行该请求
}

Filter的配置

	<!-- 配置Filter -->
    <filter>
        <!-- Filter的名字 -->
        <filter-name>myFilter</filter-name>
        <!-- 全限定路径 -->
        <filter-class>pers.zhang.filter.MyFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>myFilter</filter-name>
        <!-- <servlet-name></servlet-name> -->
        <url-pattern>/*</url-pattern>
        <!-- 访问方式 -->
        <dispatcher>REQUEST</dispatcher>
    </filter-mapping>
    
    <!--
        url-pattern配置：
        1）完全匹配： /XXXservlet
        2）目录匹配： /aaa/bbb/* 
                   /user/*： 访问前台的资源执行此过滤器
                   /admin/*： 访问后台的资源时执行此过滤器
        3）扩展名匹配： *.abc   *.jsp
        
        注意：url-pattern可以使用servlet-name替代，也可以混用

		dispatcher：访问的方式
        1) REQUEST: 默认值，代表直接访问某个资源时执行filter
        2) FORWARD: 转发时才执行filter
        3) INCLUDE: 包含资源时才执行filter
        4) ERROR: 发生错误时，进行跳转执行filter
    -->

简单示例：使用Filter完成访问WEB任何资源都打印当前时间

Filter：

package pers.zhang.filter;

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

/**
 * @author zhang
 * @date 2019/9/20 - 22:20
 */
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("filter创建了...");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println(new Date().toString());
        //放行请求
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {
        System.out.println("filter销毁了...");
    }
}

配置Filter：

	<!-- 配置Filter -->
    <filter>
        <filter-name>myFilter</filter-name>
        <filter-class>pers.zhang.filter.MyFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>myFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

启动服务器，控制台输出：

filter创建了...

使用浏览器访问web下任意资源，控制台输出：

Fri Sep 20 22:48:22 CST 2019

关闭服务器，控制台输出：

filter销毁了...