Servlet 过滤器详解

Servlet 过滤器是可用于 Servlet 编程的 Java 类，实现了javax.servlet.Filter接口。

概念

Servlet 过滤器是可用于 Servlet 编程的 Java 类，实现了javax.servlet.Filter接口。可以实现以下目的：

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

工作原理

生命周期

三个方法

init

public void init(FilterConfig filterConfig)

web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作。Filter对象只会创建一次，init方法也只会执行一次。开发人员通过init方法的参数FilterConfig对象可获得代表当前filter配置信息。

doFilter

public void doFilter (ServletRequest, ServletResponse, FilterChain)

该方法完成实际的过滤操作，当客户端请求访问与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain参数调用chain.doFilter方法，将请求传给下一个过滤器或目标资源，或利用转发、重定向将请求转发到其他资源。

destroy

public void destroy()

Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

配置

需要在web.xml中配置。

1. filter可以有一个，filterMapping可以有多个；
2. 相同的url-pattern 组成过滤器链；
3. filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。

filter-mapping 元素的顺序只影响方法doFilter()方法的执行顺序，init()和destroy()不受影响。

过滤器链

执行过程

Dispatcher模式

默认 <dispatcher>REQUEST</dispatcher>

实战

解决编码

<!--过滤器 解决乱码-->
<filter>
  <filter-name>encoding</filter-name>
  <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  <init-param>
    <param-name>encoding</param-name>
    <param-value>utf-8</param-value>
  </init-param>
</filter>

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

自定义过滤器

<!--登录过滤器-->
<filter>
  <filter-name>userFilter</filter-name>
  <filter-class>com.wx.login.filter.UserFilter</filter-class>
  <init-param>
    <param-name>Site</param-name>
    <param-value>菜鸟网络</param-value>
  </init-param>
</filter>

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

执行结果

扩展

@WebFilter

@WebFilter用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。

@WebFilter配置

@WebFilter常用属性