Filter过滤器入门1

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：

例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。

例如实现URL级别的权限访问控制、过滤敏感词汇、自动登录、压缩响应信息等一些高级功能。

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。

通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：

Filter是如何实现拦截的？

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，

因此，在该方法内编写代码可达到如下目的：

•调用目标资源之前，让一段代码执行

•是否调用目标资源（即是否让用户访问web资源）。

　　　　web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，

　　调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

　　•调用目标资源之后，让一段代码执行

Filter开发流程

•编写java类实现Filter接口，并实现其doFilter方法。

 1 import java.io.IOException;
 2 import javax.servlet.Filter;
 3 import javax.servlet.FilterChain;
 4 import javax.servlet.FilterConfig;
 5 import javax.servlet.ServletException;
 6 import javax.servlet.ServletRequest;
 7 import javax.servlet.ServletResponse;
 8 
 9 //自定义Filter过渡器
10 public class FilterDemo1 implements Filter {
11     public void destroy() {
12     }
13     public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {
14         //放行请求[类似于函数调用]
15         chain.doFilter(request,response);
16     }
17     public void init(FilterConfig filterConfig) throws ServletException {
18     }
19 }

•在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app version="2.5" 
 3     xmlns="http://java.sun.com/xml/ns/javaee" 
 4     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 5     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
 6     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 7  
 8     <filter>
 9       <filter-name>FilterDemo1</filter-name>
10       <filter-class>cn.zengfansheng.web.filter.FilterDemo1</filter-class>
11   </filter>
12   <filter-mapping>
13       <filter-name>FilterDemo1</filter-name>
14       <url-pattern>/*</url-pattern>
15   </filter-mapping>
17 </web-app>

Filter链

•在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

•web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。

　　在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

Filter的生命周期

init(FilterConfig filterConfig)throws ServletException：

•和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次。示例）　

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;

public class MyFilter implements Filter {
	
	 FilterConfig filterConfig = null;
	public MyFilter(){
		System.out.println("构造函数运行了。。。。"+"  " +this.hashCode());
	}
	public void init(FilterConfig arg0) throws ServletException {
		System.out.println("init is run ,,,"+"  " +this.hashCode());
		filterConfig = this.filterConfig;
	}
	public void destroy() {
		System.out.println("destroy() is run .."+"  " +this.hashCode());
	}

	public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {
		//response.setCharacterEncoding("utf-8");
		response.setContentType("text/html;charset=utf-8");
		System.out.println("doFilter is run ..."+"  " +this.hashCode());
		//放行资源
		chain.doFilter(request, response);
	}
}

•开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。(filterConfig对象见下页PPT)

destroy()：

　　•在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

FilterConfig接口

用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。

因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：

•String getFilterName()：得到filter的名称。

•String getInitParameter(String name)：返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.

•Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。

•public ServletContext getServletContext()：返回Servlet上下文对象的引用。

import java.io.IOException;
import java.util.Enumeration;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

//单例
public class FilterDemo3 implements Filter {
	private FilterConfig filterConfig;
	public FilterDemo3(){
	}
	public void init(FilterConfig filterConfig) throws ServletException {
		this.filterConfig = filterConfig;
	}
	//Web容器调用
	public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {
		Enumeration<String> enums = filterConfig.getInitParameterNames();
		while(enums.hasMoreElements()){
			String key = enums.nextElement();
			String value = filterConfig.getInitParameter(key);
			System.out.println(key+":"+value);
		}
		String encoding = filterConfig.getInitParameter("encoding");
		response.setContentType("text/html;charset="+encoding);
		chain.doFilter(request,response);
	}
	public void destroy() {
	}
}

　　web.xml

<filter>
  	<filter-name>FilterDemo3</filter-name>
  	<filter-class>cn.itcast.web.filter.FilterDemo3</filter-class>
  	<init-param>
  		<param-name>encoding</param-name>
  		<param-value>UTF-8</param-value>
  	</init-param>
  	<init-param>
  		<param-name>email</param-name>
  		<param-value>jack@163.com</param-value>
  	</init-param>
  </filter>
  <filter-mapping>
  	<filter-name>FilterDemo3</filter-name>
  	<url-pattern>/*</url-pattern>
  </filter-mapping>
  <filter>

　　Filter常见应用

　　1、统一POST请求中文字符编码的过滤器

 1 //针对POST请求和响应的编码方式处理
 2 public class FilterDemo4 implements Filter {
 3     private FilterConfig filterConfig;
 4     public FilterDemo4(){
 5     }
 6     public void init(FilterConfig filterConfig) throws ServletException {
 7         this.filterConfig = filterConfig;
 8     }
 9     //Web容器调用
10     public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {
11         String encoding = filterConfig.getInitParameter("encoding");
12         //POST请求编码设置
13         request.setCharacterEncoding(encoding);
14         //响应编码设置
15         response.setContentType("text/html;charset="+encoding);
16         chain.doFilter(request,response);
17     }
18     public void destroy() {
19     }
20 }

 1 <filter>
 2       <filter-name>FilterDemo4</filter-name>
 3       <filter-class>cn.itcast.web.filter.FilterDemo4</filter-class>
 4       <init-param>
 5           <param-name>encoding</param-name>
 6           <param-value>UTF-8</param-value>
 7       </init-param>
 8   </filter>
 9   <filter-mapping>
10       <filter-name>FilterDemo4</filter-name>
11       <url-pattern>/*</url-pattern>
12   </filter-mapping>

　　2、禁止浏览器缓存所有动态页面的过滤器　　　

•有 3 个 HTTP 响应头字段都可以禁止浏览器缓存当前页面，它们在 Servlet 中的示例代码如下：

•response.setDateHeader("Expires",-1);

•response.setHeader("Cache-Control","no-cache");

•response.setHeader("Pragma","no-cache");

•并不是所有的浏览器都能完全支持上面的三个响应头，因此最好是同时使用上面的三个响应头。

•Expires数据头：值为GMT时间值，为-1指浏览器不要缓存页面

•Cache-Control响应头有两个常用值：

•no-cache指浏览器不要缓存当前页面。

•max-age:xxx指浏览器缓存页面xxx秒。

FilterDemo5.java

 1 //禁止浏览器缓存动态资源，例如JSP资源
 2 public class FilterDemo5 implements Filter {
 3     private FilterConfig filterConfig;
 4     public void init(FilterConfig filterConfig) throws ServletException {
 5         this.filterConfig = filterConfig;
 6     }
 7     public void doFilter(ServletRequest req, ServletResponse res,FilterChain chain) throws IOException, ServletException {
 8 
 9         //NO将父子接口强转
10         HttpServletRequest request = (HttpServletRequest) req;
11         HttpServletResponse response = (HttpServletResponse) res;
12         
13         //NO1取得客户端访问的资源的URI，形式/day19/login.jsp
14         String uri = request.getRequestURI();
15         
16         //NO2判段是否以jsp结尾，即动态资源
17         if(uri!=null && uri.endsWith("jsp")){
18             //NO3如果是动态资源，设置三个响应头通知浏览器不缓存
19             response.setHeader("expires","-1");
20             response.setHeader("cache-control","no-cache");
21             response.setHeader("pragma","no-cache");
22         }else if(uri!=null && uri.endsWith("html")){
23             //NO4如果是静态资源，缓存一定的时间
24             String strHtml = filterConfig.getInitParameter("html");
25             long time = System.currentTimeMillis()+Integer.parseInt(strHtml)*1000;
26             //time为毫秒值
27             response.setDateHeader("expires",time);//毫秒
28             response.setHeader("cache-control",time/1000+"");//秒
29             response.setHeader("pragma",time/1000+"");//秒
30         }
31         
32         //NO5放行资源
33         chain.doFilter(request,response);
34     }
35     public void destroy() {
36     }
37 }

web.xml

 1 <filter>
 2       <filter-name>FilterDemo5</filter-name>
 3       <filter-class>cn.itcast.web.filter.FilterDemo5</filter-class>
 4       <init-param>
 5           <param-name>html</param-name>
 6           <param-value>86400</param-value>
 7       </init-param>
 8   </filter>
 9   <filter-mapping>
10       <filter-name>FilterDemo5</filter-name>
11       <url-pattern>/*</url-pattern>
12   </filter-mapping>
13   <filter>