Skip to content

4.过滤器

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

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

根据规范建议的各种类型的过滤器：

  • 身份验证过滤器（Authentication Filters）。
  • 数据压缩过滤器（Data compression Filters）。
  • 加密过滤器（Encryption Filters）。
  • 触发资源访问事件过滤器。
  • 图像转换过滤器（Image Conversion Filters）。
  • 日志记录和审核过滤器（Logging and Auditing Filters）。
  • MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。
  • 标记化过滤器（Tokenizing Filters）。
  • XSL/T 过滤器（XSL/T Filters），转换 XML 内容。

Filter的执行顺序与在web.xml配置文件中的配置顺序一致，一般把Filter配置在所有的Servlet之前。

1. Servlet 过滤器方法⚓

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三个方法：

1 public void doFilter (ServletRequest, ServletResponse, FilterChain) 该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。
2 public void init(FilterConfig filterConfig) web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
3 public void destroy() Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

2. 配置过滤器⚓

web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。

package filter;

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

public class CharacterFilter implements Filter {

    private static String character;

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        servletRequest.setCharacterEncoding(character);
        servletResponse.setCharacterEncoding(character);
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        character = filterConfig.getInitParameter("character");
    }

    @Override
    public void destroy() {

    }
}

web.xml：

<!--过滤器-->
    <filter>
        <filter-name>characterFilter</filter-name>
        <filter-class>filter.CharacterFilter</filter-class>
        <init-param>
            <param-name>character</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>characterFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称（）和资源访问的请求路径（）。

其还有一个子标签<dispatcher>表示拦截什么样的 Servlet 容器调用，可以取以下四种值：

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