JavaWeb-Filter

过滤器概念

Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。

可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

Servlet 过滤器是可用于 Servlet 编程的 Java 类，可以实现以下目的：1、在客户端的请求访问后端资源之前，拦截这些请求。2、在服务器的响应发送回客户端之前，处理这些响应。

Filter可以改变用户请求的web资源，即改变用户请求的路径，而不能直接返回数据，即不能处理用户请求，只是起到过滤的作用而不是标准的servlet。

过滤器生命周期

通过web.xml进行实例化（单例）

初始化（init方法，一次）

过滤（doFilter方法）

销毁（destroy方法）

过滤器链

Filter的执行顺序与在web.xml配置文件中的配置顺序一致。若每个过滤器定义如下：

public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    System.out.println("start doFilter1");
    // 把请求传回过滤链
    chain.doFilter(request,response);
    System.out.println("end doFilter1");

}

则执行顺序如下：

start doFilter1
start doFilter2
do Something//servlet的doGet输出
end doFilter2
end doFilter1

 

过滤器分类

Servlet2.5有四个分类：

REQUEST，用户直接访问页面时，Web容器将会调用过滤器（默认REQUEST）

FORWARD，通过RequestDispatcher的forward访问时，调用过滤器

INCLUDE，通过RequestDispatcher的include方法是，调用过滤器

ERROR，目标资源通过声明式异常处理机制调用时，调用过滤器

Servlet3.0新增分类：

ASYNC，支持异步处理。

@WebFilter注解

基于注解的过滤器执行顺序和类名字符排序有关。

@WebFilter用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。免去在web.xml中配置。如：

@WebFilter(servletNames = {"TestFilter"},filterName = "LogFilter2",urlPatterns = "/testFilter")
public class LogFilter2 implements Filter {
    public void  init(FilterConfig config){
        System.out.println("init2...");
    }
    public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("start doFilter2");
        // 把请求传回过滤链
        chain.doFilter(request,response);
        System.out.println("end doFilter2");

    }
    public void destroy( ){
        System.out.println("destroy2...");
    }
}

 

根据规范建议的各种类型的过滤器

身份验证过滤器（AuthenticationFilters）。

数据压缩过滤器（Datacompression Filters）。

加密过滤器（EncryptionFilters）。

触发资源访问事件过滤器。

图像转换过滤器（ImageConversion Filters）。

日志记录和审核过滤器（Loggingand Auditing Filters）。

MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。

标记化过滤器（TokenizingFilters）。

XSL/T 过滤器（XSL/T Filters），转换 XML 内容。

拦截器和过滤器区别

在SpringMVC中同样可以使用过滤器。

①拦截器是基于java的反射机制的，而过滤器是基于函数回调。

②拦截器不依赖与servlet容器，过滤器依赖与servlet容器。

③拦截器只能对action请求起作用，而过滤器则可以对几乎所有的请求起作用。

④拦截器可以访问action上下文、值栈里的对象，而过滤器不能访问。

⑤在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。

⑥拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑

 

Spring的拦截器与Servlet的Filter有相似之处，比如二者都是AOP编程思想的体现，都能实现权限检查、日志记录等。不同的是：

使用范围不同：Filter是Servlet规范规定的，只能用于Web程序中。而拦截器既可以用于Web程序，也可以用于Application、Swing程序中。

规范不同：Filter是在Servlet规范中定义的，是Servlet容器支持的。而拦截器是在Spring容器内的，是Spring框架支持的。

使用的资源不同：同其他的代码块一样，拦截器也是一个Spring的组件，归Spring管理，配置在Spring文件中，因此能使用Spring里的任何资源、对象，例如Service对象、数据源、事务管理等，通过IoC注入到拦截器即可；而Filter则不能。

深度不同：Filter在只在Servlet前后起作用。而拦截器能够深入到方法前后、异常抛出前后等，因此拦截器的使用具有更大的弹性。所以在Spring构架的程序中，要优先使用拦截器。

栗子

web.xml

<filter>
    <filter-name>LogFilter</filter-name>
    <filter-class>com.seu.sun.LogFilter</filter-class>
    <init-param>
        <param-name>initParams</param-name>
        <param-value>Value</param-value>
    </init-param>
</filter>
<filter-mapping> //可配置多个映射到该filter
    <filter-name>LogFilter</filter-name>
    <url-pattern>/testFilter</url-pattern>
    <servlet-name>TestFilter</servlet-name>
    <!--<dispatcher>可以是0对或多对，值为REQUEST,INCLUDE,FORWARD,ERROR，默认REQUEST-->
</filter-mapping>


<servlet>
    <servlet-name>TestFilter</servlet-name>
    <servlet-class>com.seu.sun.TestFilter</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>TestFilter</servlet-name>
    <url-pattern>/testFilter</url-pattern>
</servlet-mapping>

过滤器通过 Web 部署描述符（web.xml）中的 XML 标签来声明，然后映射到应用程序的部署描述符中的 Servlet 名称或 URL 模式。当 Web 容器启动 Web 应用程序时，它会为部署描述符中声明的每一个过滤器创建一个实例。Filter的执行顺序与在web.xml配置文件中的配置顺序一致，一般把Filter配置在所有的Servlet之前。

TestFilter.java

public class TestFilter extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
    {
        System.out.println("do Something");
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response){
        doGet(request, response);
    }
}

这里只简单输出到控制台。

LogFilter.java

public class LogFilter implements Filter  {
    public void  init(FilterConfig config){
        // 获取初始化参数
        String param = config.getInitParameter("initParams");
        System.out.println("init1..."+param);
    }
    public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("start doFilter1");
        // 把请求传回过滤链
        chain.doFilter(request,response);
        System.out.println("end doFilter1");

    }
    public void destroy( ){
        //在 Filter 实例被 Web 容器从服务移除之前调用
        System.out.println("destroy1...");
    }
}

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter接口定义了三个方法：

publicvoid doFilter (ServletRequest, ServletResponse, FilterChain)

该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器，或利用转发、重定向将请求转发到其他资源。

publicvoid init(FilterConfig filterConfig)

web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

publicvoid destroy()

Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

输出（去掉其他一些日志输出）：

init2...
init1...Value 
start doFilter1 
start doFilter2
do Something
end doFilter2 
end doFilter1
destroy2...
destroy1...