Servlet Filter 过滤器的详细解析

Filter简介

Filter 技术是 servlet 2.3 新增的功能。 Filter主要是为了拦截用户的请求和服务器的响应，从而实现了一些特殊的功能。

Filter工作原理

Filter直接拦截用户的请求和服务器的响应（自身不产生请求额响应），然后经过Filter程序的判断和操作，做出最后的处理。

Filter程序的编写

• Servlet API 中定义了三个接口类来供开发人员编写 Filter 程序 Filter ， FilterChain， FilterConfig。
• Filter接口并没有相应的实现类可供继承，要开发过滤器，只能直接实现Filter接口。给借口定义了init（），doFilter（）和destory（）三个方法。
• Filter程序同servlet一样，需要在web.xml文件中进行注册和设置拦截目标。拦截目标可以使web服务器管理的所有web资源：Jsp，Servlet，静态图片或静态html文件等。

方法详解

init(FilterConfig arg0) throwsServletException

• web应用启动时，web服务器根据web.xml文件，创建所有注册的Filter实例对象，并保存在服务器中，同时调用该Filter对象的init方法
• init方法在Filter生命周期中只执行一次。
• FilterConfig的作用：包含着过滤器的配置和运行环境，获得ServletContext对象，以及web.xml中配置的过滤器的初始化参数

destroy()

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

doFilter(ServletRequest request, ServletResponse response,FilterChain chain)

                 throwsIOException, ServletException

•  当客户端请求目标资源的时候，容器就会调用与这个目标资源相关联的过滤器的doFilter方法。
•  Request，response为web容器或者Filter链上的上一个Filter传递过来的请求和响应对象；
•  类型是ServletRequest和ServletResponse，因此过滤器的使用不依赖于具体的协议。
•  Chain为代表当前Filter链的对象。
•  chain.doFilter(request,response)把请求交付给Filter链中的下一个Filter或者Servlet程序去处理，也可以直接向客户端返回响应信息，或者重定向，跳转将请求转向其他资源。

FilterChain对象

•  同一个web项目中,可以含有多个Filter程序,同时每个Filter程序都可以拦截一个或一组Servlet程序
•  多个Filter程序可以拦截同一个目标,当目标出现时,web容器将把多个Filter程序组合成为一个Filter链(过滤器链).Filter链中各个Filter的拦截顺序与他们在应用程序的web.xml中映射的顺序一致.

FilterChain接口

由容器实现将其实例作为当前Filter链的对象.Filter链对象作为参数传入过滤器对象的doFilter()方法中.过滤器对象使用FilterChain对象调用过滤器链中的下一个过滤器,如果该过滤器是链中最后一个过滤器,那么将调用目标资源

FilterConfig接口

Web.xml中配置filter是.<init-param>为filter配置一些初始化参数.这些参数封装在filterConfig对象中.

FilterConfig对象的方法:

• getFilterName():得到filter的名称.
• getInitParameter(String name): 返回web.xml中初始化参数为name的参值.如果不存在返回null.
• getInitParameterNames():返回过滤器中所有参数的名字的枚举集合.
• getServletContext(): 返回servlet上下文对象的引用.

Filter的web.xml配置

• <filter-name>：设置filter的名字
• <filter-class>：设置filter对应的filter类
• <init-param>：可选。设置初始化参数。可以设置多个参数。
•      <param-name>：设置参数名
•     <param-value>：设置参数值
• <url-pattren>：设置path。当访问http://localhost:8080/应用名/path时，将被filter拦截。
• <servlet-name>：设置过滤器要拦截的servlet的名称
• <dispatcher>：设置对某种调用方式的资源进行拦截，默认 REQUEST 。可以设置多个<dispatcher>子元素用来指定Filter对资源的多种调用方式进行拦截。
• REQUEST : 仅当直接访问页面时,web容器将会调用过滤器.
• INCLUDE : 仅当通过RequestDispatchar的include() 方法访问目标资源时,该过滤器被调用.
• FORWARD : 仅当RequestDispatcher 的forward() 方法访问目标资源时,该过滤器被调用.
• ERROR : 仅当通过声明式异常处理机制调用目标资源时,该过滤器被调用.

Filter的常见应用:

• 统一全站字符编码的过滤器
• 控制浏览器缓存界面中的静态资源
• 使用 Filter 实现URL级别的权限认证
• 禁止浏览器缓存所有的动态页面
• 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秒
• 不是所有的浏览器都能完全支持上面的三个响应头,因此最好同时使用上面的三个响应头.

例子:

过滤器程序(主要是为了实现检查登录状态)

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;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class LoginFilter implements Filter{

	public void destroy() {
		System.out.println("Filter的销毁操作");
	}

	public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
			throws IOException, ServletException {
		System.out.println("Filter的执行操作");
		HttpServletRequest request1 = (HttpServletRequest) arg0;
		HttpServletResponse response = (HttpServletResponse) arg1;
		String LoginUser = (String) request1.getSession().getAttribute("userName");
		if(LoginUser==null){
			response.setContentType("text/html;charset=UTF-8");
			response.getWriter().print("登录超时，或者你还未登录！请重新登录。");
			response.setHeader("refresh", "2;url=login.jsp");
		}else{
			arg2.doFilter(arg0, arg1);//释放请求  chain。doFilter（request，response）
		}
	}

	public void init(FilterConfig arg0) throws ServletException {
		System.out.println("Filter的初始化操作");
	}
	
}

web.xml 配置(将Filter注册到程序中)

<?xml version="1.0" encoding="UTF-8"?>
<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_2_5.xsd" id="WebApp_ID" version="2.5">
  <display-name>UserManager</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <filter>
  <filter-name>LoginFilter</filter-name>
  <filter-class>filter.LoginFilter</filter-class>
  </filter>
  <filter-mapping>
  <filter-name>LoginFilter</filter-name>
  <url-pattern>/index.jsp</url-pattern>
  <url-pattern>/deleteUser。html</url-pattern>
  <url-pattern>/updateUser.jsp</url-pattern>
  <url-pattern>/AddUser.html</url-pattern>
  
  <dispatcher>FORWARD</dispatcher><!-- 设置响应的方式为 forward 转发 也要进行拦截 -->
  <dispatcher>REQUEST</dispatcher><!-- 默认的请求类型 -->
  </filter-mapping>
</web-app>