Filter（过滤器）

1、Filter（过滤器）的基本介绍

Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。

调用 Servlet 前调用所有附加的 Servlet 过滤器。

Servlet 过滤器是可用于 Servlet 编程的 Java 类，可以实现以下目的：

  • 在客户端的请求访问后端资源之前，拦截这些请求。
  • 在服务器的响应发送回客户端之前，处理这些响应。

Filter、Listener和 servlet 是 Java EE 的三大组件。

1.1、过滤器的作用

过滤器一般用于完成一些通用的操作，将一些公用逻辑从各个Servlet中抽离出来在过滤器里实现。比如：

  • 记录日志、登录检查、全局设置等；
  • 统一编码设置、敏感字符过滤等等

在HTTP请求到达Servlet之前，我们可以通过一个或多个Filter 对 servlet 进行预处理。

2、Filter的基本使用

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。

javax.servlet.Filter 接口定义了三个方法：

  • public void doFilter (ServletRequest, ServletResponse, FilterChain)：该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。每一次请求被拦截时都会执行。
  • public void init(FilterConfig filterConfig)：服务器启动后将会自动创建 Filter 的实例对象，并自动调用其 init 方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）
  • public void destroy()：正常关闭服务器时，Filter 对象被销毁，将会执行该方法（正常关闭时才会执行该方法）。一般可在该方法中释放过滤器占用的资源。

定义一个 filter 跟定义一个 java 类没什么差别。示例如下：

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/*")   //定义拦截的URL
public class FilterTest01 implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("filter被执行了。。");

        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");

        chain.doFilter(request, response);   //将请求放行
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void destroy() {
    }
}

上面配置的过滤器过滤的URL为 /*，则表示所有路径的资源都会被过滤器拦截到并进行处理。不仅仅是 servlet，只要是访问服务器上的资源，比如 jsp、html、css、js 、图片等等，这些也都能被过滤器拦截到。

在 doFilter() 方法内部，要将该请求放行，允许后面的资源或者后面的 Filter 处理请求，则必须调用 chain.doFilter(req, resp)。否则，请求虽然能成功，但不会有内容返回，默认响应是200+空白输出，比如如果请求的是 jsp 或者是 html 资源，将会看到空白页面。

在 chain.doFilter(req, resp) 前面的语句会在资源响应前先执行这些代码，但在 chain.doFilter(req, resp) 后面的语句将会在资源返回后执行，所以一般这些语句可用于对响应的信息进行操作。

注意，doFilter() 中的参数是 ServletRequest，而不是 servlet 中的 HttpServletRequest。HttpServletRequest和ServletRequest都是接口，HttpServletRequest继承自ServletRequest。HttpServletRequest比ServletRequest多了一些针对于Http协议的方法。 例如：getHeader()， getMethod() ， getSession() 等。

要想使用 HttpServletRequest 中的参数，应该对 ServletRequest 进行强转换：

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest)request;  
       
        String uri = httpServletRequest.getRequestURI();
}

2.1、使用 web.xml 配置过滤器

除了可以使用注解 @WebFilter() 来配置过滤器，我们也可以使用 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>filterTestName</filter-name>  <!-- filter名称 -->
        <filter-class>test.FilterTest01</filter-class>   <!-- 完整类名 -->
    </filter>
    <filter-mapping>
        <filter-name>filterTestName</filter-name>
        <url-pattern>/*</url-pattern>   <!-- 拦截路径 -->
    </filter-mapping>
</web-app>

跟 servlet 的配置类型，其中，filter-class 是完整的类名，filter-name 给你所配置的过滤器指定了一个名称，下面的 filter-mapping 里面的 filter-name 跟上面的 filter-name 相匹配，url-pattern 指定的是该过滤器的拦截路径。

使用 web.xml 配置过后注解就可以不使用了。

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：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。
    • ASYNC：异步访问资源时，过滤器被调用

2.2、配置详解

2.2.1、路径配置（urlPatterns）

拦截路径的写法：

  • 拦截所有资源：@WebFilter("/*")，访问所有资源时，过滤器都会执行
  • 拦截目录：比如@WebFilter("/user/*")，访问 /user 下的所有资源时，过滤器都会执行
  • 后缀名拦截：比如@WebFilter("*.jsp")，访问所有后缀名为 jsp 的资源时，过滤器都会执行
  • 拦截具体资源：比如@WebFilter("/index.jsp")、@WebFilter("/user/servletTest01")，这样的话只有访问到该资源时，过滤器才会被执行

2.2.2、拦截方式配置（资源被以什么方式请求时才被拦截）

我们可以配置服务器上的资源被以什么方式被请求时才会被拦截，比如被浏览器访问时、服务器请求转发等等方式

使用注解时，我们可以通过设置 dispatcherTypes 属性来配置拦截方式，或者使用 web.xml 配置的<dispatcher>节点来设置。

示例：

@WebFilter(value = "/*", dispatcherTypes = DispatcherType.REQUEST)   //注解配置

//同时配置多种方式
@WebFilter(value = "/*", dispatcherTypes = {DispatcherType.REQUEST, DispatcherType.FORWARD})

 

该属性可以设置的值及其意义：

  • REQUEST（默认值）：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
  • INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
  • FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
  • ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。
  • ASYNC：异步访问资源时，过滤器被调用

2.3、过滤器链（多个过滤器时的执行顺序）

我们可以添加多个过滤器，只需定义多个过滤器类即可。

有多个过滤器时，过滤器的执行顺序跟使用注解配置还是 web.xml 配置有关。

当使用注解配置时，将会按照字符串的比较规则来比较过滤器的完整类名，值小的先执行。比如 atest.BFilter 和 btest.AFilter，则 atest.BFilter 过滤器先执行。

当使用 web.xml 配置时，哪个过滤器的在 web.xml 里面的定义代码在上面，哪个就先执行。比如下面配置，BFilter 定义在上面，则该过滤器先执行：

<?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>BFilterName</filter-name>
        <filter-class>test.BFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>BFilterName</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <filter>
        <filter-name>AFilterName</filter-name>
        <filter-class>atest.AFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>AFilterName</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

开始的过滤器执行顺序即按照上面所说，但在资源执行后时，执行顺序又是开始时的倒序（即在chain.doFilter(req, resp) 后面的语句的执行顺序是该语法前面的语句的执行顺序的倒序）。比如有两个过滤器，过滤器1和过滤器2，执行顺序如下：

  1. 过滤器1
  2. 过滤器2
  3. 资源执行
  4. 过滤器2
  5. 过滤器1
【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/wenxuehai/p/14690327.html