Servlet过滤器的概念及一个实例

 

Servlet过滤器

一、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过滤器的特点：
◆Servlet过滤器可以检查和修改ServletRequest和ServletResponse对象
◆Servlet过滤器可以被指定和特定的URL关联，只有当客户请求访问该URL时，才会触发过滤器
◆Servlet过滤器可以被串联在一起，形成管道效应，协同修改请求和响应对象

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

四、Servlet过滤器的适用场合：
◆认证过滤
◆登录和审核过滤
◆图像转换过滤
◆数据压缩过滤
◆加密过滤
◆令牌过滤
◆资源访问触发事件过滤
◆XSL/T过滤
◆Mime-type过滤

五、Servlet过滤器接口的构成：
所有的Servlet过滤器类都必须实现javax.servlet.Filter接口。这个接口含有3个过滤器类必须实现的方法：
◆init(FilterConfig)：
这是Servlet过滤器的初始化方法，Servlet容器创建Servlet过滤器实例后将调用这个方法。在这个方法中可以读取web.xml文件中Servlet过滤器的初始化参数
◆doFilter(ServletRequest,ServletResponse,FilterChain)：
这个方法完成实际的过滤操作，当客户请求访问于过滤器关联的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain参数用于访问后续过滤器
◆destroy()：
Servlet容器在销毁过滤器实例前调用该方法，这个方法中可以释放Servlet过滤器占用的资源

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

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

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

九、Servlet过滤器的发布：
◆发布Servlet过滤器时，必须在web.xml文件中加入﹤filter﹥元素和﹤filter-mapping﹥元素。
◆filter元素用来定义一个过滤器：

filter-name 指定过滤器的名字

filter-class    指定过滤器的类名

init-param    为过滤器实例提供初始化参数，可以有多个

◆filter-mapping元素用于将过滤器和URL关联：

十一、Servlet过滤器使用的注意事项

◆由于Filter、FilterConfig、FilterChain都是位于javax.servlet包下，并非HTTP包所特有的，所以其中所用到的请求、响应对象ServletRequest、ServletResponse在使用前都必须先转换成HttpServletRequest、HttpServletResponse再进行下一步操作

 

十二、利用Servlet过滤器实现字符集处理

过滤器编写完成之后，要在Web工程的web.xml进行配置，格式如下：

<filter>
    <filter-name>过滤器名称</filter-name>
    <filter-class>过滤器对应的类</filter-class>
    <!--初始化参数-->
    <init-param>
        <param-name>参数名称1</param-name>
        <param-value>参数值1</param-value>
    </init-param>
    <init-param>
       <param-name>参数名称2</param-name>
       <param-value>参数值2</param-value>
    </init-param>
 </filter>

过滤器必须要与特定的URL关联才能发挥作用。过滤器的关联方式有三种：与一个URL关联、与一个URL目录下的所有资源关联、与一个Servlet关联。
(1)与一个URL关联
<filter-mapping>
    <filter-name>过滤器名称</filter-name>
    <url-pattern>xxx.jsp</url-pattern>
</filter-mapping>
(2)与一个URL目录下的所有资源关联
<filter-mapping>
    <filter-name>过滤器名称</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
(3)与一个Servlet关联
<filter-mapping>
    <filter-name>过滤器名称</filter-name>
    <url-pattern>Servlet名称</url-pattern>
</filter-mapping>

过滤器可以完成以下功能：(1)权限控制(2)字符集处理(3)其他如日志、用户使用分析等。

以下是一个完成字符集转换的过滤器实例。
首先完成过滤器代码，在init方法中读取配置参数，在doFilter中完成字符集的转换。

package myproj.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 SetCharacterEncodingFilter implements Filter{
    //定义替换后的字符集，从过滤器的配置参数中读取
    String newCharSet;
    public void destroy(){
    }
    public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException 
    {
        //处理请求字符集
        request.setCharacterEncoding(newCharSet);
        
        //传递给下一个过滤器。这里没有下一个，作为过滤器的规则和良好的编程习惯，应该加上
        chain.doFilter(request,response);

        //处理响应字符集
        response.setContentType("text/html;charset="+newCharSet);
    }
    
    public void init(FilterConfig filterConfig)hrows ServletException 
    {
        //从过滤器的配置中获得初始化参数，如果没有就使用默认值
        if(filterConfig.getInitParamter("newcharset")!=null)
        {
            newCharSet = filterConfig.getInitParamter("newcharset");
        }
        else
            newCharSet = "GB2312";
    }
}

然后在web.xml文件中配置过滤器
<!--过滤器配置-->
<filter>
    <filter-name>Encoder</filter-name>
    <filter-class>myproj.filter.SetCharacterEncodingFilter</filter-class>
    <!--初始化参数-->
    <init-param>
         <param-name>newcharset</param-name>
         <param-value>gb2312</param-value>
    </init-param>
</filter>

<!--过滤器与URL关联-->
<filter-mapping>
    <filter-name>Encoder</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>