Filter概述
Filter是javax.servlet包中的一个接口,一个filter是对客户请求/响应进行拦截任务的一个对象。Filter调用doFilter()方法,传送给该方法的FilterConfig ,包含其初始化参数。
Filter的工作流程:
当客户端发出Web资源的请求时,Web服务器根据应用程序配置文件设置的过滤规则进行检查,若客户请求满足过滤规则,则对客户请求/响应进行拦截,对请求头和请求数据进行检查或改动,并依次通过过滤器链,最后把请求/响应交给请求的Web资源处理。请求信息在过滤器链中可以被修改,也可以根据条件让请求不发往资源处理器,并直接向客户机发回一个响应。当资源处理器完成了对资源的处理后,响应信息将逐级逆向返回。同样在这个过程中,用户可以修改响应信息,从而完成一定的任务。
多个过滤器同时过滤一个请求时,组成过滤链FilterChain,服务器按web.xml中定义过滤器先后顺序组成一条链,然后执行doFilter()方法。
执行流程:
执行第一个过滤器的chain.doFilter()之前的代码——>第二个过滤器的chain.doFilter()之前的代码——>…….——>第n个过滤器的chain.doFilter()之前的代码——>所请求Servlet的service()方法中的代码——>所请求的doGet()或doPost()方法中的代码——>第n个过滤器的chain.doFilter()之后的代码——>……——>第二个过滤器的chain.doFilter()之后的代码——>第一个过滤器的chain.doFilter()之后的代码。
常见过滤器种类
- Authentication Filters:负责检查用户请求,根据请求过滤用户非法请求。
- Logging and Auditing Filters:详细记录某些用户请求
- Image conversion Filters :图像转换过滤器
- Data compression Filters:数据压缩过滤器
- Encryption Filters :加密过滤器
- Tokenizing Filters:标记化过滤器
- Filters that trigger resource access events :触发资源访问事件过滤器
- XSL/T filters:能改变XML内容
- Mime-type chain Filter:MIME类型过滤链
过滤器生命周期
- 实例化:Web容器在部署Web应用程序时对所有过滤器进行实例化;
- 初始化:Web容器回调init()方法;
- 过滤:当请求路径匹配过滤器的URL映射,Web容器回调doFilter()方法;
- Web容器在卸载Web应用程序前回调destroy()方法,回收资源。
创建Filter步骤
- 创建实现javax.servlet.Filter接口的类;
- 在web.xml中配置Filter
package com.afy.servlet;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServletRequest;
@WebFilter(filterName="log",urlPatterns={"/hi"})
public class LogFilter implements Filter {
//FilterConfig可用于访问Filter的配置信息
private FilterConfig config;
@Override
public void init(FilterConfig config) throws ServletException {
this.config = config;
}
@Override
public void destroy() {
this.config = null;
}
@Override
//过滤核心方法
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
//--------以下代码用于对用户请求执行预处理--------
//获取ServletContext对象,用于记录日志
ServletContext context = this.config.getServletContext();
long before = System.currentTimeMillis();
System.out.println("开始过滤.......");
//将请求转换成HttpServletRequest请求
HttpServletRequest hrequest = (HttpServletRequest)request;
//输出提示信息
System.out.println("Filter已经截获到用户的请求地址: " + hrequest.getServletPath());
//Filter只是链式地址,请求依然放到目的地址
chain.doFilter(request, response);
//------------以下代码用于对服务器响应执行处后处理-------
long after = System.currentTimeMillis();
//输出提示信息
System.out.println("过滤结束");
System.out.println("请求被定位到" + hrequest.getRequestURI() + "所花时间为:" + (after-before));
}
}
doFilter()方法可以实现对用户请求进行预处理,也可以实现对服务器-响应进行后处理,分界线为是否调用chain.doFilter(),执行该方法前,对用户请求进行预处理,执行后对服务器进行后处理。
Servlet过滤器API
Servlet过滤器API有3个接口,都在javax.servlet包中,分别是Filter接口、FilterChain接口、FilterConfig接口。
Filter接口定义了init(),doFilter(),destroy()方法
public void init(FilterConfig,filterConfig)
开始使用Servlet过滤服务时,Web容器调用此方法一次,为服务准备过滤器;需要使用过滤器时调用doFilter(),传送给次方法的FilterConfig对象,包含Servlet过滤器的初始化参数;
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
过滤器在doFilter()方法中,可以通过它们的方法手机数据,或者给对象添加新的行为,过滤器通过传送至该方法的FilterChain参数,调用chain.doFilter()将控制权传送给下一个过滤器。如果过滤器想要终止请求的处理或得到对响应的完全控制,可以不调用下一个过滤器,而将其重定向到其他页面。当链中的最后一个过滤器调用chain.doFilter()方法时,将运行最初请求的Servlet。
public void destroy()
当doFilter()方法里的所有线程退出或超时,容器调用此方法。
public interface FilterChain
FilterChain接口有一个方法public void doFilter(ServldtRequest request, ServletResponse response),此方法用于对资源过滤链的依次调用,通过FilterChain调用过滤器的下一个过滤器,如果是最后一个过滤器则调用目标资源。
public interface FilterConfig
FilterConfig接口检索过滤器名,初始化参数和Servlet上下文。有4个方法。
- public java.lang.String getFilterName()返回web.xml文件中定义该过滤器的名称。
- public java.lang.String getInitParameter(String name)返回过滤器初始化参数值的字符串形式,参数不存在则返回null,其中的name是初始化参数名。
- public java.util.Enumeration getInitParameterNames()以Enumeration形式返回过滤器所有初始化参数值,如果没有初始化参数,返回为空。
public ServletContext getServletContext()返回调用者所处的Servlet上下文。
Filter与Servlet近似,它们有相同的生命周期行为。Filter的doFilter()方法里多了一个FilterChain的参数,通过该参数可以控制是否放行用户请求。实际应用中,Filter里doFilter()方法里的代码是从多个Servlet的service()方法里抽取的通用代码,通过Filter实现更好的代码复用。如果系统里有多个Servlet,这些Servlet都需要进行一些通用出来就,如权限控制、记录日志、设置编码等,这样Servelet的service方法中有部分代码会相同,这时可以考虑将这些通用处理放到Filter中完成,而Servlet里只放特定请求相关的处理就代码,把通用处理交给Filter完成。