第七章 过滤器基础 Filter
简介:SUN从Servlet2.3开始添加一项激动人心的功能,就是过滤器(Filter)。WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
一 过滤器概述
从技术上讲,过滤器就是一个中间组件,用于拦截源数据和目的数据之间的消息,并且过滤二者之间传递的数据。
Servlet API中提供了一个Filter接口,如果编写的java类实现了这个接口,就说这个java类是过滤器(Filter),通过Filter功能,开发人员就可以对访问的资源之前,对访问者的请求和响应进行拦截。
这个单个的过滤器。也可以有多个过滤器。
当部署多个过滤器的时候,这些过滤器组成一个过滤器链。
过滤器常见的应用:
编码过滤:统一编码。
敏感词过滤:对一些敏感的词用其他符号代替。
认证过滤:对用户请求进行统一的认证。
登录和审核过滤:对用户的访问请求进行记录和审核。
图像转换过滤:转换图像格式。
数据压缩过滤:对用户发生的数据进行压缩,从而减少传输量。
二 过滤器是如何拦截的
Filter接口中有一个doFilter方法,当我们编写好Filter,并配置对哪个web资源进行拦截后,WEB服务器每次在调用web资源的service方法之前,都会先调用一下filter的doFilter方法,因此,在该方法内编写代码可达到如下目的:
- 调用目标资源之前,让一段代码执行。
- 是否调用目标资源(即是否让用户访问web资源)。
- 调用目标资源之后,让一段代码执行。
web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是filter接口中最重要的一个对 象,它也提供了一个doFilter方法,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的 service方 法,即web资源就会被访问,否则web资源不会被访问。
三 Filter
3.1 Filter开发步骤
1 编写java类实现Filter接口,并实现doFilter()方法
2 在部署文件web.xml中添加过滤器的注册与映射
过滤器范例:
1 package com.cy.filter; 2 3 import java.io.IOException; 4 5 import javax.servlet.Filter; 6 import javax.servlet.FilterChain; 7 import javax.servlet.FilterConfig; 8 import javax.servlet.ServletException; 9 import javax.servlet.ServletRequest; 10 import javax.servlet.ServletResponse; 11 import javax.servlet.http.HttpServletRequest; 12 import javax.servlet.http.HttpServletResponse; 13 /** 14 * 过滤器 15 * @author hellokitty燕 16 * 17 */ 18 public class FilterDemo implements Filter { 19 20 21 @Override 22 public void init(FilterConfig filterConfig) throws ServletException { 23 System.out.println("初始化过滤器"); 24 } 25 26 @Override 27 public void doFilter(ServletRequest request, ServletResponse response, 28 FilterChain chain) throws IOException, ServletException { 29 // 对request和response进行一些预处理 30 HttpServletRequest req=(HttpServletRequest) request; 31 HttpServletResponse resp=(HttpServletResponse) response; 32 req.setCharacterEncoding("utf-8"); 33 resp.setCharacterEncoding("utf-8"); 34 resp.setContentType("text/html;charset=UTF-8"); 35 System.out.println("FilterDemo执行前!"); 36 chain.doFilter(req, resp);//让目标资源执行,放过 37 System.out.println("FilterDemo执行前!"); 38 } 39 40 @Override 41 public void destroy() { 42 System.out.println("销毁过滤器"); 43 } 44 45 }
在web.xml中配置Filter
1 <?xml version="1.0" encoding="UTF-8"?> 2 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0. xsd" id="WebApp_ID" version="3.0"> 3 <display-name>Filter</display-name> 4 <welcome-file-list> 5 <welcome-file>index.html</welcome-file> 6 <welcome-file>index.htm</welcome-file> 7 <welcome-file>index.jsp</welcome-file> 8 <welcome-file>default.html</welcome-file> 9 <welcome-file>default.htm</welcome-file> 10 <welcome-file>default.jsp</welcome-file> 11 </welcome-file-list> 12 13 <!-- 配置过滤器--> 14 <filter> 15 <filter-name>FilterDemo</filter-name> 16 <filter-class>com.cy.FilterDemo</filter-class> 17 </filter> 18 <!-- 映射过滤器--> 19 <filter-mapping> 20 <filter-name>FilterDemo</filter-name> 21 <!-- /* 表示拦截所有的请求--> 22 <url-pattern>/*</url-pattern> 23 </filter-mapping> 24 25 26 </web-app>
3.2 Filter三个方法
3.2.1 void init(FilterConfig)
Web容器调用次方法是来初始化过滤器的,在过滤器的生命周期中,Servlet容器仅调用过滤器实例的init()一次。在init()方法没执行完之前,容器不会转发任何请求到过滤器。init()方法的标准化使用
public void init(FilterConfig filterConfig) throws ServletException{ }
3.2.2 void doFilter(ServletRequest, ServletResponse, FilterChain)
对于每个URL映射到该过滤器的请求,由容器调用该方法。doFilter()方法给过滤器对象一个机会来处理请求,转发请求到过滤器链中的下一个组件,或者自己回复客户端 doFilter()方法的标准化使用
public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException{ }
3.2.3 void destroy()
在应用程序关闭时,由容器调用.destory()方法的标准化使用
public void destroy(){ }
3.3 FilterConfig接口
该接口主要是为过滤器提供初始化参数,由Servlet容器实现 ,FilterConfig接口声明了四个方法;
String getFilterName() ; 返回在部署描述文件中指定的过滤器的名称
String getInitParameter(String) 返回在部署描述文件中指定的参数的值
Enumeration getInitParameterNames() 返回在部署描述文件中指定的所有参数的名称
ServletContext getServletContext() 返回Web应用程序的ServletContext。过滤器可以使用ServletContext设置、获取application范围内的属性。
代码示例
1 package com.cy.filter; 2 3 import java.io.IOException; 4 import java.util.Enumeration; 5 6 import javax.servlet.Filter; 7 import javax.servlet.FilterChain; 8 import javax.servlet.FilterConfig; 9 import javax.servlet.ServletException; 10 import javax.servlet.ServletRequest; 11 import javax.servlet.ServletResponse; 12 import javax.servlet.http.HttpServletRequest; 13 import javax.servlet.http.HttpServletResponse; 14 /** 15 * 过滤器 16 * @author hellokitty燕 17 * 18 */ 19 public class FilterDemo2 implements Filter { 20 21 22 @Override 23 public void init(FilterConfig filterConfig) throws ServletException { 24 System.out.println("初始化过滤器"); 25 26 /**写在 web.xml中 27 * <filter> 28 <filter-name>FilterDemo2</filter-name> 29 <filter-class>com.cy.FilterDemo02</filter-class> 30 <!--配置FilterDemo02过滤器的初始化参数--> 31 <init-param> 32 <description>配置FilterDemo2过滤器的初始化参数</description> 33 <param-name>name</param-name> 34 <param-value>kitty</param-value> 35 </init-param> 36 <init-param> 37 <description>配置FilterDemo2过滤器的初始化参数</description> 38 <param-name>pwd</param-name> 39 <param-value>123</param-value> 40 </init-param> 41 </filter> 42 43 <filter-mapping> 44 <filter-name>FilterDemo2</filter-name> 45 <!--“/*”表示拦截所有的请求 --> 46 <url-pattern>/*</url-pattern> 47 </filter-mapping> 48 */ 49 //得到过滤器的名字 50 String filterName = filterConfig.getFilterName(); 51 //得到在web.xml文件中配置的初始化参数 52 String initParam1 = filterConfig.getInitParameter("name"); 53 String initParam2 = filterConfig.getInitParameter("pwd"); 54 //返回过滤器的所有初始化参数的名字的枚举集合。 55 Enumeration<String> initParameterNames = filterConfig.getInitParameterNames(); 56 // System.out.println(filterName); 57 // System.out.println(initParam1); 58 // System.out.println(initParam2); 59 while (initParameterNames.hasMoreElements()) { 60 String paramName = (String) initParameterNames.nextElement(); 61 System.out.println(paramName); 62 } 63 } 64 65 @Override 66 public void doFilter(ServletRequest request, ServletResponse response, 67 FilterChain chain) throws IOException, ServletException { 68 // 对request和response进行一些预处理 69 HttpServletRequest req=(HttpServletRequest) request; 70 HttpServletResponse resp=(HttpServletResponse) response; 71 req.setCharacterEncoding("utf-8"); 72 resp.setCharacterEncoding("utf-8"); 73 resp.setContentType("text/html;charset=UTF-8"); 74 System.out.println("FilterDemo执行前!"); 75 chain.doFilter(req, resp);//让目标资源执行,放过 76 System.out.println("FilterDemo执行前!"); 77 } 78 79 @Override 80 public void destroy() { 81 System.out.println("销毁过滤器"); 82 } 83 84 }
3.4 FilterChain接口
改接口只有一个方法:
void doFilter(ServletRequest,ServletResponse) 我们从一个过滤器对象的doFilter()方法中调用此方法,以继续过滤器链的传递过程。它会将控制转到链中的下一个组件。
3.5 Filter链
在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。
web服务器根据Filter在web.xml文件中的注册顺序,决定先调用哪个Filter,当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。每个过滤器都需要调用doFilter()方法传下去。容器会首先调用匹配请求的URI的过滤器,然后才是匹配Servlet名的过滤器。
四 配置Filter
4.1 <filter>元素
在web.xml中配置filter
1 <filter> 2 3 <filter-name>FilterDemo2</filter-name> 4 <filter-class>com.cy.FilterDemo2</filter-class> 5 <!--配置FilterDemo02过滤器的初始化参数--> 6 <init-param> 7 <description>配置FilterDemo2过滤器的初始化参数</description> 8 <param-name>name</param-name> 9 <param-value>kitty</param-value> 10 </init-param> 11 <init-param> 12 <description>配置FilterDemo2过滤器的初始化参数</description> 13 <param-name>pwd</param-name> 14 <param-value>123</param-value> 15 </init-param> 16 </filter>
<description>用于添加描述信息,该元素的内容可为空,<description>可以不配置。
<filter-name>用于为过滤器指定一个名字,该元素的内容不能为空。
<filter-class>元素用于指定过滤器的完整的限定类名。
<init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值。在过滤器中,可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数,那么<init-param>元素可以不配置。
4.2 <filter-mapping>元素
1 <filter-mapping> 2 <filter-name>FilterDemo2</filter-name> 3 <!--“/*”表示拦截所有的请求 --> 4 <url-pattern>/*</url-pattern> 5 <!--过滤器对应的请求方式--> 6 <dispatcher>REQUEST</dispatcher> 7 </filter-mapping>
<dispatcher> 子元素可以设置的值及其意义:
- REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
- INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
- FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
- ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。