简介
Filter也称之为过滤器,它是Servlet技术中最实用的技术,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter技术,开发人员可以实现用户在访问某个目标资源之前,对访问的请求和响应进行拦截,如下所示:
Filter是如何实现拦截的
Filter接口中有一个doFilter方法,当开发人员编写好Filter,并配置对哪个web资源(拦截url)进行拦截后,WEB服务器每次在调用web资源之前,都会先调用一下filter的doFilter方法,因此,在该方法内编写代码可达到如下目的:
(1)调用目标资源之前,让一段代码执行.
(2)是否调用目标资源(即是否让用户访问web资源),web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是filter接口中最重要的一个对象,它也提供了一个doFilter方法,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的service方法,即web资源就会被访问,否则web资源不会被访问。
(3)调用目标资源之后,让一段代码执行
Filter的开发入门
Filter开发分为二个步骤:
(1)编写java类实现Filter接口,并实现(三个方法)init,doFilter,destroy。
(2)在 web.xml 文件中使用<filter>和<filter-mapping>标签对编写的filter类进行注册,并设置它所能拦截的资源。
Filter链 --FilterChain
在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。
web服务器根据Filter在web.xml文件中的注册顺序<mapping>,决定先调用哪个Filter,当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有其他filter,如果有,则调用第2个filter,依次类推,如果没有,则调用目标资源。
Filter的生命周期
(1)init(FilterConfig filterConfig)throws ServletException:
和我们编写的Servlet程序一样,Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法进行初始化(注:filter对象只会创建一次,init方法也只会执行一次,filterConfig可以在web.xml中配置)
开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。
(2)doFilter(ServletRequest,ServletResponse,FilterChain):
每次filter进行拦截都会执行
在实际开发中方法中参数request和response通常转换为HttpServletRequest和HttpServletResponse类型进行操作
(3)destroy():
在Web容器卸载 Filter对象之前被调用。
init方法参数中的FilterConfig接口
用户在注册filter时,可以使用<init-param>为filter配置一些初始化参数,当web容器实例化Filter对象,调用其init方法时,会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时,通过filterConfig对象的方法,就可获得:
(1)String getFilterName():得到filter的名称。
(2)String getInitParameter(String name): 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
(3)Enumeration getInitParameterNames():返回过滤器的所有初始化参数的名字的枚举集合。
(4)public ServletContext getServletContext():返回Servlet上下文对象的引用。
注册File的标签说明
<filter>
<filter-name>testFitler</filter-name>
<filter-class>org.test.TestFiter</filter-class>
<init-param>
<param-name>word_file</param-name>
<param-value>/WEB-INF/word.txt</param-value>
</init-param>
</filter>
说明:
<filter-name> 用于为过滤器指定一个名字,该标签的内容不能为空。
<filter-class> 用于指定过滤器的完整的限定类名。
<init-param> 用于为过滤器指定初始化参数,它的两个子标签:
<param-name> 指定参数的名字
<param-value> 指定参数的值。在过滤器中,可以使用FilterConfig接口对象来访问该参数的值。
映射Filter的标签说明
<filter-mapping>
<filter-name>testFilter</filter-name>
<url-pattern>/index.jsp</url-pattern>
<servlet-name>ServletDemo6</servlet-name>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
说明:
<filter-mapping>标签用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet名称 和 资源访问的请求路径
<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL)
<servlet-name>指定过滤器所拦截的Servlet名称。注意:只能和<url-pattern>2选一,否则同时存在且匹配的话会拦截2次
<dispatcher>指定过滤器所拦截的资源是由什么调用方式触发的.有4个选项:
REQUEST、INCLUDE、FORWARD和ERROR之一,默认REQUEST。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。
Dispatch可以设置的值及其意义
REQUEST:当浏览器直接访问页面时或者被重定向到页面时(因为重定向相当于让浏览器重新发送一个新的请求),Web容器将会调用过滤器。
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法转发访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。
Filter的高级开发
由于开发人员在filter中可以得到代表用户请求和响应的request、response对象,因此在编程中可以使用Decorator(装饰器)模式对request、response对象进行包装,再把包装对象传给目标资源,从而实现一些特殊需求。
装饰者模式书写步骤:
- 要求装饰者和被装饰者实现同一个接口或者继承同一个类
- 装饰者中要有被装饰者的引用
- 对需要加强方法进行加强
- 对不需要加强的方法调用原来的方法即可
1)Request对象的增强
Servlet API 中提供了一个request对象的Decorator设计模式的默认实现类HttpServletRequestWrapper , (HttpServletRequestWrapper 类实现了request 接口中的所有方法,但这些方法的内部实现都是仅仅调用了一下所包装的的 request 对象的对应方法)以避免用户在对request对象进行增强时需要实现request接口中的所有方法。
应用场景:解决全网站的get和post方式提交参数的乱码问题。
2)Response对象的增强
Servlet API 中提供了response对象的Decorator设计模式的默认实现类HttpServletResponseWrapper , (HttpServletResponseWrapper类实现了response接口中的所有方法,但这些方法的内部实现都是仅仅调用了一下所包装的的 response对象的对应方法)以避免用户在对response对象进行增强时需要实现response接口中的所有方法。
应用场景:实现全站响应数据的压缩