Filter的执行顺序及实例

学习中的收藏，该文出自http://www.cnblogs.com/Fskjb/archive/2010/03/27/1698448.html

　　在此，非常感谢该文章作者的分享，本文完全转载自上面链接，此处作为备份，方便查看使用。

Filter介绍

Filter可认为是Servlet的一种“变种”，它主要用于对用户请求进行预处理，也可以对HttpServletResponse进行后处理，是个典型的处理链。它与Servlet的区别在于：它不能直接向用户生成响应。完整的流程是：Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对服务器响应进行后处理。

Filter有如下几个用处。

• 在HttpServletRequest到达Servlet之前，拦截客户的HttpServletRequest。
• 根据需要检查HttpServletRequest，也可以修改HttpServletRequest头和数据。
• 在HttpServletResponse到达客户端之前，拦截HttpServletResponse。
• 根据需要检查HttpServletResponse，也可以修改HttpServletResponse头和数据。

Filter有如下几个种类。

• 用户授权的Filter：Filter负责检查用户请求，根据请求过滤用户非法请求。
• 日志Filter：详细记录某些特殊的用户请求。
• 负责解码的Filter：包括对非标准编码的请求解码。
• 能改变XML内容的XSLT Filter等。
• Filter可负责拦截多个请求或响应；一个请求或响应也可被多个请求拦截。

创建一个Filter只需两个步骤：

• 建Filter处理类；
• web.xml文件中配置Filter。

下面先介绍一个简单的记录日志的Filter，这个Filter负责拦截所有的用户请求，并将请求的信息记录在日志中。

 
代码
 
public class LogFilter implements Filter 
{
//FilterConfig可用于访问Filter的配置信息
private FilterConfig config;
//实现初始化方法
public void init(FilterConfig config)
{
this.config = config; 
}
//实现销毁方法
public void destroy()
{
this.config = null; 
}
//执行过滤的核心方法
public void doFilter(ServletRequest request,ServletResponse response, FilterChain chain)throws IOException,ServletException
{
//---------下面代码用于对用户请求执行预处理---------
//获取ServletContext对象，用于记录日志
ServletContext context = this.config.getServletContext(); 
long before = System.currentTimeMillis();
System.out.println("开始过滤...");
//将请求转换成HttpServletRequest请求
HttpServletRequest hrequest = (HttpServletRequest)request;
//记录日志
context.log("Filter已经截获到用户的请求地址： " + hrequest.getServletPath());
//Filter只是链式处理，请求依然放行到目的地址
chain.doFilter(request, response); 
//---------下面代码用于对服务器响应执行后处理---------
long after = System.currentTimeMillis();
//记录日志
context.log("过滤结束");
//再次记录日志
context.log("请求被定位到" + hrequest.getRequestURI() + "所花的时间为: " + (after - before)); 
}
}

上面程序实现了doFilter()方法，实现该方法就可实现对用户请求进行预处理，也可实现对服务器响应进行后处理——它们的分界线为是否调用了chain.doFilter()，执行该方法之前，即对用户请求进行预处理；执行该方法之后，即对服务器响应进行后处理。

在上面的请求Filter中，仅在日志中记录请求的URL，对所有的请求都执行chain.doFilter (request,reponse)方法，当Filter对请求过滤后，依然将请求发送到目的地址。如果需要检查权限，可以在Filter中根据用户请求的HttpSession，判断用户权限是否足够。如果权限不够，直接调用重定向即可，无须调用chain.doFilter(request,reponse)方法。

代码

==================

FirstFilter.java   
==================   
package com.test.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;   
  
public class FirstFilter implements Filter {   
  
    @Override  
    public void destroy() {   
  
    }   
  
    @Override  
    public void doFilter(ServletRequest request, ServletResponse response,   
            FilterChain chain) throws IOException, ServletException {   
        System.out.println("before invoke firstFilter's chain.doFilter() ..");   
        chain.doFilter(request, response);   
        System.out.println("after invoke firstFilter's chain.doFilter() ..");   
    }   
  
    @Override  
    public void init(FilterConfig arg0) throws ServletException {   
        System.out.println("firstFilter init()..."); 

    } 

}     
  
============   
SecondFilter.java   
=============  
  
package com.test.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;   
  
public class SecondFilter implements Filter {   
  
    @Override  
    public void destroy() {   
  
    }   
  
    @Override  
    public void doFilter(ServletRequest request, ServletResponse response,   
            FilterChain chain) throws IOException, ServletException {   
        System.out.println("before invoke secondFilter's chain.doFilter() ..");   
        chain.doFilter(request, response);   
        System.out.println("after invoke secondFilter's chain.doFilter() ..");   
    }   
  
    @Override  
    public void init(FilterConfig filterConfig) throws ServletException {   
        System.out.println("secondFilter init()...");   
    }

}   
==========  
FirstServlet.java   
==========  
package com.test.servlet;   
  
import java.io.IOException;   
  
import javax.servlet.ServletException;   
import javax.servlet.http.HttpServlet;   
import javax.servlet.http.HttpServletRequest;   
import javax.servlet.http.HttpServletResponse;   
  
public class FirstServlet extends HttpServlet {   
  
    @Override  
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)   
            throws ServletException, IOException {   
        System.out.println("servlet doGet be invoked...");   
        req.getRequestDispatcher("test.jsp").forward(req, resp);   
    }   
  
    @Override  
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)   
            throws ServletException, IOException {   
        // TODO Auto-generated method stub   
        doGet(req, resp);   
    } 

} 

web.xml

 
代码
 
  
<?xml version="1.0" encoding="UTF-8"?>   
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee    
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">   
    <welcome-file-list>   
        <welcome-file>index.jsp</welcome-file>   
    </welcome-file-list>   
    <filter>   
        <filter-name>firstFilter</filter-name>   
        <filter-class>com.test.filter.FirstFilter</filter-class>   
    </filter>   
    <filter>   
        <filter-name>secondFilter</filter-name>   
        <filter-class>com.test.filter.SecondFilter</filter-class>   
    </filter>   
    <filter-mapping>   
        <filter-name>secondFilter</filter-name>   
        <url-pattern>/*</url-pattern>   
    </filter-mapping>   
    <filter-mapping>   
        <filter-name>firstFilter</filter-name>   
        <url-pattern>/*</url-pattern>   
    </filter-mapping>   
  
    <servlet>   
        <servlet-name>firstServlet</servlet-name>   
        <servlet-class>com.alimama.servlet.FirstServlet</servlet-class>   
    </servlet>   
    <servlet-mapping>   
        <servlet-name>firstServlet</servlet-name>   
        <url-pattern>/firstServlet</url-pattern>   
    </servlet-mapping>   
</web-app>   

然后发布，发现打印的日志如下：

。。。

firstFilter init()...
secondFilter init()...

。。。
信息: Server startup in 3665 ms

这里过滤器初始化好了。

当我们访问我们的 应用：http://127.0.0.1:8080/appName

发现打印日记如下：

before invoke secondFilter's chain.doFilter() ..
before invoke firstFilter's chain.doFilter() ..
after invoke firstFilter's chain.doFilter() ..
after invoke secondFilter's chain.doFilter() ..

当我们将web.xml中filter的位置进行调整后（注意filter-mapping的顺序）：

 
代码
 
<?xml version="1.0" encoding="UTF-8"?>  
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee    
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">  
    <welcome-file-list>  
        <welcome-file>index.jsp</welcome-file>  
    </welcome-file-list>  
    <filter>  
        <filter-name>firstFilter</filter-name>  
        <filter-class>com.test.filter.FirstFilter</filter-class>  
    </filter>  
    <filter>  
        <filter-name>secondFilter</filter-name>  
        <filter-class>com.test.filter.SecondFilter</filter-class>  
    </filter>  
            <SPAN style="COLOR: #ff0000"> <filter-mapping>  
        <filter-name>firstFilter</filter-name>  
        <url-pattern>/*</url-pattern>  
    </filter-mapping>  
  
    <filter-mapping>  
        <filter-name>secondFilter</filter-name>  
        <url-pattern>/*</url-pattern>  
    </filter-mapping></SPAN>  
       
    <servlet>  
        <servlet-name>firstServlet</servlet-name>  
        <servlet-class>com.alimama.servlet.FirstServlet</servlet-class>  
    </servlet>  
    <servlet-mapping>  
        <servlet-name>firstServlet</servlet-name>  
        <url-pattern>/firstServlet</url-pattern>  
    </servlet-mapping>  
</web-app>  

然后在启动应用，会看到打印：

before invoke firstFilter's chain.doFilter() ..

before invoke secondFilter's chain.doFilter() ..
after invoke secondFilter's chain.doFilter() ..

after invoke firstFilter's chain.doFilter() ..

下面是一个实例：

 
public class AuthorityFilter implements Filter 
{
//FilterConfig可用于访问Filter的配置信息private FilterConfig config;
//实现初始化方法
public void init(FilterConfig config)
{
  this.config = config;
}
//实现销毁方法
public void destroy()
{
this.config = null;
}
//执行过滤的核心方法
public void doFilter(ServletRequest request,ServletResponse response, FilterChain chain)throws IOException,ServletException{
//获取该Filter的配置参数
String encoding = config.getInitParameter("encoding");
String loginPage = config.getInitParameter("loginPage");
String proLogin = config.getInitParameter("proLogin");
//设置request编码用的字符集
request.setCharacterEncoding(encoding); //①
HttpServletRequest requ = (HttpServletRequest)request;
HttpSession session = requ.getSession(true);
//获取客户请求的页面
String requestPath = requ.getServletPath();
//如果session范围的user为null，即表明没有登录
//且用户请求的既不是登录页面，也不是处理登录的页面
if( session.getAttribute("user") == null&& !requestPath.endsWith(loginPage)&& !requestPath.endsWith(proLogin)){
//forward到登录页面
request.setAttribute("tip" , "您还没有登录");
request.getRequestDispatcher(loginPage).forward(request, response);
}
//“放行”请求
else{
chain.doFilter(request, response);
}
}
}

上面Filter的doFilter方法里3行斜体字代码用于获取Filter的配置参数，而程序中粗体字代码则是此Filter的核心，①号代码按配置参数设置了request编码所用的字符集，接下来的粗体字代码判断session范围内是否有user属性——没有该属性即认为没有登录，如果既没有登录，而且请求地址也不是登录页和处理登录页，系统直接跳转到登录页面。

在web.xml文件中配置该Filter，使用init-param元素为该Filter配置参数，init-param可接受如下两个子元素：

param-name：指定参数名。

param-value：指定参数值。

该Filter的配置片段如下：

<!-- 定义Filter -->
<filter>
<!-- Filter的名字 -->
<filter-name>authority</filter-name>
<!-- Filter的实现类 -->
<filter-class>lee.AuthorityFilter</filter-class>
<!-- 下面3个init-param元素配置了3个参数 -->
<init-param>
<param-name>encoding</param-name>
<param-value>GBK</param-value>
</init-param>
<init-param>
<param-name>loginPage</param-name>
<param-value>/login.jsp</param-value>
</init-param>
<init-param>
<param-name>proLogin</param-name>
<param-value>/proLogin.jsp</param-value>
</init-param>
</filter>
<!-- 定义Filter拦截的URL地址 -->
<filter-mapping>
<!-- Filter的名字 -->
<filter-name>authority</filter-name>
<!-- Filter负责拦截的URL -->
<url-pattern>/*</url-pattern>
</filter-mapping>
 
<!-- 定义Filter -->
<filter>
<!-- Filter的名字 -->
<filter-name>authority</filter-name>
<!-- Filter的实现类 -->
<filter-class>lee.AuthorityFilter</filter-class>
<!-- 下面3个init-param元素配置了3个参数 -->
<init-param>
<param-name>encoding</param-name>
<param-value>GBK</param-value>
</init-param>
<init-param>
<param-name>loginPage</param-name>
<param-value>/login.jsp</param-value>
</init-param>
<init-param>
<param-name>proLogin</param-name>
<param-value>/proLogin.jsp</param-value>
</init-param>
</filter>
<!-- 定义Filter拦截的URL地址 -->
<filter-mapping>
<!-- Filter的名字 -->
<filter-name>authority</filter-name>
<!-- Filter负责拦截的URL -->
<url-pattern>/*</url-pattern>
</filter-mapping>

上面配置片段中粗体字代码为该Filter指定了3个配置参数，指定loginPage为/login.jsp，proLogin为/proLogin.jsp，这表明：如果没有登录该应用，普通用户只能访问/login.jsp和/proLogin.jsp页面。只有当用户登录该应用后才可自由访问其他页面。

实际上Filter和Servlet极其相似，区别只是Filter不能直接对用户生成响应。实际上Filter里doFilter()方法里的代码就是从多个Servlet的service()方法里抽取的通用代码，通过使用Filter可以实现更好的复用。