Filter也称之为过滤器,Web开发人员可以通过Filter技术,对web服务器管理的所有web资源,例如Jsp、Servlet、静态图片文件或静态html文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
一、Filter的作用
- 在HttpServletRequest 到达Servlet 之前,拦截客户的HttpServletRequest。
- 根据需要检查HttpServletRequest,可以修改HttpServletRequest头和数据,也可以根据条件让请求不发往资源处理器,并直接向客户机发回一个响应。
- 在HttpServletResponse 到达客户端之前,拦截HttpServletResponse。
- 根据需要检查HttpServletResponse,可以修改HttpServletRespons头和数据。
二、Filter的生命周期
public abstract interface Filter{
public abstract void init(FilterConfig paramFilterConfig) throws ServletException;
public abstract void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain
paramFilterChain) throws IOException, ServletException;
public abstract void destroy();
}
- 实例化:Web容器在部署Web应用程序时对所有过滤器进行实例化,Web容器回调它的无参构造方法。
init():在 Filter 生命周期中仅执行一次,当容器第一次加载该过滤器时,init() 方法将被调用。开发人员通过init()方法,可获得代表当前Filter配置信息的FilterConfig对象。当Web容器实例化Filter对象,调用其init()方法时,会把封装了Filter初始化参数的filterConfig对象传递进来,因此开发人员在编写filter时,通过filterConfig对象的方法,就可获得以下内容:
- String getFilterName();//得到filter的名称。
- String getInitParameter(String name);//返回在部署描述中指定名称的初始化参数的值。如果不存在返回null。
- Enumeration getInitParameterNames();//返回过滤器的所有初始化参数的名字的枚举集合。
- public ServletContext getServletContext();//返回Servlet上下文对象的引用。
doFilter():过滤器的大多数时间都消耗在这里,当我们编写好Filter,并配置对哪个Web资源进行拦截后,Web服务器每次在调用web资源的service方法之前,都会先调用一下filter的doFilter方法,因此,在该方法内编写代码可达到如下目的:
- 调用目标资源之前,让一段代码执行。
- 是否调用目标资源(即是否让用户访问web资源)。
- 调用目标资源之后,让一段代码执行。
web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是Filter接口中最重要的一个对象,它也提供了一个doFilter方法。filterChain.doFilter(request,response)作用是将请求转发给过滤器链上下一个对象。这里的下一个指的是下一个filter,如果没有Filter那就是你请求的资源。 一般Filter都是一个链,web.xml 里面配置了几个就有几个,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的service方法,即web资源就会被访问,否则web资源不会被访问。
- destroy():Filter对象创建后会驻留在内存,当web应用移除或服务器停止时才销毁。该方法在Filter的生命周期中仅执行一次。在这个方法中,可以释放过滤器使用的资源。
三、FilterChain
在一个Web应用中可以编写多个Filter,这些Filter组合起来称之为一个Filter链(FilterChain),Web服务器根据Filter在web.xml文件中的注册顺序,决定先调用哪个Filter。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用下一个Filter,如果没有,则调用目标资源的service方法,相反,如果没有调用FilterChain的doFilter方法,那么该请求将无法继续被执行下去。
四、Filter开发流程
- 编写java类实现Filter接口,并实现其doFilter方法。
- 在web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行部署。
五、Filter类编写
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
/**
* Servlet Filter implementation class TestFilter
*/
public class TestFilter implements Filter {
/**
* @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
*/
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
// TODO Auto-generated method stub
// place your code here
// pass the request along the filter chain
chain.doFilter(request, response);
}
/**
* @see Filter#init(FilterConfig)
*/
public void init(FilterConfig fConfig) throws ServletException {
// TODO Auto-generated method stub
}
/**
* @see Filter#destroy()
*/
public void destroy() {
// TODO Auto-generated method stub
}
}
六、Filter部署
1. 注册Filter
开发好Filter之后,需要在web.xml文件中进行注册,这样才能够被web服务器调用,在web.xml文件中注册Filter范例:
<filter>
<description>Filter描述</description>
<filter-name>Filter名字</filter-name>
<filter-class>Filter类名</filter-class>
<!--配置Filter过滤器的初始化参数-->
<init-param>
<description>这里写对参数1的描述</description>
<param-name>name1</param-name>
<param-value>value1</param-value>
</init-param>
<init-param>
<description>这里写对参数2的描述</description>
<param-name>name2</param-name>
<param-value>value2</param-value>
</init-param>
</filter>
- <description>用于添加描述信息,该元素的内容可为空,可以不配置。
- <filter-name>用于为过滤器指定一个名字,该元素的内容不能为空。
- <filter-class>元素用于指定过滤器的完整的限定类名,该元素的内容不能为空。
<init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值。
在过滤器中,可以使用FilterConfig接口对象来访问初始化参数,如果过滤器不需要指定初始化参数,那么<init-param>元素可以不配置。
2.映射Filter
在web.xml文件中注册了Filter之后,还要在web.xml文件中映射Filter:
<!--映射过滤器-->
<filter-mapping>
<filter-name>Filter名字</filter-name>
<!--/*表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
<!--<servlet-name>Servlet名字</servlet-name> -->
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
- <filter-mapping>元素用于设置一个 Filter 所负责拦截的资源,一个Filter拦截的资源可通过两种方式来指定:Servlet名称和资源访问的请求路径。
- <filter-name>子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字。
- <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)。
- <servlet-name>指定过滤器所拦截的Servlet名称。
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,可以不写,默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。
REQUEST:当用户直接访问页面时,Web容器将会调用过滤器,如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用,除此之外,过滤器不会被调用。