Servlet Filter - 《教有缘人学 Java 教程》

Filter解决什么问题
Filter的作用
Filter开发
- 注解的方式
- XML的方式
  - 编写Java类实现Filter接口
  - 在web.xml中编写
多个过滤器的执行顺序
Filter的生命周期
- init方法执行时机：当filter所在的项目部署到web容器(比如Tomcat)后调用
- destroy方法执行时机：当filter所在的项目从web容器(比如Tomcat)中移除后调用

Filter解决什么问题

在一个web应用中，会有很多URL，同样每个URL会有其对应的Servlet。

            ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐
               /             ┌──────────────┐
            │ ┌─────────────>│ IndexServlet │ │
              │              └──────────────┘
            │ │/login        ┌──────────────┐ │
              ├─────────────>│LoginServlet  │
            │ │              └──────────────┘ │
              │/logOut       ┌──────────────┐
┌───────┐   │ ├─────────────>│LogOutServlet │ │
│web应用 ├─────┤              └──────────────┘
└───────┘   │ │/aaa          ┌──────────────┐ │
              ├─────────────>│AaaServlet    │
            │ │              └──────────────┘ │
              │/bbb          ┌──────────────┐
            │ ├─────────────>│ BbbServlet   │ │
              │              └──────────────┘
            │ │/ccc          ┌──────────────┐ │
              └─────────────>│ CccServlet   │
            │                └──────────────┘ │
              │/html         
            │ ├─────────────                  │
              │              
            │ │/image                         │
            │ ├─────────────                  │
             ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─

如果在访问aaa、bbb、ccc的时候需要用户登录才能访问，这时我们可以在其对应的servlet，AaaServlet、BbbServlet、CccServlet里面做判断，看看用户有没有登录，做相应的逻辑处理。相同的代码就写了3次。当然通常在项目里面AaaServlet、BbbServlet、CccServlet会继承一个基类的Servlet。我们只需要在其基类里面做逻辑处理即可，但这仍然会有问题。因为这只能拦截Servlet发起的请求，而如果也想拦截静态资源html、CSS、图片资源等，就没有办法解决了。这时我们可以使用Servlet的Filter过滤器做拦截处理。

Filter的作用

在HTTP请求到达Servlet之前，可以被一个或多个Filter预处理，类似打印日志、登录检查、压缩响应等逻辑，完全可以放到Filter中。
可以被一个过滤器处理
Servlet Filter - 图1

也可以被多个过滤器处理
Servlet Filter - 图2

Filter可以办到：在HttpServletRequest到达服务器之前，拦截客户端的HttpServletRequest 。根据需要检查HttpServletRequest和修改HttpServletRequest 头和数据。
在HttpServletResponse到达客户端之前，拦截HttpServletResponse 。根据需要检查HttpServletResponse和修改HttpServletResponse头和数据。

Filter开发

和Servlet一样，Filter的创建和销毁也是有web容器负责的(如Tomcat)，Filter有两种使用方式

注解的方式
XML的方式

注解的方式

可以使用Maven新建一个web项目。在web项目中，我们先新建一个登陆的Servlet.里面什么也没有干，只是做了一个打印。

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebServlet("/login")
public class LoginServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("登录Servlet");
    }
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req,resp);
    }
}

新建一个登陆Filter

命名为LoginFilter

import javax.servlet.*;
import javax.servlet.annotation.*;
import java.io.IOException;
@WebFilter("/*") //配置对哪个web资源进行拦截。这里表示拦截所有请求，包括Servlet、JSP、静态资源图片等
public class LoginFilter implements Filter {
    public void init(FilterConfig config) throws ServletException {
        System.out.println("当filter所在的项目部署到web容器(比如Tomcat)后调用");
    }
    public void destroy() {
        System.out.println("当filter所在的项目从web容器(比如Tomcat)中移除后调用");
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
        System.out.println("来到了LoginFilter过滤器");
        chain.doFilter(request, response); //表示请求放行，会请求到服务端相应的请求资源
        System.out.println("相应的请求处理完成之后调用");
    }
}

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，Web服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

调用目标资源之前，让一段代码执行。
是否调用目标资源（即是否让用户访问web资源）。
web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，
开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

现在我们访问项目中登录Servlet。

http://localhost:8080/filterDemo/login

发现IDE控制台打印了如下信息

来到了LoginFilter过滤器
登录Servlet
相应的请求处理完成之后调用

我们分析一下如下代码

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
    System.out.println("来到了LoginFilter过滤器"); //这里可以看成请求到达服务器资源前做的处理
    chain.doFilter(request, response); //表示请求放行，会请求到服务端相应的请求资源
    System.out.println("相应的请求处理完成之后调用");  //请求到达服务器资源后做的处理
}

只有调用chain.doFilter(request, response)这句代码，才会请求到服务端把相应的资源返回。

XML的方式

只需两步

编写java类实现Filter接口，并实现其doFilter方法。Filter接口如下

public interface Filter {
 default void init(FilterConfig filterConfig) throws ServletException {
 }
 void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;
 default void destroy() {
 }
}

2. 在web.xml文件中对编写的filter类进行注册，并设置它所能拦截的资源。

编写Java类实现Filter接口

package com.lff;
import javax.servlet.*;
import javax.servlet.annotation.*;
import java.io.IOException;
public class LoginXmlFilter implements Filter {
    public void init(FilterConfig config) throws ServletException {
        System.out.println("LoginXmlFilter --- init");
    }
    public void destroy() {
        System.out.println("LoginXmlFilter --- destroy");
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
        System.out.println("LoginXmlFilter --- doFilter");
        chain.doFilter(request, response);
    }
}

在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>LoginXmlFilter</filter-name> <!-- 名字自己起一个,尽量和类名保持一致 -->
        <filter-class>com.lff.LoginXmlFilter</filter-class> <!-- 元素用于指定过滤器的完整的限定类名 -->
    </filter>
    <filter-mapping>
        <filter-name>LoginXmlFilter</filter-name>
        <url-pattern>/*</url-pattern> <!-- 设置 filter 所拦截的请求路径(过滤器关联的URL样式)-->
    </filter-mapping>
</web-app>

web.xml配置各节点介绍：

<filter>指定一个过滤器。
<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
<filter-class>元素用于指定过滤器的完整的限定类名。
<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。
在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。
<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
<servlet-name>指定过滤器所拦截的Servlet名称。
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。
<dispatcher>子元素可以设置的值及其意义
REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

多个过滤器的执行顺序

当有多个FIlter过滤器时，Filter的顺序确实对处理的结果有影响。默认情况下是根据类名进行字符串比较的，比较小的会先执行。这样就不好控制执行顺序，通常是在web.xml文件中对这些Filter进行配置。按照在web.xml文件中filter-mapping的顺序执行。如

<?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.lff.Filter1</filter-class> <!-- 元素用于指定过滤器的完整的限定类名 -->
    </filter>
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/*</url-pattern> <!-- 设置 filter 所拦截的请求路径(过滤器关联的URL样式)-->
    </filter-mapping>
    <filter> <!-- 指定一个过滤器 -->
        <filter-name>Filter2</filter-name> <!-- 名字自己起一个,尽量和类名保持一致 -->
        <filter-class>com.lff.Filter2</filter-class> <!-- 元素用于指定过滤器的完整的限定类名 -->
    </filter>
    <filter-mapping>
        <filter-name>Filter2</filter-name>
        <url-pattern>/*</url-pattern> <!-- 设置 filter 所拦截的请求路径(过滤器关联的URL样式)-->
    </filter-mapping>
</web-app>

上面会先执行Filter1再执行Filter2

Filter的生命周期

init方法执行时机：当filter所在的项目部署到web容器(比如Tomcat)后调用

很久以前讲过，Tomcat属于web容器的一种，里面可以部署很多项目的。

//此方法里面适合做资源的一次性加载，初始化工作。
public void init(FilterConfig config) throws ServletException {
    System.out.println("当filter所在的项目部署到web容器(比如Tomcat)后调用");
}

如何证明：

当点击上图所示的部署项目按钮时，会有如下打印信息

[2021-10-23 02:43:19,662] Artifact Demo5:war: Artifact is being deployed, please wait...
当filter所在的项目从web容器(比如Tomcat)中移除后调用
23-Oct-2021 14:43:19.889 信息 [RMI TCP Connection(10)-127.0.0.1] org.apache.jasper.servlet.TldScanner.scanJars 至少有一个JAR被扫描用于TLD但尚未包含TLD。 为此记录器启用调试日志记录，以获取已扫描但未在其中找到TLD的完整JAR列表。 在扫描期间跳过不需要的JAR可以缩短启动时间和JSP编译时间。
当filter所在的项目部署到web容器(比如Tomcat)后调用

调用了过滤器的init方法，所以过滤器的init方法是在项目部署到web容器中时调用。

destroy方法执行时机：当filter所在的项目从web容器(比如Tomcat)中移除后调用

//适合做资源的回收工作。
public void destroy() {
    System.out.println("当filter所在的项目从web容器(比如Tomcat)中移除后调用");
}

如何证明：

当点击上图所示的移除部署项目按钮时，会有如下打印信息

[2021-10-23 02:52:06,935] Artifact Demo5:war: Artifact is being undeployed, please wait...
当filter所在的项目从web容器(比如Tomcat)中移除后调用
[2021-10-23 02:52:06,969] Artifact Demo5:war: Artifact is not deployed. Press 'Deploy' to start deployment

调用了destroy方法，所以当我们部署的项目从web容器中移除后调用。