Servlet过滤器

来源：互联网发布：jpg看图软件编辑：程序博客网时间：2024/05/06 23:08

一、Servlet过滤器的概念：
***************************************************************************************
Servlet过滤器是在Java Servlet规范2.3中定义的，它能够对Servlet容器的请求和响应对象进行检查和修改。　　　

Servlet过滤器本身并不产生请求和响应对象，它只能提供过滤作用。Servlet过期能够在Servlet被调用之前检查Request对象，修改Request Header和Request内容；在Servlet被调用之后检查Response对象，修改Response Header和Response内容。

Servlet过期负责过滤的Web组件可以是Servlet、JSP或者HTML文件。　
***************************************************************************************

二、Servlet过滤器的特点：
***************************************************************************************
A．Servlet过滤器可以检查和修改ServletRequest和ServletResponse对象
B．Servlet过滤器可以被指定和特定的URL关联，只有当客户请求访问该URL时，才会触发过滤器
C．Servlet过滤器可以被串联在一起，形成管道效应，协同修改请求和响应对象
***************************************************************************************

三、Servlet过滤器的作用：
***************************************************************************************
A．查询请求并作出相应的行动。
B．阻塞请求-响应对，使其不能进一步传递。
C．修改请求的头部和数据。用户可以提供自定义的请求。
D．修改响应的头部和数据。用户可以通过提供定制的响应版本实现。
E．与外部资源进行交互。
***************************************************************************************

四、Servlet过滤器的适用场合：
***************************************************************************************
A．认证过滤
B．登录和审核过滤
C．图像转换过滤
D．数据压缩过滤
E．加密过滤
F．令牌过滤
G．资源访问触发事件过滤
H．XSL/T过滤
I．Mime-type过滤
***************************************************************************************

五、Servlet过滤器接口的构成：
***************************************************************************************
所有的Servlet过滤器类都必须实现javax.servlet.Filter接口。这个接口含有3个过滤器类必须实现的方法：

A.init(FilterConfig)：
这是Servlet过滤器的初始化方法，Servlet容器创建Servlet过滤器实例后将调用这个方法。在这个方法中可以读取web.xml文件中Servlet过滤器的初始化参数

B.doFilter(ServletRequest,ServletResponse,FilterChain)：
这个方法完成实际的过滤操作，当客户请求访问于过滤器关联的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain参数用于访问后续过滤器

B.destroy()：
Servlet容器在销毁过滤器实例前调用该方法，这个方法中可以释放Servlet过滤器占用的资源
***************************************************************************************

六、Servlet过滤器的创建步骤：
***************************************************************************************
A．实现javax.servlet.Filter接口
B．实现init方法，读取过滤器的初始化函数
C．实现doFilter方法，完成对请求或过滤的响应
D．调用FilterChain接口对象的doFilter方法，向后续的过滤器传递请求或响应
E．销毁过滤器
***************************************************************************************

七、Servlet过滤器对请求的过滤：
***************************************************************************************
A．Servlet容器创建一个过滤器实例
B．过滤器实例调用init方法，读取过滤器的初始化参数
C．过滤器实例调用doFilter方法，根据初始化参数的值判断该请求是否合法
D．如果该请求不合法则阻塞该请求
E．如果该请求合法则调用chain.doFilter方法将该请求向后续传递
***************************************************************************************

八、Servlet过滤器对响应的过滤：
***************************************************************************************
A．过滤器截获客户端的请求
B．重新封装ServletResponse，在封装后的ServletResponse中提供用户自定义的输出流
C．将请求向后续传递
D．Web组件产生响应
E．从封装后的ServletResponse中获取用户自定义的输出流
F．将响应内容通过用户自定义的输出流写入到缓冲流中
G．在缓冲流中修改响应的内容后清空缓冲流，输出响应内容
***************************************************************************************

九、Servlet过滤器的发布：
***************************************************************************************
A．发布Servlet过滤器时，必须在web.xml文件中加入<filter>元素和<filter-mapping>元素。

B．<filter>元素用来定义一个过滤器：
属性                   含义
filter-name    指定过滤器的名字
filter-class    指定过滤器的类名
init-param    为过滤器实例提供初始化参数，可以有多个

C．<filter-mapping>元素用于将过滤器和URL关联：
属性                     含义
filter-name    指定过滤器的名字
url-pattern    指定和过滤器关联的URL，为”/*”表示所有URL
***************************************************************************************

十一、Servlet过滤器使用的注意事项
***************************************************************************************
A．由于Filter、FilterConfig、FilterChain都是位于javax.servlet包下，并非HTTP包所特有的，所以其中所用到的请求、响应对象ServletRequest、ServletResponse在使用前都必须先转换成HttpServletRequest、HttpServletResponse再进行下一步操作。

B．在web.xml中配置Servlet和Servlet过滤器，应该先声明过滤器元素，再声明Servlet元素

C．如果要在Servlet中观察过滤器生成的日志，应该确保在server.xml的localhost对应的<host>元素中配置如下<logger>元素：
<Logger className = “org.apache.catalina.logger.FileLogger”
directory = “logs”prefix = “localhost_log.”suffix=”.txt”
timestamp = “true”/>
***************************************************************************************

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

Servlet过滤器是一种小型的、可插入的Web组件，其提供了对Web应用程序的前期处理和后期处理的逻辑控制，可以拦截请求和响应，以便查看、提取或以某种方式操作正在客户端和服务器之间进行交换的数据。Servlet过滤器具有动态、灵活、透明、模块化、可移植、可重用等性质，是一种自包含的，模块化的组件，可以在使用时将其添加到请求/响应链中，也可以被删除而不影响到应用程序的其他Web组件。Servlet过滤器应用非常广泛，有拦截的地方一般都可以用到过滤器，其也和Servlet类似，也需要在Web应用配置文件（即Web.xml）中进行配置部署。

过滤器并不是servlet，他们并不实际创建一个请求。他们是请求到达一个servlet前的预处理程序，和/或响应离开servlet后的后处理程序。一个过滤器能够：
1．在一个servlet被调用前截获该调用
2．在一个servlet被调用前检查请求
3．修改在实际请求中提供了可定制请求对象的请求头和请求数据
4．修改在实际响应中提供了可定制响应对象的响应头和响应数据
过滤器类必须要实现Filter接口，这个接口在javax.servlet包中。该接口有三个方法如下：
1．void init(FilterConfig config) throws ServletException：在过滤器执行service前被调用，以设置过滤器的配置对象。服务器调用一次init(FilterConfig)以为服务准备过滤器，然后在请求需要使用过滤器的任何时候调用doFilter()。FilterConfig接口检索过滤器名、初始化参数以及活动的servlet上下文。
2．void doFilter(ServletRequest req,ServletResponse res,FilterChain chain) throws IOException,ServletException;执行实际的过滤工作。在doFilter()方法中，每个过滤器都接受当前的请求和响应，而FilterChain包含的过滤器则仍然必须被处理。doFilter()方法中，过滤器可以对请求和响应做它想做的一切。过滤器调用chain.doFilter()将控制权传送给下一个过滤器。当这个调用返回后，过滤器可以在它的doFilter()方法的最后对响应做些其他的工作；例如，它能记录响应的信息。如果过滤器想要终止请求的处理或或得对响应的完全控制，则他可以不调用下一个过滤器。
3．void destroy();在过滤器执行service后被调用。服务器调用destory()以指出过滤器已结束服务。

下面是一个很经典的例子，记录请求所持续的时间。

import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
public class TimerFilter implements Filter
...{
    private FilterConfig config = null;
    public void init(FilterConfig config) throws ServletException    //初始化
    ...{
        this.config = config;
    }
    public void doFilter(ServletRequest request,ServletResponse response,FilterChain chain) throws IOException, ServletException
    ...{
        long before = System.currentTimeMillis();    //请求处理前获取系统时间
        chain.doFilter(request, response);    //将请求转发到过滤器链上的其他对象
        long after = System.currentTimeMillis();    //请求处理后获取系统时间
        String name = "";
        if (request instanceof HttpServletRequest)
        ...{
            name = ((HttpServletRequest)request).getRequestURI();    //获取发出请求的URI
        }
        config.getServletContext().log(name + ": " + (after - before) + "ms");    //记录信息
    }
    public void destroy()    //结束服务
    ...{
        config = null;
    }
}

前面说过，过滤器要在Web.xml文件中部署，部署跟Servlet部署非常相似，就是把Servlet部署中的标签中servlet改为filter就可以了。

<filter>
    <filter-name>timerFilter</filter-name>
    <filter-class>TimerFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>timerFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>